StorageAccount Class

Definition

Namespace:

Azure.Provisioning.Storage

Assembly:

Azure.Provisioning.Storage.dll

Package:

Azure.Provisioning.Storage v1.0.0

Source:

StorageAccount.cs

StorageAccount.

public class StorageAccount : Azure.Provisioning.Primitives.ProvisionableResource

type StorageAccount = class
    inherit ProvisionableResource

Public Class StorageAccount
Inherits ProvisionableResource

Inheritance

Object

Provisionable

ProvisionableConstruct

NamedProvisionableConstruct

ProvisionableResource

StorageAccount

Constructors

StorageAccount(String, String)

Creates a new StorageAccount.

Properties

AccessTier	Required for storage accounts where kind = BlobStorage. The access tier is used for billing. The 'Premium' access tier is the default value for premium block blobs storage account type and it cannot be changed for the premium block blobs storage account type.
AllowBlobPublicAccess	Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property.
AllowCrossTenantReplication	Allow or disallow cross AAD tenant object replication. The default interpretation is true for this property.
AllowedCopyScope	Restrict copy to and from Storage Accounts within an AAD tenant or with Private Links to the same VNet.
AllowSharedKeyAccess	Indicates whether the storage account permits requests to be authorized with the account access key via Shared Key. If false, then all requests, including shared access signatures, must be authorized with Azure Active Directory (Azure AD). The default value is null, which is equivalent to true.
AzureFilesIdentityBasedAuthentication	Provides the identity based authentication settings for Azure Files.
BicepIdentifier	Gets or sets the the Bicep identifier name of the resource. This can be used to refer to the resource in expressions, but is not the Azure name of the resource. This value can contain letters, numbers, and underscores. (Inherited from NamedProvisionableConstruct)
BlobRestoreStatus	Blob restore status.
CreatedOn	Gets the creation date and time of the storage account in UTC.
CustomDomain	User domain assigned to the storage account. Name is the CNAME source. Only one custom domain is supported per storage account at this time. To clear the existing custom domain, use an empty string for the custom domain name property.
DependsOn	Declares explicit dependencies on other resources. (Inherited from ProvisionableResource)
DnsEndpointType	Allows you to specify the type of endpoint. Set this to AzureDNSZone to create a large number of accounts in a single subscription, which creates accounts in an Azure DNS Zone and the endpoint URL will have an alphanumeric DNS Zone identifier.
EnableHttpsTrafficOnly	Allows https traffic only to storage service if sets to true. The default value is true since API version 2019-04-01.
Encryption	Encryption settings to be used for server-side encryption for the storage account.
ExtendedLocation	Optional. Set the extended location of the resource. If not set, the storage account will be created in Azure main region. Otherwise it will be created in the specified extended location.
GeoReplicationStats	Geo Replication Stats.
Id	Gets the Id.
Identity	The identity of the resource.
ImmutableStorageWithVersioning	The property is immutable and can only be set to true at the account creation time. When set to true, it enables object level immutability for all the new containers in the account by default.
IsDefaultToOAuthAuthentication	A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property.
IsExistingResource	Gets whether this is referencing an existing resource or we're defining a new resource. (Inherited from ProvisionableResource)
IsFailoverInProgress	If the failover is in progress, the value will be true, otherwise, it will be null.
IsHnsEnabled	Account HierarchicalNamespace enabled if sets to true.
IsLocalUserEnabled	Enables local users feature, if set to true.
IsNfsV3Enabled	NFS 3.0 protocol support enabled if set to true.
IsSftpEnabled	Enables Secure File Transfer Protocol, if set to true.
KeyCreationTime	Storage account keys creation time.
KeyExpirationPeriodInDays	The key expiration period in days.
Kind	Required. Indicates the type of storage account.
LargeFileSharesState	Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled.
LastGeoFailoverOn	Gets the timestamp of the most recent instance of a failover to the secondary location. Only the most recent timestamp is retained. This element is not returned if there has never been a failover instance. Only available if the accountType is Standard_GRS or Standard_RAGRS.
Location	Required. Gets or sets the location of the resource. This will be one of the supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.). The geo region of a resource cannot be changed once it is created, but if an identical geo region is specified on update, the request will succeed.
MinimumTlsVersion	Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property.
Name	The name of the storage account within the specified resource group. Storage account names must be between 3 and 24 characters in length and use numbers and lower-case letters only.
NetworkRuleSet	Network rule set.
PrimaryEndpoints	Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object. Note that Standard_ZRS and Premium_LRS accounts only return the blob endpoint.
PrimaryLocation	Gets the location of the primary data center for the storage account.
PrivateEndpointConnections	List of private endpoint connection associated with the specified storage account.
ProvisioningState	Gets the status of the storage account at the time the operation was called.
PublicNetworkAccess	Allow or disallow public network access to Storage Account. Value is optional but if passed in, must be 'Enabled' or 'Disabled'.
ResourceType	Gets the type of the resource. (Inherited from ProvisionableResource)
ResourceVersion	Gets or sets the version of the resource. (Inherited from ProvisionableResource)
RoutingPreference	Maintains information about the network routing choice opted by the user for data transfer.
SasPolicy	SasPolicy assigned to the storage account.
SecondaryEndpoints	Gets the URLs that are used to perform a retrieval of a public blob, queue, or table object from the secondary location of the storage account. Only available if the SKU name is Standard_RAGRS.
SecondaryLocation	Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS.
Sku	Required. Gets or sets the SKU name.
StatusOfPrimary	Gets the status indicating whether the primary location of the storage account is available or unavailable.
StatusOfSecondary	Gets the status indicating whether the secondary location of the storage account is available or unavailable. Only available if the SKU name is Standard_GRS or Standard_RAGRS.
StorageAccountSkuConversionStatus	This property is readOnly and is set by server during asynchronous storage account sku conversion operations.
SystemData	Gets the SystemData.
Tags	Gets or sets a list of key value pairs that describe the resource. These tags can be used for viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key with a length no greater than 128 characters and a value with a length no greater than 256 characters.

Methods

AssignOrReplace<T>(T, T)	(Inherited from ProvisionableConstruct)
Build(ProvisioningBuildOptions)	Compose the resource into a provisioning plan that can be saved as Bicep or deployed directly. (Inherited from ProvisionableResource)
Compile()	Compile the resource into a set of Bicep statements. (Inherited from ProvisionableResource)
CreateRoleAssignment(StorageBuiltInRole, BicepValue<RoleManagementPrincipalType>, BicepValue<Guid>, String)	Creates a role assignment for a principal that grants access to this StorageAccount.
CreateRoleAssignment(StorageBuiltInRole, UserAssignedIdentity)	Creates a role assignment for a user-assigned identity that grants access to this StorageAccount.
DefineDictionaryProperty<T>(String, String[], Boolean, Boolean)	(Inherited from ProvisionableConstruct)
DefineListProperty<T>(String, String[], Boolean, Boolean)	(Inherited from ProvisionableConstruct)
DefineModelProperty<T>(String, String[], Boolean, Boolean, Boolean, String)	(Inherited from ProvisionableConstruct)
DefineProperty<T>(String, String[], Boolean, Boolean, Boolean, BicepValue<T>, String)	(Inherited from ProvisionableConstruct)
DefineProvisionableProperties()	Define all the provisionable properties of StorageAccount.
DefineResource<T>(String, String[], Boolean, Boolean, T)	(Inherited from ProvisionableResource)
FromExisting(String, String)	Creates a reference to an existing StorageAccount.
GetKeys()	Get access keys for this StorageAccount resource.
GetProvisionableResources()	Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure. (Inherited from Provisionable)
GetResources()	Get any resources represented by this object. This will typically only be the object itself for everything but Infrastructure. (Inherited from Provisionable)
Initialize()	Initialize this construct. (Inherited from ProvisionableConstruct)
OverrideWithExpression(BicepExpression)	(Inherited from ProvisionableConstruct)
Resolve(ProvisioningBuildOptions)	Resolve any resources or properties that were not explicitly specified. (Inherited from ProvisionableConstruct)
Resolve(ProvisioningContext)	Resolve any resources or properties that were not explicitly specified. (Inherited from Provisionable)
Validate(ProvisioningBuildOptions)	Validate the presence of any required members. (Inherited from ProvisionableResource)
Validate(ProvisioningContext)	Validate the presence of any required members. (Inherited from Provisionable)

Explicit Interface Implementations

IBicepValue.Assign(IBicepValue)	Assign a value to this property. (Inherited from ProvisionableConstruct)
IBicepValue.Compile()	Compile this value to a Bicep expression. (Inherited from ProvisionableConstruct)
IBicepValue.Expression	Gets the expression for this value if it's not a literal. (Inherited from ProvisionableConstruct)
IBicepValue.IsEmpty	Gets whether this value is unset or empty. (Inherited from ProvisionableConstruct)
IBicepValue.IsOutput	Tracks whether this is an output only property. (Inherited from ProvisionableConstruct)
IBicepValue.IsRequired	Tracks whether this property is required. (Inherited from ProvisionableConstruct)
IBicepValue.IsSecure	Tracks whether this contains a secure value. (Inherited from ProvisionableConstruct)
IBicepValue.Kind	Gets the kind of this value (a literal value, an expression, or it's unset). (Inherited from ProvisionableConstruct)
IBicepValue.LiteralValue	Get the value of this expression, if it's literal. (Inherited from ProvisionableConstruct)
IBicepValue.Self	Gets information about where this value was defined. (Inherited from ProvisionableConstruct)
IBicepValue.SetReadOnly()	Make this value readonly. (Inherited from ProvisionableConstruct)
IBicepValue.Source	Gets information about where this value was assigned from. (Inherited from ProvisionableConstruct)