Share via


StorageAccountData Class

Definition

A class representing the StorageAccount data model. The storage account.

public class StorageAccountData : Azure.ResourceManager.Models.TrackedResourceData, System.ClientModel.Primitives.IJsonModel<Azure.ResourceManager.Storage.StorageAccountData>, System.ClientModel.Primitives.IPersistableModel<Azure.ResourceManager.Storage.StorageAccountData>
public class StorageAccountData : Azure.ResourceManager.Models.TrackedResourceData
type StorageAccountData = class
    inherit TrackedResourceData
    interface IJsonModel<StorageAccountData>
    interface IPersistableModel<StorageAccountData>
type StorageAccountData = class
    inherit TrackedResourceData
Public Class StorageAccountData
Inherits TrackedResourceData
Implements IJsonModel(Of StorageAccountData), IPersistableModel(Of StorageAccountData)
Public Class StorageAccountData
Inherits TrackedResourceData
Inheritance
Implements

Constructors

StorageAccountData(AzureLocation)

Initializes a new instance of StorageAccountData.

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 false for this property.

AllowCrossTenantReplication

Allow or disallow cross AAD tenant object replication. Set this property to true for new or existing accounts only if object replication policies will involve storage accounts in different AAD tenants. The default interpretation is false for new accounts to follow best security practices by default.

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.

BlobRestoreStatus

Blob restore status.

CreatedOn

Gets the creation date and time of the storage account in UTC.

CustomDomain

Gets the custom domain the user assigned to this storage account.

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.

Encryption

Encryption settings to be used for server-side encryption for the storage account.

ExtendedLocation

The extendedLocation of the resource.

GeoReplicationStats

Geo Replication Stats.

Id

Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.

(Inherited from ResourceData)
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 containers in the account by default.

IsAccountMigrationInProgress

If customer initiated account migration is in progress, the value will be true else it will be null.

IsDefaultToOAuthAuthentication

A boolean flag which indicates whether the default authentication is OAuth or not. The default interpretation is false for this property.

IsExtendedGroupEnabled

Enables extended group support with local users feature, if set to true.

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.

IsSkuConversionBlocked

This property will be set to true or false on an event of ongoing migration. Default value is null.

KeyCreationTime

Storage account keys creation time.

KeyExpirationPeriodInDays

The key expiration period in days.

Kind

Gets the Kind.

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

The geo-location where the resource lives.

(Inherited from TrackedResourceData)
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 resource.

(Inherited from ResourceData)
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, disallow, or let Network Security Perimeter configuration to evaluate public network access to Storage Account.

ResourceType

The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

(Inherited from ResourceData)
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

Gets the SKU.

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

Azure Resource Manager metadata containing createdBy and modifiedBy information.

(Inherited from ResourceData)
Tags

Resource tags.

(Inherited from TrackedResourceData)

Methods

JsonModelWriteCore(Utf8JsonWriter, ModelReaderWriterOptions) (Inherited from TrackedResourceData)

Explicit Interface Implementations

IJsonModel<StorageAccountData>.Create(Utf8JsonReader, ModelReaderWriterOptions)

Reads one JSON value (including objects or arrays) from the provided reader and converts it to a model.

IJsonModel<StorageAccountData>.Write(Utf8JsonWriter, ModelReaderWriterOptions)

Writes the model to the provided Utf8JsonWriter.

IPersistableModel<StorageAccountData>.Create(BinaryData, ModelReaderWriterOptions)

Converts the provided BinaryData into a model.

IPersistableModel<StorageAccountData>.GetFormatFromOptions(ModelReaderWriterOptions)

Gets the data interchange format (JSON, Xml, etc) that the model uses when communicating with the service.

IPersistableModel<StorageAccountData>.Write(ModelReaderWriterOptions)

Writes the model into a BinaryData.

Applies to