Class Account
Manages an Azure Storage Account.
Example Usage
using Pulumi;
using Azure = Pulumi.Azure;
class MyStack : Stack
{
public MyStack()
{
var exampleResourceGroup = new Azure.Core.ResourceGroup("exampleResourceGroup", new Azure.Core.ResourceGroupArgs
{
Location = "West Europe",
});
var exampleAccount = new Azure.Storage.Account("exampleAccount", new Azure.Storage.AccountArgs
{
ResourceGroupName = exampleResourceGroup.Name,
Location = exampleResourceGroup.Location,
AccountTier = "Standard",
AccountReplicationType = "GRS",
Tags =
{
{ "environment", "staging" },
},
});
}
}
Inherited Members
Namespace: Pulumi.Azure.Storage
Assembly: Pulumi.Azure.dll
Syntax
public class Account : CustomResource
Constructors
View SourceAccount(String, AccountArgs, CustomResourceOptions)
Create a Account resource with the given unique name, arguments, and options.
Declaration
public Account(string name, AccountArgs args, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resource |
| AccountArgs | args | The arguments used to populate this resource's properties |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Properties
View SourceAccessTier
Defines the access tier for BlobStorage, FileStorage and StorageV2 accounts. Valid options are Hot and Cool, defaults to Hot.
Declaration
public Output<string> AccessTier { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
AccountKind
Defines the Kind of account. Valid options are BlobStorage, BlockBlobStorage, FileStorage, Storage and StorageV2. Changing this forces a new resource to be created. Defaults to StorageV2.
Declaration
public Output<string> AccountKind { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
AccountReplicationType
Defines the type of replication to use for this storage account. Valid options are LRS, GRS, RAGRS, ZRS, GZRS and RAGZRS.
Declaration
public Output<string> AccountReplicationType { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
AccountTier
Defines the Tier to use for this storage account. Valid options are Standard and Premium. For BlockBlobStorage and FileStorage accounts only Premium is valid. Changing this forces a new resource to be created.
Declaration
public Output<string> AccountTier { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
BlobProperties
A blob_properties block as defined below.
Declaration
public Output<AccountBlobProperties> BlobProperties { get; }
Property Value
| Type | Description |
|---|---|
| Output<AccountBlobProperties> |
CustomDomain
A custom_domain block as documented below.
Declaration
public Output<AccountCustomDomain> CustomDomain { get; }
Property Value
| Type | Description |
|---|---|
| Output<AccountCustomDomain> |
EnableHttpsTrafficOnly
Boolean flag which forces HTTPS if enabled, see here
for more information. Defaults to true.
Declaration
public Output<bool?> EnableHttpsTrafficOnly { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Boolean>> |
Identity
A identity block as defined below.
Declaration
public Output<AccountIdentity> Identity { get; }
Property Value
| Type | Description |
|---|---|
| Output<AccountIdentity> |
IsHnsEnabled
Is Hierarchical Namespace enabled? This can be used with Azure Data Lake Storage Gen 2 (see here for more information). Changing this forces a new resource to be created.
Declaration
public Output<bool?> IsHnsEnabled { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Nullable<System.Boolean>> |
Location
Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.
Declaration
public Output<string> Location { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
Name
Specifies the name of the storage account. Changing this forces a new resource to be created. This must be unique across the entire Azure service, not just within the resource group.
Declaration
public Output<string> Name { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
NetworkRules
A network_rules block as documented below.
Declaration
public Output<AccountNetworkRules> NetworkRules { get; }
Property Value
| Type | Description |
|---|---|
| Output<AccountNetworkRules> |
PrimaryAccessKey
The primary access key for the storage account.
Declaration
public Output<string> PrimaryAccessKey { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
PrimaryBlobConnectionString
The connection string associated with the primary blob location.
Declaration
public Output<string> PrimaryBlobConnectionString { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
PrimaryBlobEndpoint
The endpoint URL for blob storage in the primary location.
Declaration
public Output<string> PrimaryBlobEndpoint { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
PrimaryBlobHost
The hostname with port if applicable for blob storage in the primary location.
Declaration
public Output<string> PrimaryBlobHost { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
PrimaryConnectionString
The connection string associated with the primary location.
Declaration
public Output<string> PrimaryConnectionString { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
PrimaryDfsEndpoint
The endpoint URL for DFS storage in the primary location.
Declaration
public Output<string> PrimaryDfsEndpoint { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
PrimaryDfsHost
The hostname with port if applicable for DFS storage in the primary location.
Declaration
public Output<string> PrimaryDfsHost { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
PrimaryFileEndpoint
The endpoint URL for file storage in the primary location.
Declaration
public Output<string> PrimaryFileEndpoint { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
PrimaryFileHost
The hostname with port if applicable for file storage in the primary location.
Declaration
public Output<string> PrimaryFileHost { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
PrimaryLocation
The primary location of the storage account.
Declaration
public Output<string> PrimaryLocation { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
PrimaryQueueEndpoint
The endpoint URL for queue storage in the primary location.
Declaration
public Output<string> PrimaryQueueEndpoint { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
PrimaryQueueHost
The hostname with port if applicable for queue storage in the primary location.
Declaration
public Output<string> PrimaryQueueHost { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
PrimaryTableEndpoint
The endpoint URL for table storage in the primary location.
Declaration
public Output<string> PrimaryTableEndpoint { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
PrimaryTableHost
The hostname with port if applicable for table storage in the primary location.
Declaration
public Output<string> PrimaryTableHost { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
PrimaryWebEndpoint
The endpoint URL for web storage in the primary location.
Declaration
public Output<string> PrimaryWebEndpoint { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
PrimaryWebHost
The hostname with port if applicable for web storage in the primary location.
Declaration
public Output<string> PrimaryWebHost { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
QueueProperties
A queue_properties block as defined below.
Declaration
public Output<AccountQueueProperties> QueueProperties { get; }
Property Value
| Type | Description |
|---|---|
| Output<AccountQueueProperties> |
ResourceGroupName
The name of the resource group in which to create the storage account. Changing this forces a new resource to be created.
Declaration
public Output<string> ResourceGroupName { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
SecondaryAccessKey
The secondary access key for the storage account.
Declaration
public Output<string> SecondaryAccessKey { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
SecondaryBlobConnectionString
The connection string associated with the secondary blob location.
Declaration
public Output<string> SecondaryBlobConnectionString { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
SecondaryBlobEndpoint
The endpoint URL for blob storage in the secondary location.
Declaration
public Output<string> SecondaryBlobEndpoint { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
SecondaryBlobHost
The hostname with port if applicable for blob storage in the secondary location.
Declaration
public Output<string> SecondaryBlobHost { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
SecondaryConnectionString
The connection string associated with the secondary location.
Declaration
public Output<string> SecondaryConnectionString { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
SecondaryDfsEndpoint
The endpoint URL for DFS storage in the secondary location.
Declaration
public Output<string> SecondaryDfsEndpoint { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
SecondaryDfsHost
The hostname with port if applicable for DFS storage in the secondary location.
Declaration
public Output<string> SecondaryDfsHost { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
SecondaryFileEndpoint
The endpoint URL for file storage in the secondary location.
Declaration
public Output<string> SecondaryFileEndpoint { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
SecondaryFileHost
The hostname with port if applicable for file storage in the secondary location.
Declaration
public Output<string> SecondaryFileHost { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
SecondaryLocation
The secondary location of the storage account.
Declaration
public Output<string> SecondaryLocation { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
SecondaryQueueEndpoint
The endpoint URL for queue storage in the secondary location.
Declaration
public Output<string> SecondaryQueueEndpoint { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
SecondaryQueueHost
The hostname with port if applicable for queue storage in the secondary location.
Declaration
public Output<string> SecondaryQueueHost { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
SecondaryTableEndpoint
The endpoint URL for table storage in the secondary location.
Declaration
public Output<string> SecondaryTableEndpoint { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
SecondaryTableHost
The hostname with port if applicable for table storage in the secondary location.
Declaration
public Output<string> SecondaryTableHost { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
SecondaryWebEndpoint
The endpoint URL for web storage in the secondary location.
Declaration
public Output<string> SecondaryWebEndpoint { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
SecondaryWebHost
The hostname with port if applicable for web storage in the secondary location.
Declaration
public Output<string> SecondaryWebHost { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.String> |
StaticWebsite
A static_website block as defined below.
Declaration
public Output<AccountStaticWebsite> StaticWebsite { get; }
Property Value
| Type | Description |
|---|---|
| Output<AccountStaticWebsite> |
Tags
A mapping of tags to assign to the resource.
Declaration
public Output<ImmutableDictionary<string, string>> Tags { get; }
Property Value
| Type | Description |
|---|---|
| Output<System.Collections.Immutable.ImmutableDictionary<System.String, System.String>> |
Methods
View SourceGet(String, Input<String>, AccountState, CustomResourceOptions)
Get an existing Account resource's state with the given name, ID, and optional extra properties used to qualify the lookup.
Declaration
public static Account Get(string name, Input<string> id, AccountState state = null, CustomResourceOptions options = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.String | name | The unique name of the resulting resource. |
| Input<System.String> | id | The unique provider ID of the resource to lookup. |
| AccountState | state | Any extra arguments used during the lookup. |
| CustomResourceOptions | options | A bag of options that control this resource's behavior |
Returns
| Type | Description |
|---|---|
| Account |