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

Storage Accounts - Get Properties

返回指定存储帐户的属性,包括但不限于名称、SKU 名称、位置和帐户状态。 ListKeys 操作应用于检索存储密钥。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}?api-version=2021-09-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Storage/storageAccounts/{accountName}?api-version=2021-09-01&$expand={$expand}

URI 参数

Name In Required Type Description
accountName
path True
  • string

指定资源组中的存储帐户的名称。 存储帐户名称长度必须为 3 到 24 个字符,并且只能使用数字和小写字母。

resourceGroupName
path True
  • string

用户订阅中的资源组的名称。 此名称不区分大小写。

Regex pattern: ^[-\w\._\(\)]+$

subscriptionId
path True
  • string

目标订阅的 ID。

api-version
query True
  • string

要用于此操作的 API 版本。

$expand
query

可用于扩展帐户属性中的属性。 默认情况下,提取属性时不包括数据。 目前我们仅支持 geoReplicationStats 和 blobRestoreStatus。

响应

Name Type Description
200 OK

确定 - 已成功检索存储帐户的属性。

安全性

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation 模拟用户帐户

示例

StorageAccountGetAsyncSkuConversionStatus
StorageAccountGetProperties
StorageAccountGetPropertiesCMKEnabled
StorageAccountGetPropertiesCMKVersionExpirationTime

StorageAccountGetAsyncSkuConversionStatus

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596?api-version=2021-09-01

Sample Response

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596",
  "kind": "StorageV2",
  "location": "eastus",
  "name": "sto8596",
  "properties": {
    "allowBlobPublicAccess": false,
    "minimumTlsVersion": "TLS1_2",
    "storageAccountSkuConversionStatus": {
      "skuConversionStatus": "InProgress",
      "targetSkuName": "Standard_GRS",
      "startTime": "2021-09-01T02:53:39.0932539Z",
      "endTime": "2021-09-02T02:53:39.0932539Z"
    }
  },
  "sku": {
    "name": "Standard_GRS",
    "tier": "Standard"
  },
  "type": "Microsoft.Storage/storageAccounts"
}

StorageAccountGetProperties

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596?api-version=2021-09-01

Sample Response

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596",
  "kind": "Storage",
  "location": "eastus2(stage)",
  "name": "sto8596",
  "properties": {
    "keyCreationTime": {
      "key1": "2021-03-18T04:42:22.4322836Z",
      "key2": "2021-03-18T04:42:22.4322836Z"
    },
    "geoReplicationStats": {
      "status": "Live",
      "lastSyncTime": "2018-10-30T00:25:34Z",
      "canFailover": true
    },
    "isHnsEnabled": true,
    "creationTime": "2017-06-01T02:42:41.7633306Z",
    "networkAcls": {
      "bypass": "AzureServices",
      "defaultAction": "Allow",
      "ipRules": [],
      "virtualNetworkRules": [],
      "resourceAccessRules": [
        {
          "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
          "resourceId": "/subscriptions/a7e99807-abbf-4642-bdec-2c809a96a8bc/resourceGroups/res9407/providers/Microsoft.Synapse/workspaces/testworkspace"
        }
      ]
    },
    "primaryEndpoints": {
      "web": "https://sto8596.web.core.windows.net/",
      "dfs": "https://sto8596.dfs.core.windows.net/",
      "blob": "https://sto8596.blob.core.windows.net/",
      "file": "https://sto8596.file.core.windows.net/",
      "queue": "https://sto8596.queue.core.windows.net/",
      "table": "https://sto8596.table.core.windows.net/",
      "microsoftEndpoints": {
        "web": "https://sto8596-microsoftrouting.web.core.windows.net/",
        "dfs": "https://sto8596-microsoftrouting.dfs.core.windows.net/",
        "blob": "https://sto8596-microsoftrouting.blob.core.windows.net/",
        "file": "https://sto8596-microsoftrouting.file.core.windows.net/",
        "queue": "https://sto8596-microsoftrouting.queue.core.windows.net/",
        "table": "https://sto8596-microsoftrouting.table.core.windows.net/"
      },
      "internetEndpoints": {
        "web": "https://sto8596-internetrouting.web.core.windows.net/",
        "dfs": "https://sto8596-internetrouting.dfs.core.windows.net/",
        "blob": "https://sto8596-internetrouting.blob.core.windows.net/",
        "file": "https://sto8596-internetrouting.file.core.windows.net/"
      }
    },
    "primaryLocation": "eastus2(stage)",
    "provisioningState": "Succeeded",
    "routingPreference": {
      "routingChoice": "MicrosoftRouting",
      "publishMicrosoftEndpoints": true,
      "publishInternetEndpoints": true
    },
    "encryption": {
      "services": {
        "file": {
          "keyType": "Account",
          "enabled": true,
          "lastEnabledTime": "2019-12-11T20:49:31.7036140Z"
        },
        "blob": {
          "keyType": "Account",
          "enabled": true,
          "lastEnabledTime": "2019-12-11T20:49:31.7036140Z"
        }
      },
      "keySource": "Microsoft.Storage"
    },
    "secondaryLocation": "northcentralus(stage)",
    "statusOfPrimary": "available",
    "statusOfSecondary": "available",
    "supportsHttpsTrafficOnly": false
  },
  "sku": {
    "name": "Standard_GRS",
    "tier": "Standard"
  },
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "type": "Microsoft.Storage/storageAccounts"
}

StorageAccountGetPropertiesCMKEnabled

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596?api-version=2021-09-01

Sample Response

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596",
  "identity": {
    "principalId": "911871cc-ffd1-4fc4-ac11-7a316433ea66",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
    "type": "SystemAssigned"
  },
  "kind": "Storage",
  "location": "eastus2(stage)",
  "name": "sto8596",
  "properties": {
    "geoReplicationStats": {
      "status": "Live",
      "lastSyncTime": "2018-10-30T00:25:34Z",
      "canFailover": true
    },
    "isHnsEnabled": true,
    "creationTime": "2017-06-01T02:42:41.7633306Z",
    "networkAcls": {
      "bypass": "AzureServices",
      "defaultAction": "Allow",
      "ipRules": [],
      "virtualNetworkRules": [],
      "resourceAccessRules": []
    },
    "primaryEndpoints": {
      "web": "https://sto8596.web.core.windows.net/",
      "dfs": "https://sto8596.dfs.core.windows.net/",
      "blob": "https://sto8596.blob.core.windows.net/",
      "file": "https://sto8596.file.core.windows.net/",
      "queue": "https://sto8596.queue.core.windows.net/",
      "table": "https://sto8596.table.core.windows.net/",
      "microsoftEndpoints": {
        "web": "https://sto8596-microsoftrouting.web.core.windows.net/",
        "dfs": "https://sto8596-microsoftrouting.dfs.core.windows.net/",
        "blob": "https://sto8596-microsoftrouting.blob.core.windows.net/",
        "file": "https://sto8596-microsoftrouting.file.core.windows.net/",
        "queue": "https://sto8596-microsoftrouting.queue.core.windows.net/",
        "table": "https://sto8596-microsoftrouting.table.core.windows.net/"
      },
      "internetEndpoints": {
        "web": "https://sto8596-internetrouting.web.core.windows.net/",
        "dfs": "https://sto8596-internetrouting.dfs.core.windows.net/",
        "blob": "https://sto8596-internetrouting.blob.core.windows.net/",
        "file": "https://sto8596-internetrouting.file.core.windows.net/"
      }
    },
    "primaryLocation": "eastus2(stage)",
    "provisioningState": "Succeeded",
    "routingPreference": {
      "routingChoice": "MicrosoftRouting",
      "publishMicrosoftEndpoints": true,
      "publishInternetEndpoints": true
    },
    "encryption": {
      "services": {
        "file": {
          "keyType": "Account",
          "enabled": true,
          "lastEnabledTime": "2019-12-11T20:49:31.7036140Z"
        },
        "blob": {
          "keyType": "Account",
          "enabled": true,
          "lastEnabledTime": "2019-12-11T20:49:31.7036140Z"
        }
      },
      "keySource": "Microsoft.Keyvault",
      "keyvaultproperties": {
        "keyvaulturi": "https://myvault8569.vault.azure.net",
        "keyname": "wrappingKey",
        "keyversion": "",
        "currentVersionedKeyIdentifier": "https://myvault8569.vault.azure.net/keys/wrappingKey/0682afdd9c104f4285df20107e956cad",
        "lastKeyRotationTimestamp": "2019-12-13T20:36:23.7023290Z"
      }
    },
    "secondaryLocation": "northcentralus(stage)",
    "statusOfPrimary": "available",
    "statusOfSecondary": "available",
    "supportsHttpsTrafficOnly": false
  },
  "sku": {
    "name": "Standard_GRS",
    "tier": "Standard"
  },
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "type": "Microsoft.Storage/storageAccounts"
}

StorageAccountGetPropertiesCMKVersionExpirationTime

Sample Request

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596?api-version=2021-09-01

Sample Response

{
  "id": "/subscriptions/{subscription-id}/resourceGroups/res9407/providers/Microsoft.Storage/storageAccounts/sto8596",
  "identity": {
    "principalId": "911871cc-ffd1-4fc4-ac11-7a316433ea66",
    "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47",
    "type": "SystemAssigned"
  },
  "kind": "Storage",
  "location": "eastus2(stage)",
  "name": "sto8596",
  "properties": {
    "geoReplicationStats": {
      "status": "Live",
      "lastSyncTime": "2018-10-30T00:25:34Z",
      "canFailover": true
    },
    "isHnsEnabled": true,
    "creationTime": "2017-06-01T02:42:41.7633306Z",
    "networkAcls": {
      "bypass": "AzureServices",
      "defaultAction": "Allow",
      "ipRules": [],
      "virtualNetworkRules": [],
      "resourceAccessRules": []
    },
    "primaryEndpoints": {
      "web": "https://sto8596.web.core.windows.net/",
      "dfs": "https://sto8596.dfs.core.windows.net/",
      "blob": "https://sto8596.blob.core.windows.net/",
      "file": "https://sto8596.file.core.windows.net/",
      "queue": "https://sto8596.queue.core.windows.net/",
      "table": "https://sto8596.table.core.windows.net/",
      "microsoftEndpoints": {
        "web": "https://sto8596-microsoftrouting.web.core.windows.net/",
        "dfs": "https://sto8596-microsoftrouting.dfs.core.windows.net/",
        "blob": "https://sto8596-microsoftrouting.blob.core.windows.net/",
        "file": "https://sto8596-microsoftrouting.file.core.windows.net/",
        "queue": "https://sto8596-microsoftrouting.queue.core.windows.net/",
        "table": "https://sto8596-microsoftrouting.table.core.windows.net/"
      },
      "internetEndpoints": {
        "web": "https://sto8596-internetrouting.web.core.windows.net/",
        "dfs": "https://sto8596-internetrouting.dfs.core.windows.net/",
        "blob": "https://sto8596-internetrouting.blob.core.windows.net/",
        "file": "https://sto8596-internetrouting.file.core.windows.net/"
      }
    },
    "primaryLocation": "eastus2(stage)",
    "provisioningState": "Succeeded",
    "routingPreference": {
      "routingChoice": "MicrosoftRouting",
      "publishMicrosoftEndpoints": true,
      "publishInternetEndpoints": true
    },
    "encryption": {
      "services": {
        "file": {
          "keyType": "Account",
          "enabled": true,
          "lastEnabledTime": "2019-12-11T20:49:31.7036140Z"
        },
        "blob": {
          "keyType": "Account",
          "enabled": true,
          "lastEnabledTime": "2019-12-11T20:49:31.7036140Z"
        }
      },
      "keySource": "Microsoft.Keyvault",
      "keyvaultproperties": {
        "keyvaulturi": "https://myvault8569.vault.azure.net",
        "keyname": "wrappingKey",
        "keyversion": "",
        "currentVersionedKeyIdentifier": "https://myvault8569.vault.azure.net/keys/wrappingKey/0682afdd9c104f4285df20107e956cad",
        "lastKeyRotationTimestamp": "2019-12-13T20:36:23.7023290Z",
        "currentVersionedKeyExpirationTimestamp": "2019-12-13T20:36:23.7023290Z"
      }
    },
    "secondaryLocation": "northcentralus(stage)",
    "statusOfPrimary": "available",
    "statusOfSecondary": "available",
    "supportsHttpsTrafficOnly": false
  },
  "sku": {
    "name": "Standard_GRS",
    "tier": "Standard"
  },
  "tags": {
    "key1": "value1",
    "key2": "value2"
  },
  "type": "Microsoft.Storage/storageAccounts"
}

定义

AccessTier

类型 = BlobStorage 的存储帐户是必需的。 访问层用于计费。 “高级版”访问层是高级块 Blob 存储帐户类型的默认值,不能更改高级块 Blob 存储帐户类型。

AccountImmutabilityPolicyProperties

这会定义帐户级不可变策略属性。

AccountImmutabilityPolicyState

ImmutabilityPolicy 状态定义策略的模式。 禁用状态会禁用策略,解锁状态允许增加和减少不可变保留时间,还允许切换 allowProtectedAppendWrites 属性,锁定状态仅允许增加不可变保留时间。 策略只能在“已禁用”或“解锁”状态下创建,并且可以在两种状态之间切换。 只有处于“已解锁”状态的策略才能转换为无法还原的锁定状态。

AccountStatus

获取指示存储帐户的主要位置是否可用或不可用的状态。

Action

虚拟网络规则的操作。

ActiveDirectoryProperties

Active Directory (AD) 的设置属性。

AllowedCopyScope

限制在 AAD 租户内或具有指向同一 VNet 的专用链接存储帐户的副本。

AzureFilesIdentityBasedAuthentication

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

BlobRestoreParameters

Blob 还原参数

BlobRestoreProgressStatus

Blob 还原进度的状态。 可能的值包括:- InProgress:指示 Blob 还原正在进行中。 - 完成:指示 Blob 还原已成功完成。 - 失败:指示 Blob 还原失败。

BlobRestoreRange

Blob 范围

BlobRestoreStatus

Blob 还原状态。

Bypass

指定是否为日志记录/指标/AzureServices 绕过流量。 可能的值为日志记录的任意组合|指标|AzureServices (例如,“日志记录、指标”) 或 None,以绕过这些流量。

CustomDomain

分配给此存储帐户的自定义域。 这可以通过更新进行设置。

DefaultAction

指定其他规则匹配时允许或拒绝的默认操作。

DefaultSharePermission

如果未分配 RBAC 角色,则使用 Kerberos 身份验证的用户的默认共享权限。

DirectoryServiceOptions

指示使用的目录服务。

DnsEndpointType

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

Encryption

存储帐户上的加密设置。

EncryptionIdentity

存储帐户的加密标识。

EncryptionService

允许使用服务器端加密的服务。

EncryptionServices

支持加密的服务的列表。

Endpoints

用于对公共 Blob、队列、表、Web 或 dfs 对象执行检索的 URI。

ExpirationAction

SAS 过期操作。 只能是日志。

ExtendedLocation

扩展位置的复杂类型。

ExtendedLocationTypes

扩展位置的类型。

GeoReplicationStats

与存储帐户 Blob、表、队列和文件服务的复制相关的统计信息。 仅当为存储帐户启用异地冗余复制时,才可用。

GeoReplicationStatus

辅助位置的状态。 可能的值包括:-Live:指示辅助位置处于活动状态且可操作。 - 启动:指示从主位置到辅助位置的初始同步正在进行中。这通常在首次启用复制时发生。 - 不可用:指示辅助位置暂时不可用。

Identity

资源的标识。

IdentityType

标识类型。

ImmutableStorageAccount

此属性启用和定义帐户级不可变性。 启用该功能会自动启用 Blob 版本控制。

IPRule

采用 CIDR 格式的特定 IP 或 IP 范围的 IP 规则。

KeyCreationTime

存储帐户密钥创建时间。

KeyPolicy

分配给存储帐户的 KeyPolicy。

KeySource

加密密钥源 (提供程序) 。 可能的值 (不区分大小写) :Microsoft。存储 Microsoft.Keyvault

KeyType

要用于加密服务的加密密钥类型。 “Account”密钥类型意味着将使用帐户范围的加密密钥。 “服务”密钥类型意味着使用默认服务密钥。

KeyVaultProperties

Key Vault 的属性。

Kind

指示存储帐户的类型。

LargeFileSharesState

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

MinimumTlsVersion

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

NetworkRuleSet

网络规则集

PrivateEndpoint

专用终结点资源。

PrivateEndpointConnection

专用终结点连接资源。

PrivateEndpointConnectionProvisioningState

当前预配状态。

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

PrivateLinkServiceConnectionState

有关服务使用者与提供程序之间的连接状态的信息集合。

ProvisioningState

获取调用操作时存储帐户的状态。

PublicNetworkAccess

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

ResourceAccessRule

资源访问规则。

RoutingChoice

路由选择定义用户选择的网络路由类型。

RoutingPreference

路由首选项定义用于传递用户数据的 Microsoft 或 Internet 路由的网络类型,默认选项为 microsoft 路由

SasPolicy

分配给存储帐户的 SasPolicy。

Sku

存储帐户的 SKU。

SkuConversionStatus

此属性指示当前 SKU 转换状态。

SkuName

SKU 名称。 创建帐户时需要;可选,用于更新。 请注意,在旧版本中,SKU 名称称为 accountType。

SkuTier

SKU 层。 这基于 SKU 名称。

State

获取虚拟网络规则的状态。

StorageAccount

存储帐户。

StorageAccountExpand

可用于扩展帐户属性中的属性。 默认情况下,提取属性时不包括数据。 目前,我们仅支持 geoReplicationStats 和 blobRestoreStatus。

StorageAccountInternetEndpoints

用于通过 Internet 路由终结点检索公共 Blob、文件、Web 或 dfs 对象的 URI。

StorageAccountMicrosoftEndpoints

用于通过 Microsoft 路由终结点检索公共 Blob、队列、表、Web 或 dfs 对象的 URI。

StorageAccountSkuConversionStatus

这定义了用于异步 SKU 转换的 SKU 转换状态对象。

UserAssignedIdentity

资源的 UserAssignedIdentity。

VirtualNetworkRule

虚拟网络规则。

AccessTier

类型 = BlobStorage 的存储帐户是必需的。 访问层用于计费。 “高级版”访问层是高级块 Blob 存储帐户类型的默认值,不能更改高级块 Blob 存储帐户类型。

Name Type Description
Cool
  • string
Hot
  • string
Premium
  • string

AccountImmutabilityPolicyProperties

这会定义帐户级不可变策略属性。

Name Type Description
allowProtectedAppendWrites
  • boolean

只能针对已禁用和解锁的基于时间的保留策略更改此属性。 启用后,可将新块写入追加 Blob,同时保持不可变性保护和符合性。 只能添加新块,而不能修改或删除任何现有块。

immutabilityPeriodSinceCreationInDays
  • integer

自创建策略以来,容器中 blob 的不可变性期限(以天为单位)。

state

ImmutabilityPolicy 状态定义策略模式。 禁用状态会禁用策略,解锁状态允许增加和减少不可变性保留时间,还允许切换 allowProtectedAppendWrites 属性,锁定状态仅允许增加不可变保留时间。 策略只能在“已禁用”或“已解锁”状态下创建,并且可以在两种状态之间切换。 只有处于解锁状态的策略才能转换为无法还原的锁定状态。

AccountImmutabilityPolicyState

ImmutabilityPolicy 状态定义策略的模式。 禁用状态会禁用策略,解锁状态允许增加和减少不可变保留时间,还允许切换 allowProtectedAppendWrites 属性,锁定状态仅允许增加不可变保留时间。 策略只能在“已禁用”或“解锁”状态下创建,并且可以在两种状态之间切换。 只有处于“已解锁”状态的策略才能转换为无法还原的锁定状态。

Name Type Description
Disabled
  • string
Locked
  • string
Unlocked
  • string

AccountStatus

获取指示存储帐户的主要位置是否可用或不可用的状态。

Name Type Description
available
  • string
unavailable
  • string

Action

虚拟网络规则的操作。

Name Type Description
Allow
  • string

ActiveDirectoryProperties

Active Directory (AD) 的设置属性。

Name Type Description
accountType enum:
  • Computer
  • User

指定Azure 存储的 Active Directory 帐户类型。

azureStorageSid
  • string

指定Azure 存储的安全标识符 (SID) 。

domainGuid
  • string

指定域 GUID。

domainName
  • string

指定 AD DNS 服务器权威的主域。

domainSid
  • string

指定 SID) (安全标识符。

forestName
  • string

指定要获取的 Active Directory 林。

netBiosDomainName
  • string

指定 NetBIOS 域名。

samAccountName
  • string

为 Azure 存储 指定 Active Directory SAMAccountName。

AllowedCopyScope

限制在 AAD 租户内或具有指向同一 VNet 的专用链接存储帐户的副本。

Name Type Description
AAD
  • string
PrivateLink
  • string

AzureFilesIdentityBasedAuthentication

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

Name Type Description
activeDirectoryProperties

如果选择 AD,则为必需。

defaultSharePermission

如果未分配 RBAC 角色,则使用 Kerberos 身份验证的用户的默认共享权限。

directoryServiceOptions

指示使用的目录服务。

BlobRestoreParameters

Blob 还原参数

Name Type Description
blobRanges

要还原的 Blob 范围。

timeToRestore
  • string

将 Blob 还原到指定时间。

BlobRestoreProgressStatus

Blob 还原进度的状态。 可能的值包括:- InProgress:指示 Blob 还原正在进行中。 - 完成:指示 Blob 还原已成功完成。 - 失败:指示 Blob 还原失败。

Name Type Description
Complete
  • string
Failed
  • string
InProgress
  • string

BlobRestoreRange

Blob 范围

Name Type Description
endRange
  • string

Blob 结束范围。 这是独占的。 空表示帐户结束。

startRange
  • string

Blob 开始范围。 这是包容性的。 空表示帐户启动。

BlobRestoreStatus

Blob 还原状态。

Name Type Description
failureReason
  • string

Blob 还原失败时的失败原因。

parameters

Blob 还原请求参数。

restoreId
  • string

用于跟踪 Blob 还原请求的 ID。

status

Blob 还原进度的状态。 可能的值包括:- InProgress:指示 Blob 还原正在进行中。 - 完成:指示 Blob 还原已成功完成。 - 失败:指示 Blob 还原失败。

Bypass

指定是否为日志记录/指标/AzureServices 绕过流量。 可能的值为日志记录的任意组合|指标|AzureServices (例如,“日志记录、指标”) 或 None,以绕过这些流量。

Name Type Description
AzureServices
  • string
Logging
  • string
Metrics
  • string
None
  • string

CustomDomain

分配给此存储帐户的自定义域。 这可以通过更新进行设置。

Name Type Description
name
  • string

获取或设置分配给存储帐户的自定义域名。 名称是 CNAME 源。

useSubDomainName
  • boolean

指示是否启用间接 CName 验证。 默认值为 false。 这应仅在更新上设置。

DefaultAction

指定其他规则匹配时允许或拒绝的默认操作。

Name Type Description
Allow
  • string
Deny
  • string

DefaultSharePermission

如果未分配 RBAC 角色,则使用 Kerberos 身份验证的用户的默认共享权限。

Name Type Description
None
  • string
StorageFileDataSmbShareContributor
  • string
StorageFileDataSmbShareElevatedContributor
  • string
StorageFileDataSmbShareReader
  • string

DirectoryServiceOptions

指示使用的目录服务。

Name Type Description
AADDS
  • string
AD
  • string
None
  • string

DnsEndpointType

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

Name Type Description
AzureDnsZone
  • string
Standard
  • string

Encryption

存储帐户上的加密设置。

Name Type Default Value Description
identity

用于静态服务端加密的标识。

keySource Microsoft.Storage

加密密钥源 (提供程序) 。 可能的值 (不区分大小写) :Microsoft。存储 Microsoft.Keyvault

keyvaultproperties

Key Vault 提供的属性。

requireInfrastructureEncryption
  • boolean

一个布尔值,指示服务是否使用平台托管密钥对静态数据应用辅助加密层。

services

支持加密的服务列表。

EncryptionIdentity

存储帐户的加密标识。

Name Type Description
federatedIdentityClientId
  • string

要与存储帐户上的跨租户客户托管密钥服务器端加密的用户分配标识结合使用的多租户应用程序的 ClientId。

userAssignedIdentity
  • string

要与存储帐户上的服务器端加密关联的 UserAssigned 标识的资源标识符。

EncryptionService

允许使用服务器端加密的服务。

Name Type Description
enabled
  • boolean

一个布尔值,指示服务是否在存储数据时加密数据。 目前默认启用静态加密,无法禁用。

keyType

要用于加密服务的加密密钥类型。 “Account”密钥类型表示将使用帐户范围的加密密钥。 “服务”密钥类型意味着使用默认服务密钥。

lastEnabledTime
  • string

获取用户上次启用加密时的日期/时间的粗略估计。 默认情况下,数据在静态加密,不能禁用。

EncryptionServices

支持加密的服务的列表。

Name Type Description
blob

Blob 存储服务的加密功能。

file

文件存储服务的加密功能。

queue

队列存储服务的加密功能。

table

表存储服务的加密函数。

Endpoints

用于对公共 Blob、队列、表、Web 或 dfs 对象执行检索的 URI。

Name Type Description
blob
  • string

获取 Blob 终结点。

dfs
  • string

获取 dfs 终结点。

file
  • string

获取文件终结点。

internetEndpoints

获取 Internet 路由存储终结点

microsoftEndpoints

获取 Microsoft 路由存储终结点。

queue
  • string

获取队列终结点。

table
  • string

获取表终结点。

web
  • string

获取 Web 终结点。

ExpirationAction

SAS 过期操作。 只能是日志。

Name Type Description
Log
  • string

ExtendedLocation

扩展位置的复杂类型。

Name Type Description
name
  • string

扩展位置的名称。

type

扩展位置的类型。

ExtendedLocationTypes

扩展位置的类型。

Name Type Description
EdgeZone
  • string

GeoReplicationStats

与存储帐户 Blob、表、队列和文件服务的复制相关的统计信息。 仅当为存储帐户启用异地冗余复制时,才可用。

Name Type Description
canFailover
  • boolean

一个布尔标志,指示帐户是否支持帐户故障转移。

lastSyncTime
  • string

保证此 UTC 日期/时间值前面的所有主写入都可用于读取操作。 在此时间点之后发生的主位置写入信息可能不用于该读操作。 如果 LastSyncTime 的值不可用,则元素可能是默认值,如果辅助副本处于脱机状态或处于启动状态,则可能会发生这种情况。

status

辅助位置的状态。 可能的值包括:-Live:指示辅助位置处于活动状态且可操作。 - 启动:指示从主位置到辅助位置的初始同步正在进行中。这通常在首次启用复制时发生。 - 不可用:指示辅助位置暂时不可用。

GeoReplicationStatus

辅助位置的状态。 可能的值包括:-Live:指示辅助位置处于活动状态且可操作。 - 启动:指示从主位置到辅助位置的初始同步正在进行中。这通常在首次启用复制时发生。 - 不可用:指示辅助位置暂时不可用。

Name Type Description
Bootstrap
  • string
Live
  • string
Unavailable
  • string

Identity

资源的标识。

Name Type Description
principalId
  • string

资源标识的主体 ID。

tenantId
  • string

资源的租户 ID。

type

标识类型。

userAssignedIdentities

获取或设置一个键值对列表,这些值对描述将用于此存储帐户的用户分配标识集。 密钥是标识的 ARM 资源标识符。 此处仅允许 1 个用户分配标识。

IdentityType

标识类型。

Name Type Description
None
  • string
SystemAssigned
  • string
SystemAssigned,UserAssigned
  • string
UserAssigned
  • string

ImmutableStorageAccount

此属性启用和定义帐户级不可变性。 启用该功能会自动启用 Blob 版本控制。

Name Type Description
enabled
  • boolean

一个布尔标志,用于启用帐户级不可变性。 默认情况下,此类帐户下的所有容器都启用了对象级不可变性。

immutabilityPolicy

指定默认帐户级不可变性策略,该策略继承并应用于对象级别不具有显式不可变性策略的对象。 对象级不可变性策略的优先级高于容器级不可变性策略,该策略的优先级高于帐户级不可变性策略。

IPRule

采用 CIDR 格式的特定 IP 或 IP 范围的 IP 规则。

Name Type Default Value Description
action Allow

IP ACL 规则的操作。

value
  • string

以 CIDR 格式指定 IP 或 IP 范围。 仅允许 IPV4 地址。

KeyCreationTime

存储帐户密钥创建时间。

Name Type Description
key1
  • string
key2
  • string

KeyPolicy

分配给存储帐户的 KeyPolicy。

Name Type Description
keyExpirationPeriodInDays
  • integer

密钥过期期限(以天为单位)。

KeySource

加密密钥源 (提供程序) 。 可能的值 (不区分大小写) :Microsoft。存储 Microsoft.Keyvault

Name Type Description
Microsoft.Keyvault
  • string
Microsoft.Storage
  • string

KeyType

要用于加密服务的加密密钥类型。 “Account”密钥类型意味着将使用帐户范围的加密密钥。 “服务”密钥类型意味着使用默认服务密钥。

Name Type Description
Account
  • string
Service
  • string

KeyVaultProperties

Key Vault 的属性。

Name Type Description
currentVersionedKeyExpirationTimestamp
  • string

这是一个只读属性,表示用于加密的客户托管密钥的当前版本的到期时间。

currentVersionedKeyIdentifier
  • string

当前版本控制密钥保管库密钥的对象标识符。

keyname
  • string

KeyVault 密钥的名称。

keyvaulturi
  • string

KeyVault 的 URI。

keyversion
  • string

KeyVault 密钥的版本。

lastKeyRotationTimestamp
  • string

密钥保管库密钥上次轮换的时间戳。

Kind

指示存储帐户的类型。

Name Type Description
BlobStorage
  • string
BlockBlobStorage
  • string
FileStorage
  • string
Storage
  • string
StorageV2
  • string

LargeFileSharesState

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

Name Type Description
Disabled
  • string
Enabled
  • string

MinimumTlsVersion

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

Name Type Description
TLS1_0
  • string
TLS1_1
  • string
TLS1_2
  • string

NetworkRuleSet

网络规则集

Name Type Default Value Description
bypass AzureServices

指定是否为日志记录/指标/AzureServices 绕过流量。 可能的值为日志记录的任意组合|指标|AzureServices (例如,“日志记录、指标”) 或 None,以绕过这些流量。

defaultAction Allow

指定其他规则匹配时允许或拒绝的默认操作。

ipRules

设置 IP ACL 规则

resourceAccessRules

设置资源访问规则

virtualNetworkRules

设置虚拟网络规则

PrivateEndpoint

专用终结点资源。

Name Type Description
id
  • string

专用终结点的 ARM 标识符

PrivateEndpointConnection

专用终结点连接资源。

Name Type Description
id
  • string

资源的完全限定的资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name
  • string

资源的名称

properties.privateEndpoint

专用终结点的资源。

properties.privateLinkServiceConnectionState

有关服务使用者与提供程序之间的连接状态的信息集合。

properties.provisioningState

专用终结点连接资源的预配状态。

type
  • string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft”。存储/storageAccounts”

PrivateEndpointConnectionProvisioningState

当前预配状态。

Name Type Description
Creating
  • string
Deleting
  • string
Failed
  • string
Succeeded
  • string

PrivateEndpointServiceConnectionStatus

专用终结点连接状态。

Name Type Description
Approved
  • string
Pending
  • string
Rejected
  • string

PrivateLinkServiceConnectionState

有关服务使用者与提供程序之间的连接状态的信息集合。

Name Type Description
actionRequired
  • string

一条消息,指示服务提供商上的更改是否需要对使用者进行任何更新。

description
  • string

批准/拒绝连接的原因。

status

指示连接是否已由服务的所有者批准/拒绝/删除。

ProvisioningState

获取调用操作时存储帐户的状态。

Name Type Description
Creating
  • string
ResolvingDNS
  • string
Succeeded
  • string

PublicNetworkAccess

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

Name Type Description
Disabled
  • string
Enabled
  • string

ResourceAccessRule

资源访问规则。

Name Type Description
resourceId
  • string

资源 ID

tenantId
  • string

租户 ID

RoutingChoice

路由选择定义用户选择的网络路由类型。

Name Type Description
InternetRouting
  • string
MicrosoftRouting
  • string

RoutingPreference

路由首选项定义用于传递用户数据的 Microsoft 或 Internet 路由的网络类型,默认选项为 microsoft 路由

Name Type Description
publishInternetEndpoints
  • boolean

一个布尔标志,指示是否发布 Internet 路由存储终结点

publishMicrosoftEndpoints
  • boolean

一个布尔标志,指示是否发布 Microsoft 路由存储终结点

routingChoice

路由选择定义用户选择的网络路由类型。

SasPolicy

分配给存储帐户的 SasPolicy。

Name Type Default Value Description
expirationAction Log

SAS 过期操作。 只能是日志。

sasExpirationPeriod
  • string

SAS 过期期限 DD.HH:MM:SS。

Sku

存储帐户的 SKU。

Name Type Description
name

SKU 名称。 创建帐户时需要;可选,用于更新。 请注意,在旧版本中,SKU 名称称为 accountType。

tier

SKU 层。 这基于 SKU 名称。

SkuConversionStatus

此属性指示当前 SKU 转换状态。

Name Type Description
Failed
  • string
InProgress
  • string
Succeeded
  • string

SkuName

SKU 名称。 创建帐户时需要;可选,用于更新。 请注意,在旧版本中,SKU 名称称为 accountType。

Name Type Description
Premium_LRS
  • string
Premium_ZRS
  • string
Standard_GRS
  • string
Standard_GZRS
  • string
Standard_LRS
  • string
Standard_RAGRS
  • string
Standard_RAGZRS
  • string
Standard_ZRS
  • string

SkuTier

SKU 层。 这基于 SKU 名称。

Name Type Description
Premium
  • string
Standard
  • string

State

获取虚拟网络规则的状态。

Name Type Description
Deprovisioning
  • string
Failed
  • string
NetworkSourceDeleted
  • string
Provisioning
  • string
Succeeded
  • string

StorageAccount

存储帐户。

Name Type Description
extendedLocation

资源的 extendedLocation。

id
  • string

资源的完全限定的资源 ID。 Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

identity

资源的标识。

kind

获取 Kind。

location
  • string

资源所在的地理位置

name
  • string

资源的名称

properties.accessTier

类型 = BlobStorage 的存储帐户是必需的。 访问层用于计费。 “高级版”访问层是高级块 Blob 存储帐户类型的默认值,不能更改高级块 Blob 存储帐户类型。

properties.allowBlobPublicAccess
  • boolean

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

properties.allowCrossTenantReplication
  • boolean

允许或禁止跨 AAD 租户对象复制。 此属性的默认解释为 true。

properties.allowSharedKeyAccess
  • boolean

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

properties.allowedCopyScope

限制在 AAD 租户内或具有指向同一 VNet 的专用链接存储帐户的副本。

properties.azureFilesIdentityBasedAuthentication

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

properties.blobRestoreStatus

Blob 还原状态

properties.creationTime
  • string

获取存储帐户的创建日期和时间(采用 UTC)。

properties.customDomain

获取分配给此存储帐户的用户的自定义域。

properties.defaultToOAuthAuthentication
  • boolean

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

properties.dnsEndpointType

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

properties.encryption

用于存储帐户服务器端加密的加密设置。

properties.failoverInProgress
  • boolean

如果故障转移正在进行,该值将为 true,否则将为 null。

properties.geoReplicationStats

异地复制统计信息

properties.immutableStorageWithVersioning

该属性是不可变的,只能在帐户创建时设置为 true。 设置为 true 时,默认情况下,它将为帐户中的所有容器启用对象级不可变性。

properties.isHnsEnabled
  • boolean

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

properties.isLocalUserEnabled
  • boolean

启用本地用户功能(如果设置为 true)

properties.isNfsV3Enabled
  • boolean

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

properties.isSftpEnabled
  • boolean

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

properties.keyCreationTime

存储帐户密钥创建时间。

properties.keyPolicy

分配给存储帐户的 KeyPolicy。

properties.largeFileSharesState

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

properties.lastGeoFailoverTime
  • string

获取故障转移到辅助位置的最新实例的时间戳。 仅保留最新的时间戳。 如果从未发生故障转移实例,则不会返回此元素。 仅当 accountType Standard_GRS或Standard_RAGRS时才可用。

properties.minimumTlsVersion

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

properties.networkAcls

网络规则集

properties.primaryEndpoints

获取用于对公共 Blob、队列或表对象执行检索的 URL。 请注意,Standard_ZRS和Premium_LRS帐户仅返回 blob 终结点。

properties.primaryLocation
  • string

获取存储帐户的主数据中心的位置。

properties.privateEndpointConnections

与指定存储帐户关联的专用终结点连接列表

properties.provisioningState

获取调用操作时存储帐户的状态。

properties.publicNetworkAccess

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

properties.routingPreference

维护有关用户选择进行数据传输的网络路由选择的信息

properties.sasPolicy

分配给存储帐户的 SasPolicy。

properties.secondaryEndpoints

获取用于从存储帐户的辅助位置检索公共 Blob、队列或表对象的 URL。 仅当 SKU 名称Standard_RAGRS时才可用。

properties.secondaryLocation
  • string

获取存储帐户的异地复制辅助数据库的位置。 仅当 accountType Standard_GRS或Standard_RAGRS时才可用。

properties.statusOfPrimary

获取指示存储帐户的主要位置是否可用或不可用的状态。

properties.statusOfSecondary

获取指示存储帐户的辅助位置是否可用或不可用的状态。 仅当 SKU 名称Standard_GRS或Standard_RAGRS时才可用。

properties.storageAccountSkuConversionStatus

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

properties.supportsHttpsTrafficOnly
  • boolean

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

sku

获取 SKU。

tags
  • object

资源标记。

type
  • string

资源类型。 例如“Microsoft.Compute/virtualMachines”或“Microsoft”。存储/storageAccounts”

StorageAccountExpand

可用于扩展帐户属性中的属性。 默认情况下,提取属性时不包括数据。 目前,我们仅支持 geoReplicationStats 和 blobRestoreStatus。

Name Type Description
blobRestoreStatus
  • string
geoReplicationStats
  • string

StorageAccountInternetEndpoints

用于通过 Internet 路由终结点检索公共 Blob、文件、Web 或 dfs 对象的 URI。

Name Type Description
blob
  • string

获取 Blob 终结点。

dfs
  • string

获取 dfs 终结点。

file
  • string

获取文件终结点。

web
  • string

获取 Web 终结点。

StorageAccountMicrosoftEndpoints

用于通过 Microsoft 路由终结点检索公共 Blob、队列、表、Web 或 dfs 对象的 URI。

Name Type Description
blob
  • string

获取 Blob 终结点。

dfs
  • string

获取 dfs 终结点。

file
  • string

获取文件终结点。

queue
  • string

获取队列终结点。

table
  • string

获取表终结点。

web
  • string

获取 Web 终结点。

StorageAccountSkuConversionStatus

这定义了用于异步 SKU 转换的 SKU 转换状态对象。

Name Type Description
endTime
  • string

此属性表示 SKU 转换结束时间。

skuConversionStatus

此属性指示当前 SKU 转换状态。

startTime
  • string

此属性表示 SKU 转换开始时间。

targetSkuName

此属性表示帐户 SKU 异步转换为的目标 SKU 名称。

UserAssignedIdentity

资源的 UserAssignedIdentity。

Name Type Description
clientId
  • string

标识的客户端 ID。

principalId
  • string

标识的主体 ID。

VirtualNetworkRule

虚拟网络规则。

Name Type Default Value Description
action Allow

虚拟网络规则的操作。

id
  • string

子网的资源 ID,例如:/subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{vnetName}/subnets/{subnetName}。

state

获取虚拟网络规则的状态。