@azure/arm-storage package
接口
类型别名
| AccessTier |
存储账户中块的默认访问权限层。 类型 = BlobStorage 的存储帐户是必需的。 有关详细信息,请参阅:https://learn.microsoft.com/azure/storage/blobs/access-tiers-overview。 |
| AccountImmutabilityPolicyState |
ImmutabilityPolicy 状态定义策略模式。 禁用状态会禁用策略,解锁状态允许增加和减少不可变保留时间,还允许切换 allowProtectedAppendWrites 属性,锁定状态仅允许增加不可变保留时间。 策略只能在“已禁用”或“已解锁”状态下创建,并且可以在两种状态之间切换。 只有处于解锁状态的策略才能转换为无法还原的锁定状态。 服务支持的已知值已解锁 |
| AccountStatus |
获取状态,该状态指示存储帐户的主位置是可用还是不可用。 |
| AccountType |
指定 Azure 存储的 Active Directory 帐户类型。 如果 directoryServiceOptions 设置为 AD (AD DS 身份验证),则此属性是可选的。 如果提供,还应提供 samAccountName。 对于 directoryServiceOptions AADDS (Entra DS 身份验证) 或 AADKERB (Entra 身份验证) ,可以省略此属性。 服务支持的已知值
用户 |
| AllowedCopyScope |
限制对 AAD 租户中的存储帐户或同一 VNet 的专用链接的复制和从中复制。 服务支持的已知值
PrivateLink |
| AllowedMethods |
允许方法类型 |
| AzureSupportedClouds |
云设置为字符串文字类型的支持值 |
| BlobInventoryPolicyName |
BlobInventoryPolicyName 类型 |
| BlobRestoreProgressStatus |
blob 还原进度的状态。 可能的值包括:- InProgress:指示 blob 还原正在进行中。 - 完成:指示 blob 还原已成功完成。 - 失败:指示 blob 还原失败。 服务支持的已知值
InProgress |
| Bypass |
指定是否为日志记录/指标/AzureServices 绕过流量。 可能的值是日志记录的任意组合 |指标 |AzureServices(例如,“日志记录、指标”)或“无”以绕过这些流量。 服务支持的已知值
没有 |
| ContinuablePage |
描述结果页的接口。 |
| CreatedByType |
创建资源的实体类型。 服务支持的已知值
用户:实体是由用户创建的。 |
| DefaultAction |
指定其他规则匹配时允许或拒绝的默认操作。 |
| DefaultSharePermission |
如果未分配 RBAC 角色,则使用 Kerberos 身份验证的用户的默认共享权限。 服务支持的已知值
没有 |
| DirectoryServiceOptions |
指示使用的目录服务。 请注意,将来可能会扩展此枚举。 服务支持的已知值
没有 |
| DnsEndpointType |
允许指定终结点的类型。 将此设置为 AzureDNSZone 以在单个订阅中创建大量帐户,该订阅在 Azure DNS 区域中创建帐户,终结点 URL 将具有字母数字 DNS 区域标识符。 服务支持的已知值
标准 |
| EnabledProtocols |
用于文件共享的身份验证协议。 只能在创建共享时指定。 服务支持的已知值
SMB |
| EncryptionScopeSource |
加密范围的提供程序。 可能的值(不区分大小写):Microsoft.Storage,Microsoft.KeyVault。 服务支持的已知值
Microsoft.Storage |
| EncryptionScopeState |
加密范围的状态。 可能的值(不区分大小写):已启用、禁用。 服务支持的已知值已启用 |
| ExpirationAction |
SAS 过期作定义违反 sasPolicy.sasExpirationPeriod 时要执行的作。 “日志”作可用于审核目的,“阻止”作可用于阻止和拒绝使用不符合 SAS 策略过期期限的 SAS 令牌。 服务支持的已知值
日志 |
| ExtendedLocationTypes |
extendedLocation 的类型。 服务支持的已知值EdgeZone |
| Format |
这是必填字段,它指定清单文件的格式。 服务支持的已知值
Csv |
| GeoReplicationStatus |
辅助位置的状态。 可能的值包括:- 实时:指示辅助位置处于活动状态且可作。 - 引导:表示从主位置到辅助位置的初始同步正在进行中。这通常在首次启用复制时发生。 - 不可用:表示辅助位置暂时不可用。 服务支持的已知值
住 |
| HttpProtocol |
协议允许使用帐户 SAS 发出请求。 |
| IdentityType |
标识类型。 服务支持的已知值
没有 |
| ImmutabilityPolicyState |
Blob 容器的 ImmutabilityPolicy 状态,可能的值包括:已锁定和已解锁。 服务支持的已知值锁定 |
| ImmutabilityPolicyUpdateType |
blob 容器的 ImmutabilityPolicy 更新类型,可能的值包括:put、lock 和 extend。 服务支持的已知值
放 |
| IntervalUnit |
运行任务执行的间隔单位。 当 ExecutionTrigger.properties.type 为“OnSchedule”时,这是必填字段;当 ExecutionTrigger.properties.type 是 'RunOnce' 时,该属性不应存在 服务支持的已知值天数 |
| InventoryRuleType |
有效值为库存 服务支持的已知值库存 |
| IssueType |
问题类型 服务支持的已知值
未知 |
| KeyPermission |
密钥的权限 -- 只读或完全权限。 |
| KeySource |
加密密钥来源(提供程序)。 可能值(不区分大小写):Microsoft。存储,Microsoft。钥匙库 服务支持的已知值
Microsoft.Storage |
| KeyType |
要用于加密服务的加密密钥类型。 “Account”密钥类型意味着将使用帐户范围的加密密钥。 “服务”密钥类型意味着使用默认服务密钥。 服务支持的已知值
服务 |
| Kind |
指示存储帐户的类型。 服务支持的已知值
存储 |
| LargeFileSharesState |
如果设置为“已启用”,则允许大型文件共享。 启用后,无法禁用它。 服务支持的已知值
禁用 |
| LeaseContainerRequestAction |
指定租赁作。 可以是可用作之一。 服务支持的已知值
获得 |
| LeaseDuration |
指定容器上的租约是无限期还是固定期,仅在租用容器时。 服务支持的已知值
无限 |
| LeaseShareAction |
指定租赁作。 可以是可用作之一。 服务支持的已知值
获得 |
| LeaseState |
容器的租约状态。 服务支持的已知值
可用 |
| LeaseStatus |
容器的租赁状态。 服务支持的已知值锁定 |
| ListContainersInclude |
列表容器类型包括 |
| ListEncryptionScopesInclude |
列表类型加密范围包括 |
| ListLocalUserIncludeParam |
List LocalUserIncludeParam 类型 |
| ManagementPolicyName |
管理类型政策名称 |
| MigrationName |
迁移类型名称 |
| MigrationState |
此属性表示容器级别的不变性到对象级不变性迁移状态。 服务支持的已知值
InProgress |
| MigrationStatus |
移民现状 服务支持的已知值
无效 |
| MinimumTlsVersion |
设置对存储的请求允许的最低 TLS 版本。 对于此属性,默认解释为 TLS 1.0。 不支持最低TLS 1.3版本。 服务支持的已知值
TLS1_0 |
| Name |
策略的名称。 有效值为 AccessTimeTracking。 该字段目前为只读 服务支持的已知值AccessTimeTracking |
| NativeDataSharingProvisioningState |
调用作时资源的配置状态。 服务支持的已知值
接受:请求已被接受处理。 |
| NetworkSecurityPerimeterConfigurationProvisioningState |
网络安全边界配置传播的配置状态 服务支持的已知值已接受 |
| NspAccessRuleDirection |
访问方向规则 服务支持的已知值
入境 |
| ObjectType |
这是必填字段。 此字段指定在 Blob 或容器级别创建的清单的范围。 服务支持的已知值
Blob |
| Permissions |
帐户 SAS 的签名权限。 可能的值包括:读取 (r)、写入 (w)、删除 (d)、列表 (l)、添加 (a)、创建 (c)、更新 (u) 和处理 (p)。 服务支持的已知值
r |
| PostFailoverRedundancy |
执行帐户故障转移后帐户的冗余类型。 服务支持的已知值
Standard_LRS |
| PostPlannedFailoverRedundancy |
执行计划内帐户故障转移后帐户的冗余类型。 服务支持的已知值
Standard_GRS |
| PrivateEndpointConnectionProvisioningState |
当前预配状态。 服务支持的已知值
成功 |
| PrivateEndpointServiceConnectionStatus |
专用终结点连接状态。 服务支持的已知值
待定 |
| ProvisioningState |
获取调用作时存储帐户的状态。 |
| PublicAccess |
指定是否可以公开访问容器中的数据和访问级别。 |
| PublicNetworkAccess |
允许、禁止或允许网络安全外围配置评估对存储帐户的公共网络访问。 值是可选的,但如果传入,则必须为“Enabled”、“Disabled”或“SecuredByPerimeter”。 服务支持的已知值已启用 |
| Reason |
获取无法使用存储帐户名称的原因。 仅当 NameAvailable 为 false 时,才会返回 Reason 元素。 |
| ReasonCode |
限制的原因。 到目前为止,这可以是“QuotaId”或“NotAvailableForSubscription”。 当 SKU 具有 requiredQuotas 参数(因为订阅不属于该配额)时,将设置配额 ID。 “NotAvailableForSubscription”与 DC 的容量相关。 服务支持的已知值
QuotaId |
| ResourceAssociationAccessMode |
资源关联的访问模式 服务支持的已知值
强制 |
| RootSquashType |
该属性仅适用于 NFS 共享。 默认值为 NoRootSquash。 服务支持的已知值
NoRootSquash |
| RoutingChoice |
路由选择定义用户选择的网络路由类型。 服务支持的已知值
MicrosoftRouting |
| RuleType |
有效值为生命周期 服务支持的已知值生命周期 |
| RunResult |
表示执行实例的整体执行结果 服务支持的已知值
成功 |
| RunStatusEnum |
表示执行状态。 服务支持的已知值
InProgress |
| Schedule |
这是必填字段。 此字段用于计划库存形成。 服务支持的已知值
日常 |
| Services |
可通过帐户 SAS 访问的签名服务。 可能的值包括:Blob (b)、队列 (q)、表 (t)、文件 (f)。 服务支持的已知值
b |
| Severity |
问题的严重性。 服务支持的已知值
警告 |
| ShareAccessTier |
特定共享的访问层。 GpV2 帐户可以在 TransactionOptimized(默认)、热和冷之间进行选择。 FileStorage 帐户可以选择“高级”。 服务支持的已知值
TransactionOptimized |
| SignedResource |
可通过服务 SAS 访问的签名服务。 可能的值包括:Blob (b)、容器 (c)、文件 (f)、共享 (s)。 服务支持的已知值
b |
| SignedResourceTypes |
可通过帐户 SAS 访问的已签名资源类型。 服务:访问服务级别 API;容器(c):访问容器级API;对象 (o):访问 blob、队列消息、表实体和文件的对象级 API。 服务支持的已知值
s |
| SkuConversionStatus |
此属性指示当前 SKU 转换状态。 服务支持的已知值
InProgress |
| SkuName |
SKU 名称。 创建帐户时需要;可选,用于更新。 请注意,在旧版本中,SKU 名称称为 accountType。 服务支持的已知值
Standard_LRS |
| SkuTier |
SKU 层级。 这基于 SKU 名称。 |
| State |
获取虚拟网络规则的状态。 服务支持的已知值
预配 |
| StorageAccountExpand |
存储类型账户扩展 |
| StorageConnectorAuthPropertiesUnion |
Alias for StorageConnectorAuthPropertiesUnion |
| StorageConnectorAuthPropertiesUpdateUnion |
Alias for StorageConnectorAuthPropertiesUpdateUnion |
| StorageConnectorAuthType |
认证类型支持存储连接器中的桶连接。 服务支持的已知值ManagedIdentity:托管身份认证类型 |
| StorageConnectorConnectionType |
存储连接器中桶连接的连接类型。 服务支持的已知值DataShare:DataShare 连接类型 |
| StorageConnectorConnectionUnion |
StorageConnectorConnectionUnion 的别名 |
| StorageConnectorDataSourceType |
存储连接器的后备数据源类型 服务支持的已知值Azure_DataShare:Azure DataShare 数据源类型。 |
| StorageConnectorSourceType |
存储连接器的后备数据源类型 服务支持的已知值DataShare:源类型 - DataShare |
| StorageConnectorSourceUnion |
StorageConnectorSourceUnion 的别名 |
| StorageConnectorSourceUpdateUnion |
Alias for StorageConnectorSourceUpdateUnion |
| StorageConnectorState |
存储连接器的状态 服务支持的已知值
激活:连接器是否处于激活状态 |
| StorageDataShareAccessPolicyPermission |
存储数据共享访问策略支持的权限 服务支持的已知值
无:无许可 |
| StorageTaskAssignmentProvisioningState |
获取调用作时存储帐户的状态。 服务支持的已知值
验证订阅配额开始 |
| TriggerType |
存储任务分配执行的触发类型 服务支持的已知值
运行一次 |
| UsageUnit |
获取度量单位。 |
| ZonePlacementPolicy |
存储帐户的可用区固定策略。 服务支持的已知值
任意 |
枚举
| AzureClouds |
一个用来描述Azure云环境的enum。 |
| KnownAccountImmutabilityPolicyState |
ImmutabilityPolicy 状态定义策略模式。 禁用状态会禁用策略,解锁状态允许增加和减少不可变保留时间,还允许切换 allowProtectedAppendWrites 属性,锁定状态仅允许增加不可变保留时间。 策略只能在“已禁用”或“已解锁”状态下创建,并且可以在两种状态之间切换。 只有处于解锁状态的策略才能转换为无法还原的锁定状态。 |
| KnownAccountType |
指定 Azure 存储的 Active Directory 帐户类型。 如果 directoryServiceOptions 设置为 AD (AD DS 身份验证),则此属性是可选的。 如果提供,还应提供 samAccountName。 对于 directoryServiceOptions AADDS (Entra DS 身份验证) 或 AADKERB (Entra 身份验证) ,可以省略此属性。 |
| KnownAllowedCopyScope |
限制对 AAD 租户中的存储帐户或同一 VNet 的专用链接的复制和从中复制。 |
| KnownAllowedMethods |
服务的 AllowedMethods 的已知值。 |
| KnownBlobInventoryPolicyName |
服务接受的 BlobInventoryPolicyName 的已知值。 |
| KnownBlobRestoreProgressStatus |
blob 还原进度的状态。 可能的值包括:- InProgress:指示 blob 还原正在进行中。 - 完成:指示 blob 还原已成功完成。 - 失败:指示 blob 还原失败。 |
| KnownBypass |
指定是否为日志记录/指标/AzureServices 绕过流量。 可能的值是日志记录的任意组合 |指标 |AzureServices(例如,“日志记录、指标”)或“无”以绕过这些流量。 |
| KnownCreatedByType |
创建资源的实体类型。 |
| KnownDefaultSharePermission |
如果未分配 RBAC 角色,则使用 Kerberos 身份验证的用户的默认共享权限。 |
| KnownDirectoryServiceOptions |
指示使用的目录服务。 请注意,将来可能会扩展此枚举。 |
| KnownDnsEndpointType |
允许指定终结点的类型。 将此设置为 AzureDNSZone 以在单个订阅中创建大量帐户,该订阅在 Azure DNS 区域中创建帐户,终结点 URL 将具有字母数字 DNS 区域标识符。 |
| KnownEnabledProtocols |
用于文件共享的身份验证协议。 只能在创建共享时指定。 |
| KnownEncryptionScopeSource |
加密范围的提供程序。 可能的值(不区分大小写):Microsoft.Storage,Microsoft.KeyVault。 |
| KnownEncryptionScopeState |
加密范围的状态。 可能的值(不区分大小写):已启用、禁用。 |
| KnownExpirationAction |
SAS 过期作定义违反 sasPolicy.sasExpirationPeriod 时要执行的作。 “日志”作可用于审核目的,“阻止”作可用于阻止和拒绝使用不符合 SAS 策略过期期限的 SAS 令牌。 |
| KnownExtendedLocationTypes |
extendedLocation 的类型。 |
| KnownFormat |
这是必填字段,它指定清单文件的格式。 |
| KnownGeoReplicationStatus |
辅助位置的状态。 可能的值包括:- 实时:指示辅助位置处于活动状态且可作。 - 引导:表示从主位置到辅助位置的初始同步正在进行中。这通常在首次启用复制时发生。 - 不可用:表示辅助位置暂时不可用。 |
| KnownIdentityType |
标识类型。 |
| KnownImmutabilityPolicyState |
Blob 容器的 ImmutabilityPolicy 状态,可能的值包括:已锁定和已解锁。 |
| KnownImmutabilityPolicyUpdateType |
blob 容器的 ImmutabilityPolicy 更新类型,可能的值包括:put、lock 和 extend。 |
| KnownIntervalUnit |
运行任务执行的间隔单位。 当 ExecutionTrigger.properties.type 为“OnSchedule”时,这是必填字段;当 ExecutionTrigger.properties.type 为“RunOnce”时,此属性不应存在 |
| KnownInventoryRuleType |
有效值为 Inventory |
| KnownIssueType |
问题类型 |
| KnownKeySource |
加密密钥来源(提供程序)。 可能的值(不区分大小写):Microsoft.Storage、Microsoft.Keyvault |
| KnownKeyType |
要用于加密服务的加密密钥类型。 “Account”密钥类型意味着将使用帐户范围的加密密钥。 “服务”密钥类型意味着使用默认服务密钥。 |
| KnownKind |
指示存储帐户的类型。 |
| KnownLargeFileSharesState |
如果设置为“已启用”,则允许大型文件共享。 启用后,无法禁用它。 |
| KnownLeaseContainerRequestAction |
指定租赁作。 可以是可用作之一。 |
| KnownLeaseDuration |
指定容器上的租约是无限期还是固定期,仅在租用容器时。 |
| KnownLeaseShareAction |
指定租赁作。 可以是可用作之一。 |
| KnownLeaseState |
容器的租约状态。 |
| KnownLeaseStatus |
容器的租赁状态。 |
| KnownListContainersInclude |
服务接受的 ListContainersInclude 的已知值。 |
| KnownListEncryptionScopesInclude |
服务接受的 ListEncryptionScopesInclude 的已知值。 |
| KnownListLocalUserIncludeParam |
服务接受的 ListLocalUserIncludeParam 的已知值。 |
| KnownManagementPolicyName |
服务的 ManagementPolicyName 的已知值。 |
| KnownMigrationName |
服务的 MigrationName 的已知值。 |
| KnownMigrationState |
此属性表示容器级别的不变性到对象级不变性迁移状态。 |
| KnownMigrationStatus |
迁移的当前状态 |
| KnownMinimumTlsVersion |
设置对存储的请求允许的最低 TLS 版本。 对于此属性,默认解释为 TLS 1.0。 不支持最低TLS 1.3版本。 |
| KnownName |
策略的名称。 有效值为 AccessTimeTracking。 此字段当前为只读 |
| KnownNativeDataSharingProvisioningState |
调用作时资源的配置状态。 |
| KnownNetworkSecurityPerimeterConfigurationProvisioningState |
网络安全外围配置传播的预配状态 |
| KnownNspAccessRuleDirection |
访问方向规则 |
| KnownObjectType |
这是必填字段。 此字段指定在 Blob 或容器级别创建的清单的范围。 |
| KnownPermissions |
帐户 SAS 的签名权限。 可能的值包括:读取 (r)、写入 (w)、删除 (d)、列表 (l)、添加 (a)、创建 (c)、更新 (u) 和处理 (p)。 |
| KnownPostFailoverRedundancy |
执行帐户故障转移后帐户的冗余类型。 |
| KnownPostPlannedFailoverRedundancy |
执行计划内帐户故障转移后帐户的冗余类型。 |
| KnownPrivateEndpointConnectionProvisioningState |
当前预配状态。 |
| KnownPrivateEndpointServiceConnectionStatus |
专用终结点连接状态。 |
| KnownPublicNetworkAccess |
允许、禁止或允许网络安全外围配置评估对存储帐户的公共网络访问。 值是可选的,但如果传入,则必须为“Enabled”、“Disabled”或“SecuredByPerimeter”。 |
| KnownReasonCode |
限制的原因。 到目前为止,这可以是“QuotaId”或“NotAvailableForSubscription”。 当 SKU 具有 requiredQuotas 参数(因为订阅不属于该配额)时,将设置配额 ID。 “NotAvailableForSubscription”与 DC 的容量相关。 |
| KnownResourceAssociationAccessMode |
资源关联的访问模式 |
| KnownRootSquashType |
该属性仅适用于 NFS 共享。 默认值为 NoRootSquash。 |
| KnownRoutingChoice |
路由选择定义用户选择的网络路由类型。 |
| KnownRuleType |
有效值为生命周期 |
| KnownRunResult |
表示运行实例执行的总体结果 |
| KnownRunStatusEnum |
表示执行状态。 |
| KnownSchedule |
这是必填字段。 此字段用于计划库存形成。 |
| KnownServices |
可通过帐户 SAS 访问的签名服务。 可能的值包括:Blob (b)、队列 (q)、表 (t)、文件 (f)。 |
| KnownSeverity |
问题的严重性。 |
| KnownShareAccessTier |
特定共享的访问层。 GpV2 帐户可以在 TransactionOptimized(默认)、热和冷之间进行选择。 FileStorage 帐户可以选择“高级”。 |
| KnownSignedResource |
可通过服务 SAS 访问的签名服务。 可能的值包括:Blob (b)、容器 (c)、文件 (f)、共享 (s)。 |
| KnownSignedResourceTypes |
可通过帐户 SAS 访问的已签名资源类型。 服务:访问服务级别 API;容器(c):访问容器级API;对象 (o):访问 blob、队列消息、表实体和文件的对象级 API。 |
| KnownSkuConversionStatus |
此属性指示当前 SKU 转换状态。 |
| KnownSkuName |
SKU 名称。 创建帐户时需要;可选,用于更新。 请注意,在旧版本中,SKU 名称称为 accountType。 |
| KnownState |
获取虚拟网络规则的状态。 |
| KnownStorageConnectorAuthType |
认证类型支持存储连接器中的桶连接。 |
| KnownStorageConnectorConnectionType |
存储连接器中桶连接的连接类型。 |
| KnownStorageConnectorDataSourceType |
存储连接器的后备数据源类型 |
| KnownStorageConnectorSourceType |
存储连接器的后备数据源类型 |
| KnownStorageConnectorState |
存储连接器的状态 |
| KnownStorageDataShareAccessPolicyPermission |
存储数据共享访问策略支持的权限 |
| KnownStorageTaskAssignmentProvisioningState |
获取调用作时存储帐户的状态。 |
| KnownTriggerType |
存储任务分配执行的触发器类型 |
| KnownVersions |
可用的 API 版本。 |
| KnownZonePlacementPolicy |
存储帐户的可用区固定策略。 |
函数
| is |
RestError 的 Typeguard |
| restore |
从另一轮询程序的序列化状态创建轮询器。 如果要在不同的主机上创建轮询器,或者在原始轮询器不在范围内后构造轮询器,这非常有用。 |
变量
| Rest |
失败管道请求的自定义错误类型。 |
函数详细信息
isRestError(unknown)
RestError 的 Typeguard
function isRestError(e: unknown): e
参数
- e
-
unknown
catch 子句捕获的内容。
返回
e
restorePoller<TResponse, TResult>(StorageManagementClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)
从另一轮询程序的序列化状态创建轮询器。 如果要在不同的主机上创建轮询器,或者在原始轮询器不在范围内后构造轮询器,这非常有用。
function restorePoller<TResponse, TResult>(client: StorageManagementClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>
参数
- client
- StorageManagementClient
- serializedState
-
string
- sourceOperation
-
(args: any[]) => PollerLike<OperationState<TResult>, TResult>
- options
-
RestorePollerOptions<TResult, PathUncheckedResponse>
返回
PollerLike<OperationState<TResult>, TResult>