Share via


IStorageAccount Interface

Definition

[System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190401.StorageAccountTypeConverter))]
public interface IStorageAccount : Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api10.ITrackedResource
[<System.ComponentModel.TypeConverter(typeof(Microsoft.Azure.PowerShell.Cmdlets.Functions.Models.Api20190401.StorageAccountTypeConverter))>]
type IStorageAccount = interface
    interface IJsonSerializable
    interface ITrackedResource
    interface IResourceAutoGenerated
Public Interface IStorageAccount
Implements ITrackedResource
Derived
Attributes
Implements

Properties

AccessTier

Required for storage accounts where kind = BlobStorage. The access tier used for billing.

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.

AllowBlobPublicAccess

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

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.

AzureFileIdentityBasedAuthenticationDirectoryServiceOption

Indicates the directory service used.

BlobEnabled

A boolean indicating whether or not the service encrypts the data as it is stored.

BlobLastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

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.

EnableHttpsTrafficOnly

Allows https traffic only to storage service if sets to true.

EncryptionKeySource

The encryption keySource (provider). Possible values (case-insensitive): Microsoft.Storage, Microsoft.Keyvault

FailoverInProgress

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

FileEnabled

A boolean indicating whether or not the service encrypts the data as it is stored.

FileLastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

GeoReplicationStatCanFailover

A boolean flag which indicates whether or not 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.

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}

(Inherited from IResourceAutoGenerated)
IdentityPrincipalId

The principal ID of resource identity.

IdentityTenantId

The tenant ID of resource.

IdentityType

The identity type.

IsHnsEnabled

Account HierarchicalNamespace enabled if sets to true.

KeyVaultPropertyKeyName

The name of KeyVault key.

KeyVaultPropertyKeyVaultUri

The Uri of KeyVault.

KeyVaultPropertyKeyVersion

The version of KeyVault key.

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

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

NetworkRuleSetVirtualNetworkRule

Sets the virtual network rules

PrimaryEndpointBlob

Gets the blob endpoint.

PrimaryEndpointDf

Gets the dfs endpoint.

PrimaryEndpointFile

Gets the file endpoint.

PrimaryEndpointQueue

Gets the queue endpoint.

PrimaryEndpointTable

Gets the table endpoint.

PrimaryEndpointWeb

Gets the web endpoint.

PrimaryLocation

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

ProvisioningState

Gets the status of the storage account at the time the operation was called.

QueueEnabled

A boolean indicating whether or not the service encrypts the data as it is stored.

QueueLastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

SecondaryEndpointBlob

Gets the blob endpoint.

SecondaryEndpointDf

Gets the dfs endpoint.

SecondaryEndpointFile

Gets the file endpoint.

SecondaryEndpointQueue

Gets the queue 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.

SkuCapability

The capability information in the specified SKU, including file encryption, network ACLs, change notification, etc.

SkuKind

Indicates the type of storage account.

SkuLocation

The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.).

SkuName

Gets or sets the SKU name. Required for account creation; optional for update. Note that in older versions, SKU name was called accountType.

SkuResourceType

The type of the resource, usually it is 'storageAccounts'.

SkuRestriction

The restrictions because of which SKU cannot be used. This is empty if there are no restrictions.

SkuTier

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

TableEnabled

A boolean indicating whether or not the service encrypts the data as it is stored.

TableLastEnabledTime

Gets a rough estimate of the date/time when the encryption was last enabled by the user. Only returned when encryption is enabled. There might be some unencrypted blobs which were written after this time, as it is just a rough estimate.

Tag

Resource tags.

(Inherited from ITrackedResource)
Type

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

(Inherited from IResourceAutoGenerated)

Methods

ToJson(JsonObject, SerializationMode) (Inherited from IJsonSerializable)

Applies to