Partager via


StorageAccount Class

Definition

The storage account.

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.StorageAccountTypeConverter))]
public class StorageAccount : Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.IStorageAccount, Microsoft.Azure.PowerShell.Cmdlets.Storage.Runtime.IValidates
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.StorageAccountTypeConverter))>]
type StorageAccount = class
    interface IStorageAccount
    interface IJsonSerializable
    interface ITrackedResource
    interface IResource
    interface IValidates
Public Class StorageAccount
Implements IStorageAccount, IValidates
Inheritance
StorageAccount
Attributes
Implements

Constructors

StorageAccount()

Creates an new StorageAccount instance.

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.

AccountMigrationInProgress

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

ActiveDirectoryPropertyAccountType

Specifies the Active Directory account type for Azure Storage.

ActiveDirectoryPropertyAzureStorageSid

Specifies the security identifier (SID) for Azure Storage.

ActiveDirectoryPropertyDomainGuid

Specifies the domain GUID.

ActiveDirectoryPropertyDomainName

Specifies the primary domain that the AD DNS server is authoritative for.

ActiveDirectoryPropertyDomainSid

Specifies the security identifier (SID).

ActiveDirectoryPropertyForestName

Specifies the Active Directory forest to get.

ActiveDirectoryPropertyNetBiosDomainName

Specifies the NetBIOS domain name.

ActiveDirectoryPropertySamAccountName

Specifies the Active Directory SAMAccountName for Azure Storage.

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.

AzureFileIdentityBasedAuthenticationDefaultSharePermission

Default share permission for users using Kerberos authentication if RBAC role is not assigned.

AzureFileIdentityBasedAuthenticationDirectoryServiceOption

Indicates the directory service used. Note that this enum may be extended in the future.

BlobRestoreStatusFailureReason

Failure reason when blob restore is failed.

BlobRestoreStatusRestoreId

Id for tracking blob restore request.

CreationTime

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

CustomDomainName

Gets or sets the custom domain name assigned to the storage account. Name is the CNAME source.

CustomDomainUseSubDomainName

Indicates whether indirect CName validation is enabled. Default value is false. This should only be set on updates.

DefaultToOAuthAuthentication

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

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.

EnableNfsV3

NFS 3.0 protocol support enabled if set to true.

Encryption

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

ExtendedLocationName

The name of the extended location.

ExtendedLocationType

The type of the extended location.

FailoverInProgress

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

GeoReplicationStatCanFailover

A boolean flag which indicates whether or not account failover is supported for the account.

GeoReplicationStatCanPlannedFailover

A boolean flag which indicates whether or not planned account failover is supported for the account.

GeoReplicationStatLastSyncTime

All primary writes preceding this UTC date/time value are guaranteed to be available for read operations. Primary writes following this point in time may or may not be available for reads. Element may be default value if value of LastSyncTime is not available, this can happen if secondary is offline or we are in bootstrap.

GeoReplicationStatPostFailoverRedundancy

The redundancy type of the account after an account failover is performed.

GeoReplicationStatPostPlannedFailoverRedundancy

The redundancy type of the account after a planned account failover is performed.

GeoReplicationStatStatus

The status of the secondary location. Possible values are: - Live: Indicates that the secondary location is active and operational. - Bootstrap: Indicates initial synchronization from the primary location to the secondary location is in progress.This typically occurs when replication is first enabled. - Unavailable: Indicates that the secondary location is temporarily unavailable.

Id

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

IdentityPrincipalId

The principal ID of resource identity.

IdentityTenantId

The tenant ID of resource.

IdentityType

The identity type.

IdentityUserAssignedIdentity

Gets or sets a list of key value pairs that describe the set of User Assigned identities that will be used with this storage account. The key is the ARM resource identifier of the identity. Only 1 User Assigned identity is permitted here.

ImmutabilityPolicyAllowProtectedAppendWrite

This property can only be changed for disabled and unlocked time-based retention policies. When enabled, new blocks can be written to an append blob while maintaining immutability protection and compliance. Only new blocks can be added and any existing blocks cannot be modified or deleted.

ImmutabilityPolicyImmutabilityPeriodSinceCreationInDay

The immutability period for the blobs in the container since the policy creation, in days.

ImmutabilityPolicyState

The ImmutabilityPolicy state defines the mode of the policy. Disabled state disables the policy, Unlocked state allows increase and decrease of immutability retention time and also allows toggling allowProtectedAppendWrites property, Locked state only allows the increase of the immutability retention time. A policy can only be created in a Disabled or Unlocked state and can be toggled between the two states. Only a policy in an Unlocked state can transition to a Locked state which cannot be reverted.

ImmutableStorageWithVersioningEnabled

A boolean flag which enables account-level immutability. All the containers under such an account have object-level immutability enabled by default.

IsHnsEnabled

Account HierarchicalNamespace enabled if sets to true.

IsLocalUserEnabled

Enables local users feature, 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.

KeyCreationTimeKey1
KeyCreationTimeKey2
KeyPolicyKeyExpirationPeriodInDay

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.

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

The geo-location where the resource lives

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

NetworkRuleSetBypass

Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Possible values are any combination of Logging|Metrics|AzureServices (For example, "Logging, Metrics"), or None to bypass none of those traffics.

NetworkRuleSetDefaultAction

Specifies the default action of allow or deny when no other rules match.

NetworkRuleSetIPRule

Sets the IP ACL rules

NetworkRuleSetResourceAccessRule

Sets the resource access rules

NetworkRuleSetVirtualNetworkRule

Sets the virtual network rules

ParameterBlobRange

Blob ranges to restore.

ParameterTimeToRestore

Restore blob to the specified time.

PrimaryEndpointBlob

Gets the blob endpoint.

PrimaryEndpointDf

Gets the dfs endpoint.

PrimaryEndpointFile

Gets the file endpoint.

PrimaryEndpointQueue

Gets the queue endpoint.

PrimaryEndpointsInternetEndpointsBlob

Gets the blob endpoint.

PrimaryEndpointsInternetEndpointsDf

Gets the dfs endpoint.

PrimaryEndpointsInternetEndpointsFile

Gets the file endpoint.

PrimaryEndpointsInternetEndpointsWeb

Gets the web endpoint.

PrimaryEndpointsMicrosoftEndpointsBlob

Gets the blob endpoint.

PrimaryEndpointsMicrosoftEndpointsDf

Gets the dfs endpoint.

PrimaryEndpointsMicrosoftEndpointsFile

Gets the file endpoint.

PrimaryEndpointsMicrosoftEndpointsQueue

Gets the queue endpoint.

PrimaryEndpointsMicrosoftEndpointsTable

Gets the table endpoint.

PrimaryEndpointsMicrosoftEndpointsWeb

Gets the web endpoint.

PrimaryEndpointTable

Gets the table endpoint.

PrimaryEndpointWeb

Gets the web endpoint.

PrimaryLocation

Gets the location of the primary data center for the storage account.

PrivateEndpointConnection

List of private endpoint connection associated with the specified storage account

PropertiesBlobRestoreStatusStatus

The status of blob restore progress. Possible values are: - InProgress: Indicates that blob restore is ongoing. - Complete: Indicates that blob restore has been completed successfully. - Failed: Indicates that blob restore is failed.

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'.

ResourceGroupName

Gets the resource group name

RoutingPreferencePublishInternetEndpoint

A boolean flag which indicates whether internet routing storage endpoints are to be published

RoutingPreferencePublishMicrosoftEndpoint

A boolean flag which indicates whether microsoft routing storage endpoints are to be published

RoutingPreferenceRoutingChoice

Routing Choice defines the kind of network routing opted by the user.

SasPolicyExpirationAction

The SAS expiration action. Can only be Log.

SasPolicySasExpirationPeriod

The SAS expiration period, DD.HH:MM:SS.

SecondaryEndpointBlob

Gets the blob endpoint.

SecondaryEndpointDf

Gets the dfs endpoint.

SecondaryEndpointFile

Gets the file endpoint.

SecondaryEndpointQueue

Gets the queue endpoint.

SecondaryEndpointsInternetEndpointsBlob

Gets the blob endpoint.

SecondaryEndpointsInternetEndpointsDf

Gets the dfs endpoint.

SecondaryEndpointsInternetEndpointsFile

Gets the file endpoint.

SecondaryEndpointsInternetEndpointsWeb

Gets the web endpoint.

SecondaryEndpointsMicrosoftEndpointsBlob

Gets the blob endpoint.

SecondaryEndpointsMicrosoftEndpointsDf

Gets the dfs endpoint.

SecondaryEndpointsMicrosoftEndpointsFile

Gets the file endpoint.

SecondaryEndpointsMicrosoftEndpointsQueue

Gets the queue endpoint.

SecondaryEndpointsMicrosoftEndpointsTable

Gets the table endpoint.

SecondaryEndpointsMicrosoftEndpointsWeb

Gets the web endpoint.

SecondaryEndpointTable

Gets the table endpoint.

SecondaryEndpointWeb

Gets the web endpoint.

SecondaryLocation

Gets the location of the geo-replicated secondary for the storage account. Only available if the accountType is Standard_GRS or Standard_RAGRS.

SkuConversionStatusEndTime

This property represents the sku conversion end time.

SkuConversionStatusSkuConversionStatus

This property indicates the current sku conversion status.

SkuConversionStatusStartTime

This property represents the sku conversion start time.

SkuConversionStatusTargetSkuName

This property represents the target sku name to which the account sku is being converted asynchronously.

SkuName

The SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.

SkuTier

The SKU tier. This is based on 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.

Tag

Resource tags.

Type

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

Methods

DeserializeFromDictionary(IDictionary)

Deserializes a IDictionary into an instance of StorageAccount.

DeserializeFromPSObject(PSObject)

Deserializes a PSObject into an instance of StorageAccount.

FromJson(JsonNode)

Deserializes a JsonNode into an instance of Microsoft.Azure.PowerShell.Cmdlets.Storage.Models.IStorageAccount.

FromJsonString(String)

Creates a new instance of StorageAccount, deserializing the content from a json string.

ToJson(JsonObject, SerializationMode)

Serializes this instance of StorageAccount into a JsonNode.

ToJsonString()

Serializes this instance to a json string.

ToString()
Validate(IEventListener)

Validates that this object meets the validation criteria.

Applies to