你当前正在访问 Microsoft Azure Global Edition 技术文档网站。 如果需要访问由世纪互联运营的 Microsoft Azure 中国技术文档网站，请访问 https://docs.azure.cn。

StorageAccount interface

包:

@azure/arm-storage

存储帐户。

Extends

TrackedResource

属性

accessTier	对于类型 = BlobStorage 的存储帐户是必需的。 访问层用于计费。 “高级”访问层是高级块 Blob 存储帐户类型的默认值，无法更改高级块 Blob 存储帐户类型。 注意：此属性不会被序列化。 它只能由服务器填充。
accountMigrationInProgress	如果客户发起的帐户迁移正在进行中，该值将为 true，否则将为 null。 注意：此属性不会被序列化。 它只能由服务器填充。
allowBlobPublicAccess	允许或禁止对存储帐户中所有 Blob 或容器的公共访问。 此属性的默认解释为 false。
allowCrossTenantReplication	允许或禁止跨 AAD 租户对象复制。 仅当对象复制策略涉及不同 AAD 租户中的存储帐户时，才将新帐户或现有帐户的此属性设置为 true。 默认解释为 false，新帐户默认遵循最佳安全做法。
allowedCopyScope	限制向/从 AAD 租户中的存储帐户复制，或者使用指向同一 VNet 的专用链接进行复制。
allowSharedKeyAccess	指示存储帐户是否允许通过共享密钥通过帐户访问密钥授权请求。 如果为 false，则必须使用 Azure Active Directory (Azure AD) 授权所有请求（包括共享访问签名）。 默认值为 null，等效于 true。
azureFilesIdentityBasedAuthentication	为Azure 文件存储提供基于标识的身份验证设置。
blobRestoreStatus	Blob 还原状态 注意：此属性不会被序列化。 它只能由服务器填充。
creationTime	获取存储帐户的创建日期和时间（UTC）。 注意：此属性不会被序列化。 它只能由服务器填充。
customDomain	获取用户分配给此存储帐户的自定义域。 注意：此属性不会被序列化。 它只能由服务器填充。
defaultToOAuthAuthentication	一个布尔标志，指示默认身份验证是否为 OAuth。 此属性的默认解释为 false。
dnsEndpointType	允许指定终结点的类型。 将此设置为 AzureDNSZone，在单个订阅中创建大量帐户，这会在 Azure DNS 区域中创建帐户，并且终结点 URL 将具有字母数字 DNS 区域标识符。
enableHttpsTrafficOnly	仅当设置为 true 时，才允许将 https 流量发送到存储服务。
enableNfsV3	如果设置为 true，则启用 NFS 3.0 协议支持。
encryption	要用于存储帐户的服务器端加密的加密设置。 注意：此属性不会被序列化。 它只能由服务器填充。
extendedLocation	资源的 extendedLocation。
failoverInProgress	如果正在进行故障转移，则该值将为 true，否则将为 null。 注意：此属性不会被序列化。 它只能由服务器填充。
geoReplicationStats	异地复制统计信息 注意：不会序列化此属性。 它只能由服务器填充。
identity	资源的标识。
immutableStorageWithVersioning	属性是不可变的，只能在创建帐户时设置为 true。 如果设置为 true，则默认为帐户中的所有容器启用对象级别不可变性。
isHnsEnabled	如果设置为 true，则启用 Account HierarchicalNamespace。
isLocalUserEnabled	启用本地用户功能（如果设置为 true）
isSftpEnabled	启用安全文件传输协议（如果设置为 true）
isSkuConversionBlocked	在正在进行的迁移事件中，此属性将设置为 true 或 false。 默认值为 null。 注意：此属性不会序列化。 它只能由服务器填充。
keyCreationTime	存储帐户密钥创建时间。 注意：此属性不会序列化。 它只能由服务器填充。
keyPolicy	分配给存储帐户的 KeyPolicy。 注意：此属性不会序列化。 它只能由服务器填充。
kind	获取 Kind。 注意：此属性不会序列化。 它只能由服务器填充。
largeFileSharesState	如果设置为“已启用”，则允许大型文件共享。 启用后，无法禁用它。
lastGeoFailoverTime	获取故障转移到辅助位置的最新实例的时间戳。 仅保留最新的时间戳。 如果从未有故障转移实例，则不会返回此元素。 仅当 accountType Standard_GRS或Standard_RAGRS时可用。 注意：此属性不会序列化。 它只能由服务器填充。
minimumTlsVersion	设置请求存储时允许的最低 TLS 版本。 此属性的默认解释为 TLS 1.0。
networkRuleSet	网络规则集 注意：不会序列化此属性。 它只能由服务器填充。
primaryEndpoints	获取用于对公共 Blob、队列或表对象执行检索的 URL。 请注意，Standard_ZRS和Premium_LRS帐户仅返回 Blob 终结点。 注意：此属性不会序列化。 它只能由服务器填充。
primaryLocation	获取存储帐户的主数据中心的位置。 注意：此属性不会序列化。 它只能由服务器填充。
privateEndpointConnections	与指定存储帐户关联的专用终结点连接列表 注意：此属性不会序列化。 它只能由服务器填充。
provisioningState	获取调用操作时存储帐户的状态。 注意：此属性不会序列化。 它只能由服务器填充。
publicNetworkAccess	允许或禁止公用网络访问存储帐户。 值是可选的，但如果传入，则必须为“Enabled”或“Disabled”。
routingPreference	维护用户为数据传输选择的网络路由选择的相关信息
sasPolicy	分配给存储帐户的 SasPolicy。 注意：此属性不会序列化。 它只能由服务器填充。
secondaryEndpoints	获取用于从存储帐户的辅助位置检索公共 Blob、队列或表对象的 URL。 仅当 SKU 名称Standard_RAGRS时可用。 注意：此属性不会序列化。 它只能由服务器填充。
secondaryLocation	获取存储帐户的异地复制辅助数据库的位置。 仅当 accountType Standard_GRS或Standard_RAGRS时可用。 注意：此属性不会序列化。 它只能由服务器填充。
sku	获取 SKU。 注意：此属性不会序列化。 它只能由服务器填充。
statusOfPrimary	获取指示存储帐户的主位置是可用还是不可用的状态。 注意：此属性不会序列化。 它只能由服务器填充。
statusOfSecondary	获取指示存储帐户的辅助位置是可用还是不可用的状态。 仅当 SKU 名称Standard_GRS或Standard_RAGRS时才可用。 注意：此属性不会序列化。 它只能由服务器填充。
storageAccountSkuConversionStatus	此属性为 readOnly，由服务器在异步存储帐户 SKU 转换操作期间设置。

继承属性

id	资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意：此属性不会被序列化。 它只能由服务器填充。
location	资源所在的地理位置
name	资源的名称 注意：此属性不会被序列化。 它只能由服务器填充。
tags	资源标记。
type	资源类型。 例如，“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意：此属性不会被序列化。 它只能由服务器填充。

属性详细信息

accessTier

对于类型 = BlobStorage 的存储帐户是必需的。 访问层用于计费。 “高级”访问层是高级块 Blob 存储帐户类型的默认值，无法更改高级块 Blob 存储帐户类型。 注意：此属性不会被序列化。 它只能由服务器填充。

accessTier?: AccessTier

属性值

AccessTier

accountMigrationInProgress

如果客户发起的帐户迁移正在进行中，该值将为 true，否则将为 null。 注意：此属性不会被序列化。 它只能由服务器填充。

accountMigrationInProgress?: boolean

属性值

boolean

allowBlobPublicAccess

允许或禁止对存储帐户中所有 Blob 或容器的公共访问。 此属性的默认解释为 false。

allowBlobPublicAccess?: boolean

属性值

boolean

allowCrossTenantReplication

允许或禁止跨 AAD 租户对象复制。 仅当对象复制策略涉及不同 AAD 租户中的存储帐户时，才将新帐户或现有帐户的此属性设置为 true。 默认解释为 false，新帐户默认遵循最佳安全做法。

allowCrossTenantReplication?: boolean

属性值

boolean

allowedCopyScope

限制向/从 AAD 租户中的存储帐户复制，或者使用指向同一 VNet 的专用链接进行复制。

allowedCopyScope?: string

属性值

string

allowSharedKeyAccess

指示存储帐户是否允许通过共享密钥通过帐户访问密钥授权请求。 如果为 false，则必须使用 Azure Active Directory (Azure AD) 授权所有请求（包括共享访问签名）。 默认值为 null，等效于 true。

allowSharedKeyAccess?: boolean

属性值

boolean

azureFilesIdentityBasedAuthentication

为Azure 文件存储提供基于标识的身份验证设置。

azureFilesIdentityBasedAuthentication?: AzureFilesIdentityBasedAuthentication

属性值

AzureFilesIdentityBasedAuthentication

blobRestoreStatus

Blob 还原状态 注意：此属性不会被序列化。 它只能由服务器填充。

blobRestoreStatus?: BlobRestoreStatus

属性值

BlobRestoreStatus

creationTime

获取存储帐户的创建日期和时间（UTC）。 注意：此属性不会被序列化。 它只能由服务器填充。

creationTime?: Date

属性值

Date

customDomain

获取用户分配给此存储帐户的自定义域。 注意：此属性不会被序列化。 它只能由服务器填充。

customDomain?: CustomDomain

属性值

CustomDomain

defaultToOAuthAuthentication

一个布尔标志，指示默认身份验证是否为 OAuth。 此属性的默认解释为 false。

defaultToOAuthAuthentication?: boolean

属性值

boolean

dnsEndpointType

允许指定终结点的类型。 将此设置为 AzureDNSZone，在单个订阅中创建大量帐户，这会在 Azure DNS 区域中创建帐户，并且终结点 URL 将具有字母数字 DNS 区域标识符。

dnsEndpointType?: string

属性值

string

enableHttpsTrafficOnly

仅当设置为 true 时，才允许将 https 流量发送到存储服务。

enableHttpsTrafficOnly?: boolean

属性值

boolean

enableNfsV3

如果设置为 true，则启用 NFS 3.0 协议支持。

enableNfsV3?: boolean

属性值

boolean

encryption

要用于存储帐户的服务器端加密的加密设置。 注意：此属性不会被序列化。 它只能由服务器填充。

encryption?: Encryption

属性值

Encryption

extendedLocation

资源的 extendedLocation。

extendedLocation?: ExtendedLocation

属性值

ExtendedLocation

failoverInProgress

如果正在进行故障转移，则该值将为 true，否则将为 null。 注意：此属性不会被序列化。 它只能由服务器填充。

failoverInProgress?: boolean

属性值

boolean

geoReplicationStats

异地复制统计信息 注意：不会序列化此属性。 它只能由服务器填充。

geoReplicationStats?: GeoReplicationStats

属性值

GeoReplicationStats

identity

资源的标识。

identity?: Identity

属性值

Identity

immutableStorageWithVersioning

属性是不可变的，只能在创建帐户时设置为 true。 如果设置为 true，则默认为帐户中的所有容器启用对象级别不可变性。

immutableStorageWithVersioning?: ImmutableStorageAccount

属性值

ImmutableStorageAccount

isHnsEnabled

如果设置为 true，则启用 Account HierarchicalNamespace。

isHnsEnabled?: boolean

属性值

boolean

isLocalUserEnabled

启用本地用户功能（如果设置为 true）

isLocalUserEnabled?: boolean

属性值

boolean

isSftpEnabled

启用安全文件传输协议（如果设置为 true）

isSftpEnabled?: boolean

属性值

boolean

isSkuConversionBlocked

在正在进行的迁移事件中，此属性将设置为 true 或 false。 默认值为 null。 注意：此属性不会序列化。 它只能由服务器填充。

isSkuConversionBlocked?: boolean

属性值

boolean

keyCreationTime

存储帐户密钥创建时间。 注意：此属性不会序列化。 它只能由服务器填充。

keyCreationTime?: KeyCreationTime

属性值

KeyCreationTime

keyPolicy

分配给存储帐户的 KeyPolicy。 注意：此属性不会序列化。 它只能由服务器填充。

keyPolicy?: KeyPolicy

属性值

KeyPolicy

kind

获取 Kind。 注意：此属性不会序列化。 它只能由服务器填充。

kind?: string

属性值

string

largeFileSharesState

如果设置为“已启用”，则允许大型文件共享。 启用后，无法禁用它。

largeFileSharesState?: string

属性值

string

lastGeoFailoverTime

获取故障转移到辅助位置的最新实例的时间戳。 仅保留最新的时间戳。 如果从未有故障转移实例，则不会返回此元素。 仅当 accountType Standard_GRS或Standard_RAGRS时可用。 注意：此属性不会序列化。 它只能由服务器填充。

lastGeoFailoverTime?: Date

属性值

Date

minimumTlsVersion

设置请求存储时允许的最低 TLS 版本。 此属性的默认解释为 TLS 1.0。

minimumTlsVersion?: string

属性值

string

networkRuleSet

网络规则集 注意：不会序列化此属性。 它只能由服务器填充。

networkRuleSet?: NetworkRuleSet

属性值

NetworkRuleSet

primaryEndpoints

获取用于对公共 Blob、队列或表对象执行检索的 URL。 请注意，Standard_ZRS和Premium_LRS帐户仅返回 Blob 终结点。 注意：此属性不会序列化。 它只能由服务器填充。

primaryEndpoints?: Endpoints

属性值

Endpoints

primaryLocation

获取存储帐户的主数据中心的位置。 注意：此属性不会序列化。 它只能由服务器填充。

primaryLocation?: string

属性值

string

privateEndpointConnections

与指定存储帐户关联的专用终结点连接列表 注意：此属性不会序列化。 它只能由服务器填充。

privateEndpointConnections?: PrivateEndpointConnection[]

属性值

PrivateEndpointConnection[]

provisioningState

获取调用操作时存储帐户的状态。 注意：此属性不会序列化。 它只能由服务器填充。

provisioningState?: ProvisioningState

属性值

ProvisioningState

publicNetworkAccess

允许或禁止公用网络访问存储帐户。 值是可选的，但如果传入，则必须为“Enabled”或“Disabled”。

publicNetworkAccess?: string

属性值

string

routingPreference

维护用户为数据传输选择的网络路由选择的相关信息

routingPreference?: RoutingPreference

属性值

RoutingPreference

sasPolicy

分配给存储帐户的 SasPolicy。 注意：此属性不会序列化。 它只能由服务器填充。

sasPolicy?: SasPolicy

属性值

SasPolicy

secondaryEndpoints

获取用于从存储帐户的辅助位置检索公共 Blob、队列或表对象的 URL。 仅当 SKU 名称Standard_RAGRS时可用。 注意：此属性不会序列化。 它只能由服务器填充。

secondaryEndpoints?: Endpoints

属性值

Endpoints

secondaryLocation

获取存储帐户的异地复制辅助数据库的位置。 仅当 accountType Standard_GRS或Standard_RAGRS时可用。 注意：此属性不会序列化。 它只能由服务器填充。

secondaryLocation?: string

属性值

string

sku

获取 SKU。 注意：此属性不会序列化。 它只能由服务器填充。

sku?: Sku

属性值

Sku

statusOfPrimary

获取指示存储帐户的主位置是可用还是不可用的状态。 注意：此属性不会序列化。 它只能由服务器填充。

statusOfPrimary?: AccountStatus

属性值

AccountStatus

statusOfSecondary

获取指示存储帐户的辅助位置是可用还是不可用的状态。 仅当 SKU 名称Standard_GRS或Standard_RAGRS时才可用。 注意：此属性不会序列化。 它只能由服务器填充。

statusOfSecondary?: AccountStatus

属性值

AccountStatus

storageAccountSkuConversionStatus

此属性为 readOnly，由服务器在异步存储帐户 SKU 转换操作期间设置。

storageAccountSkuConversionStatus?: StorageAccountSkuConversionStatus

属性值

StorageAccountSkuConversionStatus

继承属性详细信息

id

资源的完全限定的资源 ID。 例如 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName} 注意：此属性不会被序列化。 它只能由服务器填充。

id?: string

属性值

string

继承自TrackedResource.id

location

资源所在的地理位置

location: string

属性值

string

继承自TrackedResource.location

name

资源的名称 注意：此属性不会被序列化。 它只能由服务器填充。

name?: string

属性值

string

继承自TrackedResource.name

tags

资源标记。

tags?: {[propertyName: string]: string}

属性值

{[propertyName: string]: string}

继承自TrackedResource.tags

type

资源类型。 例如，“Microsoft.Compute/virtualMachines”或“Microsoft.Storage/storageAccounts”注意：此属性不会被序列化。 它只能由服务器填充。

type?: string

属性值

string

继承自TrackedResource.type