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

@azure/arm-resourcesdeploymentstacks package

接口

ActionOnUnmanage

定义在更新或删除堆栈后不再管理的资源的行为。

DenySettings

定义部署堆栈部署的资源被锁定的方式。

DeploymentExtension

关于部署扩展使用的详细信息。

DeploymentExtensionConfig

部署扩展的配置。 该对象的键应与扩展配置模式保持一致。

DeploymentExtensionConfigItem

关于扩展配置属性的值或如何获得一个值。

DeploymentExternalInput

部署外部输入以进行参数化。

DeploymentExternalInputDefinition

部署用于参数化的外部输入定义。

DeploymentParameter

模板的部署参数。

DeploymentStack

部署堆栈对象。

DeploymentStackProperties

部署堆栈属性。

DeploymentStackTemplateDefinition

导出部署堆栈的模板特定属性。

DeploymentStackValidateProperties

部署堆栈验证结果详细信息。

DeploymentStackValidateResult

部署堆栈验证结果。

DeploymentStacksChangeBase

带有前后属性值的房产基础模型。

DeploymentStacksChangeBaseDenyStatusMode

带有前后属性值的房产基础模型。

DeploymentStacksChangeBaseDeploymentStacksManagementStatus

带有前后属性值的房产基础模型。

DeploymentStacksChangeDeltaDenySettings

模型显示房产前后价值及其间的差异。

DeploymentStacksChangeDeltaRecord

模型显示房产前后价值及其间的差异。

DeploymentStacksClientOptionalParams

客户端的可选参数。

DeploymentStacksCreateOrUpdateAtManagementGroupOptionalParams

可选参数。

DeploymentStacksCreateOrUpdateAtResourceGroupOptionalParams

可选参数。

DeploymentStacksCreateOrUpdateAtSubscriptionOptionalParams

可选参数。

DeploymentStacksDebugSetting

调试设置。

DeploymentStacksDeleteAtManagementGroupOptionalParams

可选参数。

DeploymentStacksDeleteAtResourceGroupOptionalParams

可选参数。

DeploymentStacksDeleteAtSubscriptionOptionalParams

可选参数。

DeploymentStacksDiagnostic

错误补充信息

DeploymentStacksExportTemplateAtManagementGroupOptionalParams

可选参数。

DeploymentStacksExportTemplateAtResourceGroupOptionalParams

可选参数。

DeploymentStacksExportTemplateAtSubscriptionOptionalParams

可选参数。

DeploymentStacksGetAtManagementGroupOptionalParams

可选参数。

DeploymentStacksGetAtResourceGroupOptionalParams

可选参数。

DeploymentStacksGetAtSubscriptionOptionalParams

可选参数。

DeploymentStacksListAtManagementGroupOptionalParams

可选参数。

DeploymentStacksListAtResourceGroupOptionalParams

可选参数。

DeploymentStacksListAtSubscriptionOptionalParams

可选参数。

DeploymentStacksOperations

表示部署堆栈操作的接口。

DeploymentStacksParametersLink

表示对部署参数的引用的实体。

DeploymentStacksTemplateLink

表示对模板的引用的实体。

DeploymentStacksValidateStackAtManagementGroupOptionalParams

可选参数。

DeploymentStacksValidateStackAtResourceGroupOptionalParams

可选参数。

DeploymentStacksValidateStackAtSubscriptionOptionalParams

可选参数。

DeploymentStacksWhatIfChange

假设操作预测部署堆栈的变化。

DeploymentStacksWhatIfPropertyChange

对资源属性的预测更改。

DeploymentStacksWhatIfResourceChange

有关 What-If作预测的单个资源更改的信息。

DeploymentStacksWhatIfResult

部署堆栈对象。

DeploymentStacksWhatIfResultProperties

DeploymentStack WhatIfResult 属性

DeploymentStacksWhatIfResultsAtManagementGroupCreateOrUpdateOptionalParams

可选参数。

DeploymentStacksWhatIfResultsAtManagementGroupDeleteOptionalParams

可选参数。

DeploymentStacksWhatIfResultsAtManagementGroupGetOptionalParams

可选参数。

DeploymentStacksWhatIfResultsAtManagementGroupListOptionalParams

可选参数。

DeploymentStacksWhatIfResultsAtManagementGroupOperations

表示部署的接口:StacksWhatIfResultsAtManagementGroup 操作。

DeploymentStacksWhatIfResultsAtManagementGroupWhatIfOptionalParams

可选参数。

DeploymentStacksWhatIfResultsAtResourceGroupCreateOrUpdateOptionalParams

可选参数。

DeploymentStacksWhatIfResultsAtResourceGroupDeleteOptionalParams

可选参数。

DeploymentStacksWhatIfResultsAtResourceGroupGetOptionalParams

可选参数。

DeploymentStacksWhatIfResultsAtResourceGroupListOptionalParams

可选参数。

DeploymentStacksWhatIfResultsAtResourceGroupOperations

表示DeploymentStacksWhatIfResultsAtResourceGroup操作的接口。

DeploymentStacksWhatIfResultsAtResourceGroupWhatIfOptionalParams

可选参数。

DeploymentStacksWhatIfResultsAtSubscriptionCreateOrUpdateOptionalParams

可选参数。

DeploymentStacksWhatIfResultsAtSubscriptionDeleteOptionalParams

可选参数。

DeploymentStacksWhatIfResultsAtSubscriptionGetOptionalParams

可选参数。

DeploymentStacksWhatIfResultsAtSubscriptionListOptionalParams

可选参数。

DeploymentStacksWhatIfResultsAtSubscriptionOperations

表示部署的接口:StacksWhatIfResultsAtSubscription操作。

DeploymentStacksWhatIfResultsAtSubscriptionWhatIfOptionalParams

可选参数。

ErrorAdditionalInfo

资源管理错误附加信息。

ErrorDetail

错误详细信息。

ErrorResponse

所有 Azure 资源管理器 API 的通用错误响应,用于返回失败操作的错误细节。

KeyVaultParameterReference

Azure 密钥保管库 参数引用。

KeyVaultReference

Azure 密钥保管库 参考。

ManagedResourceReference

托管资源模型。

PageSettings

byPage 方法的选项

PagedAsyncIterableIterator

允许异步迭代到完成和逐页迭代的接口。

ProxyResource

Azure 资源管理器代理资源的资源模型定义。 它不具有标记和位置

Resource

所有 Azure 资源管理器资源的响应中返回的常见字段

ResourceReference

resourceId 模型。

ResourceReferenceExtended

resourceId 扩展模型。 这用于记录 resourceId 和相应错误的失败资源。

RestorePollerOptions
SimplePollerLike

可用于轮询长时间运行的操作的简单轮询程序。

SystemData

与创建和上次修改资源相关的元数据。

类型别名

AzureSupportedClouds

云设置为字符串文字类型的支持值

ContinuablePage

描述结果页的接口。

CreatedByType

创建资源的实体类型。
KnownCreatedByType 可与 CreatedByType 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

用户:实体是由用户创建的。
应用程序:实体是由应用程序创建的。
ManagedIdentity:实体是由托管标识创建的。
密钥:实体是由密钥创建的。

DenySettingsMode

denySettings 模式,用于定义被拒绝的作。
KnownDenySettingsMode 可与 DenySettingsMode 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

denyDelete:授权用户能够读取和修改资源,但无法删除。
denyWriteAndDelete:授权用户可以从资源读取,但无法修改或删除它。
:未应用 denyAssignments。

DenyStatusMode

应用于资源的 denyAssignment 设置。
KnownDenyStatusMode 可与 DenyStatusMode 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

denyDelete:授权用户能够读取和修改资源,但无法删除。
notSupported:资源类型不支持 denyAssignments。
不可应用:部署堆栈范围之外的资源不支持 denyAssignments。
denyWriteAndDelete:授权用户只能从资源读取,但不能修改或删除它。
removedBySystem:由于资源管理更改(管理组移动等),Azure 已删除拒绝分配。
:未应用 denyAssignments。
未知:拒绝分配状态未知。

DeploymentStackProvisioningState

部署堆栈的状态。
KnownDeploymentStackProvisioningState 可与 DeploymentStackProvisioningState 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

创建:部署栈正在创建中
验证中:部署栈目前正在验证中
等待中:部署堆栈目前正在等待
部署中:部署堆栈目前正在部署中
取消:部署堆栈正在被取消
更新拒绝分配:部署栈正在更新拒绝分配
deletingResources:部署栈正在删除资源
成功:部署堆栈成功完成
失败:部署栈已失效
取消:部署堆栈已被取消
删除:部署栈正在被删除
初始化:部署栈正在初始化中
运行中:部署栈当前正在执行操作

DeploymentStacksDiagnosticLevel

表示附加响应级别。
KnownDeploymentStacksDiagnosticLevel 可以与 DeploymentStacksDiagnosticLevel 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

信息:信息信息。
警告:警告信息。
错误:错误信息。

DeploymentStacksManagementStatus

部署栈资源的管理状态。
KnownDeploymentStacksManagementStatus 可以与 DeploymentStacksManagementState 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

管理:资源由部署栈管理。
未管理:该资源不由部署栈管理。
未知:无法确定该资源的管理状态。

DeploymentStacksWhatIfChangeCertainty

表示预测变化的置信水平。
KnownDeploymentStacksWhatIfChangeCertainty 可以与 DeploymentStacksWhatIfChangeCertainty 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

确定性:变化是确定的。
潜力:变更可能发生也可能不会,取决于部署时间条件。

DeploymentStacksWhatIfChangeType

执行部署时对资源进行的更改类型。
KnownDeploymentStacksWhatIfChangeType 可以与 DeploymentStacksWhatIfChangeType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

创建:资源不存在于当前状态,但存在于期望状态。 执行部署时,将创建资源。
删除:资源处于当前状态,且缺少期望状态。 部署执行后,该资源将从Azure中删除。
分离:资源存在于当前状态,且缺失于期望状态。 该资源将从部署堆栈中移除,但部署执行后仍保留在 Azure 中。
修改:资源处于当前状态和期望状态,执行部署时将重新部署。 资源的属性将发生更改。
noChange:资源处于当前状态和期望状态,执行部署时将重新部署。 资源的属性不会更改。
不支持:该资源不支持What-If。

DeploymentStacksWhatIfPropertyChangeType

属性更改的类型。
KnownDeploymentStacksWhatIfPropertyChangeType 可以与 DeploymentStacksWhatIfPropertyChangeType 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

array:属性是一个数组,包含嵌套的变更。
创建:属性不存在于当前状态,但存在于期望状态。 执行部署时将创建该属性。
delete:该属性存在于当前状态,但缺少于目标状态。 执行部署时,将删除该部署。
修改:该属性既存在当前状态,也存在期望状态,且不同。 执行部署时,属性的值将更改。
noEffect:属性不会被设置或更新。

ResourceStatusMode

部署堆栈中资源的当前管理状态。
KnownResourceStatusMode 可与 ResourceStatusMode 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

托管:此资源由部署堆栈管理。
removeDenyFailed:无法删除资源上的拒绝分配。
deleteFailed:无法从 Azure 中删除资源。 删除将在下一个堆栈部署上重试,也可以手动删除。

ResourcesWithoutDeleteSupportAction

指定不支持删除的资源的操作。
KnownResourcesWithoutDeleteSupportAction 可以与 ResourcesWithoutDeleteSupportAction 互换使用,该枚举包含服务支持的已知值。

服务支持的已知值

脱离:将指定资源从部署栈中分离并继续。
失败:如果无法删除资源,则失败部署栈。

UnmanageActionManagementGroupMode

指定新非托管资源的作。
KnownUnmanageActionManagementGroupMode 可与 UnmanageActionManagementGroupMode 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

delete:从Azure中删除管理组。
detach:保持管理组Azure。

UnmanageActionResourceGroupMode

为新管理的资源组指定一个动作。
KnownUnmanageActionResourceGroupMode 可与 UnmanageActionResourceGroupMode 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

delete:从Azure中删除资源组。
detach:保持资源组Azure。

UnmanageActionResourceMode

指定新非托管资源的作。
KnownUnmanageActionResourceMode 可与 UnmanageActionResourceMode 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

delete:删除Azure的资源
detach:保持资源Azure

ValidationLevel

对部署执行的验证级别。
KnownValidationLevel 可以与 ValidationLevel 互换使用,此枚举包含服务支持的已知值。

服务支持的已知值

模板:执行模板的静态分析。
提供程序:执行模板的静态分析,并将资源声明发送到资源提供程序进行语义验证。 验证调用方是否对每个资源具有 RBAC 写入权限。
ProviderNoRbac:执行模板的静态分析,并将资源声明发送到资源提供程序进行语义验证。 跳过验证调用方是否对每个资源具有 RBAC 写入权限。

枚举

AzureClouds

一个用来描述Azure云环境的enum。

KnownCreatedByType

创建资源的实体类型。

KnownDenySettingsMode

denySettings 模式,用于定义被拒绝的作。

KnownDenyStatusMode

应用于资源的 denyAssignment 设置。

KnownDeploymentStackProvisioningState

部署堆栈的状态。

KnownDeploymentStacksDiagnosticLevel

表示附加响应级别。

KnownDeploymentStacksManagementStatus

部署栈资源的管理状态。

KnownDeploymentStacksWhatIfChangeCertainty

表示预测变化的置信水平。

KnownDeploymentStacksWhatIfChangeType

执行部署时对资源进行的更改类型。

KnownDeploymentStacksWhatIfPropertyChangeType

属性更改的类型。

KnownResourceStatusMode

部署堆栈中资源的当前管理状态。

KnownResourcesWithoutDeleteSupportAction

指定不支持删除的资源的操作。

KnownUnmanageActionManagementGroupMode

指定新非托管资源的作。

KnownUnmanageActionResourceGroupMode

为新管理的资源组指定一个动作。

KnownUnmanageActionResourceMode

指定新非托管资源的作。

KnownValidationLevel

对部署执行的验证级别。

KnownVersions

可用的 API 版本。

函数

restorePoller<TResponse, TResult>(DeploymentStacksClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

从另一个轮询器的序列化状态创建轮询器。 当您想要在不同的主机上创建轮询器或需要在原始轮询器不在作用域内后构造轮询器时,这会很有用。

函数详细信息

restorePoller<TResponse, TResult>(DeploymentStacksClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

从另一个轮询器的序列化状态创建轮询器。 当您想要在不同的主机上创建轮询器或需要在原始轮询器不在作用域内后构造轮询器时,这会很有用。

function restorePoller<TResponse, TResult>(client: DeploymentStacksClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

参数

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

返回

PollerLike<OperationState<TResult>, TResult>