通过

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

Deployments - Get

  • 参考
服务:
Resource Management
API 版本:
2021-04-01

获取部署。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2021-04-01

URI 参数

名称 在 必需 类型 说明
deploymentName
 path True

string

部署的名称。

正则表达式模式: ^[-\w\._\(\)]+$
resourceGroupName
 path True

string

资源组的名称。 此名称不区分大小写。

正则表达式模式: ^[-\w\._\(\)]+$
subscriptionId
 path True

string

Microsoft Azure 订阅 ID。
api-version
 query True

string

要用于此操作的 API 版本。

响应

名称 类型 说明
200 OK

DeploymentExtended

确定 - 返回有关部署的信息，包括预配状态。
Other Status Codes

CloudError

描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

类型: oauth2
流向: implicit
授权 URL: https://login.microsoftonline.com/common/oauth2/authorize

作用域

名称 说明
user_impersonation 模拟用户帐户

定义

名称 说明
Alias

别名类型。
AliasPath

别名的路径的类型。
AliasPathAttributes

别名路径引用的令牌的属性。
AliasPathMetadata
AliasPathTokenType

别名路径引用的标记的类型。
AliasPattern

别名路径的模式类型。
AliasPatternType

别名模式的类型
AliasType

别名的类型。
ApiProfile
BasicDependency

部署依赖关系信息。
CloudError

资源管理请求的错误响应。
DebugSetting

调试设置。
Dependency

部署依赖关系信息。
DeploymentExtended

部署信息。
DeploymentMode

用于部署资源的模式。 此值可以是 Incremental 或 Complete。 在增量模式下，将在不删除模板中未包含的现有资源的情况下部署资源。 在“完成”模式下，将部署资源，并删除资源组中未包含在模板中的现有资源。 使用“完成”模式时要小心，因为可能会无意中删除资源。
DeploymentPropertiesExtended

包含其他详细信息的部署属性。
ErrorAdditionalInfo

资源管理错误附加信息。
ErrorResponse

错误响应
OnErrorDeploymentExtended

针对错误行为的部署以及其他详细信息。
OnErrorDeploymentType

错误行为类型的部署。 可能的值为 LastSuccessful 和 SpecificDeployment。
ParametersLink

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

资源提供程序信息。
ProviderAuthorizationConsentState

提供程序授权同意状态。
ProviderExtendedLocation

提供程序扩展位置。
ProviderResourceType

由资源提供程序管理的资源类型。
ProvisioningState

表示预配的状态。
ResourceReference

资源 ID 模型。
TemplateLink

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

Alias

别名类型。

名称 类型 说明
defaultMetadata

AliasPathMetadata

默认别名路径元数据。 适用于默认路径和不具有元数据的任何别名路径
defaultPath

string

别名的默认路径。
defaultPattern

AliasPattern

别名的默认模式。
name

string

别名。
paths

AliasPath[]

别名的路径。
type

AliasType

别名的类型。

AliasPath

别名的路径的类型。

名称 类型 说明
apiVersions

string[]

API 版本。
metadata

AliasPathMetadata

别名路径的元数据。 如果缺少，请回退到别名的默认元数据。
path

string

别名的路径。
pattern

AliasPattern

别名路径的模式。

AliasPathAttributes

别名路径引用的令牌的属性。

名称 类型 说明
Modifiable

string

别名路径引用的标记可由具有“修改”效果的策略修改。
None

string

别名路径引用的标记没有属性。

AliasPathMetadata

名称 类型 说明
attributes

AliasPathAttributes

别名路径引用的令牌的属性。
type

AliasPathTokenType

别名路径引用的标记的类型。

AliasPathTokenType

别名路径引用的标记的类型。

名称 类型 说明
Any

string

标记类型可以是任何内容。
Array

string

标记类型为 array。
Boolean

string

标记类型为布尔值。
Integer

string

标记类型为整数。
NotSpecified

string

未指定标记类型。
Number

string

标记类型为 number。
Object

string

标记类型为 object。
String

string

标记类型为字符串。

AliasPattern

别名路径的模式类型。

名称 类型 说明
phrase

string

别名模式短语。
type

AliasPatternType

别名模式的类型
variable

string

别名模式变量。

AliasPatternType

别名模式的类型

名称 类型 说明
Extract

string

提取是唯一允许的值。
NotSpecified

string

不允许使用 NotSpecified。

AliasType

别名的类型。

名称 类型 说明
Mask

string

别名值为机密。
NotSpecified

string

别名类型未知 (与不提供别名类型) 相同。
PlainText

string

别名值不是机密。

ApiProfile

名称 类型 说明
apiVersion

string

API 版本。
profileVersion

string

配置文件版本。

BasicDependency

部署依赖关系信息。

名称 类型 说明
id

string

依赖项的 ID。
resourceName

string

依赖项资源名称。
resourceType

string

依赖项资源类型。

CloudError

资源管理请求的错误响应。

名称 类型 说明
error

ErrorResponse

错误响应
对所有 Azure 资源管理器 API 的常见错误响应，可返回失败操作的错误详细信息。 (这也遵循 OData 错误响应格式。)

DebugSetting

调试设置。

名称 类型 说明
detailLevel

string

指定要记录用于调试的信息的类型。 允许的值为 none、requestContent、responseContent 或 requestContent 和 responseContent（用逗号分隔）。 默认值为 none。 设置此值时，请仔细考虑在部署期间传入的信息类型。 通过记录有关请求或响应的信息，可能会公开通过部署操作检索的机密数据。

Dependency

部署依赖关系信息。

名称 类型 说明
dependsOn

BasicDependency[]

依赖项的列表。
id

string

依赖项的 ID。
resourceName

string

依赖项资源名称。
resourceType

string

依赖项资源类型。

DeploymentExtended

部署信息。

名称 类型 说明
id

string

部署的 ID。
location

string

部署的位置。
name

string

部署的名称。
properties

DeploymentPropertiesExtended

部署属性。
tags

object

部署标记
type

string

部署的类型。

DeploymentMode

用于部署资源的模式。 此值可以是 Incremental 或 Complete。 在增量模式下，将在不删除模板中未包含的现有资源的情况下部署资源。 在“完成”模式下，将部署资源，并删除资源组中未包含在模板中的现有资源。 使用“完成”模式时要小心，因为可能会无意中删除资源。

名称 类型 说明
Complete

string

Incremental

string

DeploymentPropertiesExtended

包含其他详细信息的部署属性。

名称 类型 说明
correlationId

string

部署的相关 ID。
debugSetting

DebugSetting

部署的调试设置。
dependencies

Dependency[]

部署依赖项的列表。
duration

string

模板部署的持续时间。
error

ErrorResponse

错误响应
部署错误。
mode

DeploymentMode

部署模式。 可能的值为 Incremental 和 Complete。
onErrorDeployment

OnErrorDeploymentExtended

错误行为时部署。
outputResources

ResourceReference[]

预配资源的数组。
outputs

object

表示部署输出的键/值对。
parameters

object

部署参数。
parametersLink

ParametersLink

引用参数的 URI。
providers

Provider[]

部署所需的资源提供程序列表。
provisioningState

ProvisioningState

表示预配的状态。
templateHash

string

为模板生成的哈希。
templateLink

TemplateLink

引用模板的 URI。
timestamp

string

模板部署的时间戳。
validatedResources

ResourceReference[]

已验证资源的数组。

ErrorAdditionalInfo

资源管理错误附加信息。

名称 类型 说明
info

object

其他信息。
type

string

其他信息类型。

ErrorResponse

错误响应

名称 类型 说明
additionalInfo

ErrorAdditionalInfo[]

错误附加信息。
code

string

错误代码。
details

ErrorResponse[]

错误详细信息。
message

string

错误消息。
target

string

错误目标。

OnErrorDeploymentExtended

针对错误行为的部署以及其他详细信息。

名称 类型 说明
deploymentName

string

要用于错误情况的部署。
provisioningState

string

错误时部署的预配状态。
type

OnErrorDeploymentType

错误行为类型的部署。 可能的值为 LastSuccessful 和 SpecificDeployment。

OnErrorDeploymentType

错误行为类型的部署。 可能的值为 LastSuccessful 和 SpecificDeployment。

名称 类型 说明
LastSuccessful

string

SpecificDeployment

string

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

名称 类型 说明
contentVersion

string

如果包含，则必须与模板中的 ContentVersion 匹配。
uri

string

参数文件的 URI。

Provider

资源提供程序信息。

名称 类型 说明
id

string

提供程序 ID。
namespace

string

资源提供程序的命名空间。
providerAuthorizationConsentState

ProviderAuthorizationConsentState

提供程序授权同意状态。
registrationPolicy

string

资源提供程序的注册策略。
registrationState

string

资源提供程序的注册状态。
resourceTypes

ProviderResourceType[]

提供程序资源类型的集合。

ProviderAuthorizationConsentState

提供程序授权同意状态。

名称 类型 说明
Consented

string

NotRequired

string

NotSpecified

string

Required

string

ProviderExtendedLocation

提供程序扩展位置。

名称 类型 说明
extendedLocations

string[]

Azure 位置的扩展位置。
location

string

Azure 位置。
type

string

扩展位置类型。

ProviderResourceType

由资源提供程序管理的资源类型。

名称 类型 说明
aliases

Alias[]

此资源类型支持的别名。
apiProfiles

ApiProfile[]

资源提供程序的 API 配置文件。
apiVersions

string[]

API 版本。
capabilities

string

此资源类型提供的其他功能。
defaultApiVersion

string

默认 API 版本。
locationMappings

ProviderExtendedLocation[]

此资源类型支持的位置映射。
locations

string[]

可在其中创建此资源类型的位置的集合。
properties

object

属性。
resourceType

string

资源类型。
zoneMappings

ZoneMapping[]

ProvisioningState

表示预配的状态。

名称 类型 说明
Accepted

string

Canceled

string

Created

string

Creating

string

Deleted

string

Deleting

string

Failed

string

NotSpecified

string

Ready

string

Running

string

Succeeded

string

Updating

string

ResourceReference

资源 ID 模型。

名称 类型 说明
id

string

完全限定的资源 ID。

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

名称 类型 说明
contentVersion

string

如果包含，则必须与模板中的 ContentVersion 匹配。
id

string

模板规格的资源 ID。请使用 id 或 uri 属性，但不能同时使用两者。
queryString

string

查询字符串 (例如，) 用于 templateLink URI 的 SAS 令牌。
relativePath

string

relativePath 属性可用于在相对于父级的位置部署链接模板。 如果父模板与 TemplateSpec 链接，这将引用 TemplateSpec 中的项目。 如果父级与 URI 链接，则子部署将是父级和 relativePath URI 的组合
uri

string

要部署的模板的 URI。 使用 uri 或 id 属性，但不能同时使用两者。

ZoneMapping

名称 类型 说明
location

string

区域映射的位置。
zones

string[]