StorageAccount Class

Definition

The storage account.

[Microsoft.Rest.Serialization.JsonTransformation]
public class StorageAccount : Microsoft.Azure.PowerShell.Cmdlets.Compute.Helpers.Storage.Models.TrackedResource
[<Microsoft.Rest.Serialization.JsonTransformation>]
type StorageAccount = class
    inherit TrackedResource
Public Class StorageAccount
Inherits TrackedResource
Inheritance
Attributes

Constructors

StorageAccount()

Initializes a new instance of the StorageAccount class.

StorageAccount(String, String, String, String, IDictionary<String, String>, Sku, String, Identity, ExtendedLocation, Nullable<ProvisioningState>, Endpoints, String, Nullable<AccountStatus>, Nullable<DateTime>, String, Nullable<AccountStatus>, Nullable<DateTime>, CustomDomain, SasPolicy, KeyPolicy, KeyCreationTime, Endpoints, Encryption, Nullable<AccessTier>, AzureFilesIdentityBasedAuthentication, Nullable<Boolean>, NetworkRuleSet, Nullable<Boolean>, GeoReplicationStats, Nullable<Boolean>, String, IList<PrivateEndpointConnection>, RoutingPreference, BlobRestoreStatus, Nullable<Boolean>, String, Nullable<Boolean>, Nullable<Boolean>)

Initializes a new instance of the StorageAccount class.

Properties

AccessTier

Gets required for storage accounts where kind = BlobStorage. The access tier used for billing. Possible values include: 'Hot', 'Cool'

AllowBlobPublicAccess

Gets or sets allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property.

AllowSharedKeyAccess

Gets or sets 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

Gets or sets provides the identity based authentication settings for Azure Files.

BlobRestoreStatus

Gets blob restore status

CreationTime

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

CustomDomain

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

EnableHttpsTrafficOnly

Gets or sets allows https traffic only to storage service if sets to true.

EnableNfsV3

Gets or sets NFS 3.0 protocol support enabled if set to true.

Encryption

Gets the encryption settings on the account. If unspecified, the account is unencrypted.

ExtendedLocation

Gets or sets the extendedLocation of the resource.

FailoverInProgress

Gets if the failover is in progress, the value will be true, otherwise, it will be null.

GeoReplicationStats

Gets geo Replication Stats

Id

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

(Inherited from Resource)
Identity

Gets or sets the identity of the resource.

IsHnsEnabled

Gets or sets account HierarchicalNamespace enabled if sets to true.

KeyCreationTime

Gets storage account keys creation time.

KeyPolicy

Gets keyPolicy assigned to the storage account.

Kind

Gets the Kind. Possible values include: 'Storage', 'StorageV2', 'BlobStorage', 'FileStorage', 'BlockBlobStorage'

LargeFileSharesState

Gets or sets allow large file shares if sets to Enabled. It cannot be disabled once it is enabled. Possible values include: 'Disabled', 'Enabled'

LastGeoFailoverTime

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

Gets or sets the geo-location where the resource lives

(Inherited from TrackedResource)
MinimumTlsVersion

Gets or sets set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property. Possible values include: 'TLS1_0', 'TLS1_1', 'TLS1_2'

Name

Gets the name of the resource

(Inherited from Resource)
NetworkRuleSet

Gets 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

Gets 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. Possible values include: 'Creating', 'ResolvingDNS', 'Succeeded'

RoutingPreference

Gets or sets maintains information about the network routing choice opted by the user for data transfer

SasPolicy

Gets 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. Possible values include: 'available', '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. Possible values include: 'available', 'unavailable'

Tags

Gets or sets resource tags.

(Inherited from TrackedResource)
Type

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

(Inherited from Resource)

Methods

Validate()

Validate the object.

Extension Methods

IsPremiumLrs(StorageAccount)
Sku(StorageAccount)
SkuName(StorageAccount)

Applies to