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

Deployments - Get

服务:: Resource Management

API 版本:: 2025-04-01

获取部署。

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

URI 参数

名称	在	必需	类型	说明
deploymentName	path	True	string minLength: 1 maxLength: 64 pattern: ^[-\w\._]+$	部署的名称。
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\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	部署依赖项信息。
DeploymentDiagnosticsDefinition
DeploymentExtended	部署信息。
DeploymentExtensionConfigItem
DeploymentExtensionDefinition
DeploymentMode	用于部署资源的模式。此值可以是增量值，也可以是“完成”。在增量模式下，部署资源而不删除模板中不包含的现有资源。在“完成”模式下，将部署资源，并删除模板中不包含的资源组中的现有资源。使用“完成”模式时请注意，因为可能会无意中删除资源。
DeploymentPropertiesExtended	具有更多详细信息的部署属性。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorResponse	错误响应
ExtensionConfigPropertyType
KeyVaultParameterReference	Azure Key Vault 参数引用。
KeyVaultReference	Azure Key Vault 参考。
Level	表示附加响应级别。
OnErrorDeploymentExtended	有关错误行为的部署，并提供了其他详细信息。
OnErrorDeploymentType	错误行为类型的部署。可能的值为 LastSuccessful 和 SpecificDeployment。
ParametersLink	表示对部署参数的引用的实体。
Provider	资源提供程序信息。
ProviderAuthorizationConsentState	提供程序授权许可状态。
ProviderExtendedLocation	提供程序扩展位置。
ProviderResourceType	资源提供程序管理的资源类型。
ProvisioningState	表示预配的状态。
ResourceReference	资源 ID 模型。
TemplateLink	表示对模板的引用的实体。
ValidationLevel	对部署执行的验证级别。
ZoneMapping

Alias

Object

别名类型。

名称	类型	说明
defaultMetadata	AliasPathMetadata	默认别名路径元数据。适用于默认路径和不具有元数据的任何别名路径
defaultPath	string	别名的默认路径。
defaultPattern	AliasPattern	别名的默认模式。
name	string	别名。
paths	AliasPath[]	别名的路径。
type	AliasType	别名的类型。

AliasPath

Object

别名的路径的类型。

名称	类型	说明
apiVersions	string[]	API 版本。
metadata	AliasPathMetadata	别名路径的元数据。如果缺少，请回退到别名的默认元数据。
path	string	别名的路径。
pattern	AliasPattern	别名路径的模式。

AliasPathAttributes

枚举

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

值	说明
None	别名路径引用的标记没有属性。
Modifiable	别名路径引用的标记可由具有“modify”效果的策略修改。

AliasPathMetadata

Object

名称	类型	说明
attributes	AliasPathAttributes	别名路径引用的令牌的属性。
type	AliasPathTokenType	别名路径引用的标记的类型。

AliasPathTokenType

枚举

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

值	说明
NotSpecified	未指定标记类型。
Any	标记类型可以是任何内容。
String	标记类型为字符串。
Object	标记类型为对象。
Array	标记类型为数组。
Integer	标记类型为整数。
Number	标记类型为数字。
Boolean	标记类型为布尔值。

AliasPattern

Object

别名路径的模式类型。

名称	类型	说明
phrase	string	别名模式短语。
type	AliasPatternType	别名模式的类型
variable	string	别名模式变量。

AliasPatternType

枚举

别名模式的类型

值	说明
NotSpecified	不允许指定。
Extract	提取是唯一允许的值。

AliasType

枚举

别名的类型。

值	说明
NotSpecified	别名类型未知（与不提供别名类型相同）。
PlainText	别名值不是机密。
Mask	别名值为机密。

ApiProfile

Object

名称	类型	说明
apiVersion	string	API 版本。
profileVersion	string	配置文件版本。

BasicDependency

Object

部署依赖项信息。

名称	类型	说明
id	string	依赖项的 ID。
resourceName	string	依赖项资源名称。
resourceType	string	依赖项资源类型。

CloudError

Object

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

名称	类型	说明
error	ErrorResponse	错误响应所有 Azure 资源管理器 API 的常见错误响应，以返回失败操作的错误详细信息。（这也遵循 OData 错误响应格式。）

DebugSetting

Object

调试设置。

名称	类型	说明
detailLevel	string	指定要记录以供调试的信息的类型。允许的值不为 none、requestContent、responseContent，或两者均用逗号分隔的 requestContent 和 responseContent。默认值为 none。设置此值时，请仔细考虑在部署期间传入的信息类型。通过记录有关请求或响应的信息，可能会公开通过部署作检索的敏感数据。

Dependency

Object

部署依赖项信息。

名称	类型	说明
dependsOn	BasicDependency[]	依赖项列表。
id	string	依赖项的 ID。
resourceName	string	依赖项资源名称。
resourceType	string	依赖项资源类型。

DeploymentDiagnosticsDefinition

Object

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
level	Level	表示附加响应级别。
message	string	错误消息。
target	string	错误目标。

DeploymentExtended

Object

部署信息。

名称	类型	说明
id	string	部署的 ID。
location	string	部署的位置。
name	string	部署的名称。
properties	DeploymentPropertiesExtended	部署属性。
tags	object	部署标记
type	string	部署的类型。

DeploymentExtensionConfigItem

Object

名称	类型	说明
keyVaultReference	KeyVaultParameterReference	用于检索扩展配置属性的机密值的 Azure Key Vault 引用。
type	ExtensionConfigPropertyType	扩展配置属性的值类型。
value		扩展配置属性的值。

DeploymentExtensionDefinition

Object

名称	类型	说明
alias	string	部署模板中定义的扩展的别名。
config	<string, DeploymentExtensionConfigItem>	扩展配置。
configId	string	扩展配置 ID。它唯一标识扩展中的部署控制平面。
name	string	扩展名称。
version	string	扩展版本。

DeploymentMode

枚举

用于部署资源的模式。此值可以是增量值，也可以是“完成”。在增量模式下，部署资源而不删除模板中不包含的现有资源。在“完成”模式下，将部署资源，并删除模板中不包含的资源组中的现有资源。使用“完成”模式时请注意，因为可能会无意中删除资源。

值	说明
Incremental
Complete

DeploymentPropertiesExtended

Object

具有更多详细信息的部署属性。

名称	类型	说明
correlationId	string	部署的相关 ID。
debugSetting	DebugSetting	部署的调试设置。
dependencies	Dependency[]	部署依赖项的列表。
diagnostics	DeploymentDiagnosticsDefinition[]	包含在验证过程中收集的诊断信息。
duration	string	模板部署的持续时间。
error	ErrorResponse	错误响应部署错误。
extensions	DeploymentExtensionDefinition[]	此部署中使用的扩展。
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 (date-time)	模板部署的时间戳。
validatedResources	ResourceReference[]	已验证的资源数组。
validationLevel	ValidationLevel	部署的验证级别

ErrorAdditionalInfo

Object

资源管理错误附加信息。

名称	类型	说明
info	object	其他信息。
type	string	其他信息类型。

ErrorResponse

Object

错误响应

名称	类型	说明
additionalInfo	ErrorAdditionalInfo[]	错误附加信息。
code	string	错误代码。
details	ErrorResponse[]	错误详细信息。
message	string	错误消息。
target	string	错误目标。

ExtensionConfigPropertyType

枚举

值	说明
String	表示字符串值的属性类型。
Int	表示整数值的属性类型。
Bool	Property 类型表示布尔值。
Array	属性类型。
Object	表示对象值的属性类型。
SecureString	表示安全字符串值的属性类型。
SecureObject	表示安全对象值的属性类型。

KeyVaultParameterReference

Object

Azure Key Vault 参数引用。

名称	类型	说明
keyVault	KeyVaultReference	Azure Key Vault 参考。
secretName	string	Azure Key Vault 机密名称。
secretVersion	string	Azure Key Vault 机密版本。

KeyVaultReference

Object

Azure Key Vault 参考。

名称	类型	说明
id	string	Azure Key Vault 资源 ID。

Level

枚举

表示附加响应级别。

值	说明
Warning
Info
Error

OnErrorDeploymentExtended

Object

有关错误行为的部署，并提供了其他详细信息。

名称	类型	说明
deploymentName	string	要用于错误案例的部署。
provisioningState	string	错误部署的预配状态。
type	OnErrorDeploymentType	错误行为类型的部署。可能的值为 LastSuccessful 和 SpecificDeployment。

OnErrorDeploymentType

枚举

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

值	说明
LastSuccessful
SpecificDeployment

ParametersLink

Object

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

名称	类型	说明
contentVersion	string	如果包含，则必须匹配模板中的 ContentVersion。
uri	string	参数文件的 URI。

Provider

Object

资源提供程序信息。

名称	类型	说明
id	string	提供程序 ID。
namespace	string	资源提供程序的命名空间。
providerAuthorizationConsentState	ProviderAuthorizationConsentState	提供程序授权许可状态。
registrationPolicy	string	资源提供程序的注册策略。
registrationState	string	资源提供程序的注册状态。
resourceTypes	ProviderResourceType[]	提供程序资源类型的集合。

ProviderAuthorizationConsentState

枚举

提供程序授权许可状态。

值	说明
NotSpecified
Required
NotRequired
Consented

ProviderExtendedLocation

Object

提供程序扩展位置。

名称	类型	说明
extendedLocations	string[]	Azure 位置的扩展位置。
location	string	Azure 位置。
type	string	扩展位置类型。

ProviderResourceType

Object

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

名称	类型	说明
aliases	Alias[]	此资源类型支持的别名。
apiProfiles	ApiProfile[]	资源提供程序的 API 配置文件。
apiVersions	string[]	API 版本。
capabilities	string	此资源类型提供的其他功能。
defaultApiVersion	string	默认 API 版本。
locationMappings	ProviderExtendedLocation[]	此资源类型支持的位置映射。
locations	string[]	可以创建此资源类型的位置的集合。
properties	object	属性。
resourceType	string	资源类型。
zoneMappings	ZoneMapping[]

ProvisioningState

枚举

表示预配的状态。

值	说明
NotSpecified
Accepted
Running
Ready
Creating
Created
Deleting
Deleted
Canceled
Failed
Succeeded
Updating

ResourceReference

Object

资源 ID 模型。

名称	类型	说明
apiVersion	string	部署资源时使用的 API 版本。
extension	DeploymentExtensionDefinition	部署资源时使用的扩展。
id	string	完全限定的 Azure 资源 ID。
identifiers	object	可扩展资源标识符。
resourceType	string	资源类型。

TemplateLink

Object

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

名称	类型	说明
contentVersion	string	如果包含，则必须匹配模板中的 ContentVersion。
id	string	模板规格的资源 ID。请使用 ID 或 uri 属性，但不能同时使用这两个属性。
queryString	string	要与 templateLink URI 一起使用的查询字符串（例如 SAS 令牌）。
relativePath	string	relativePath 属性可用于在相对于父级的位置部署链接模板。如果父模板与 TemplateSpec 链接，则会引用 TemplateSpec 中的项目。如果父级已链接到 URI，则子部署将是父 URI 和 relativePath URI 的组合
uri	string	要部署的模板的 URI。使用 URI 或 ID 属性，但不能同时使用这两个属性。

ValidationLevel

枚举

对部署执行的验证级别。

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

ZoneMapping

Object

名称	类型	说明
location	string	区域映射的位置。
zones	string[]

通过

Deployments - Get

URI 参数

响应

安全性

azure_auth

作用域

定义

Alias

AliasPath

AliasPathAttributes

AliasPathMetadata

AliasPathTokenType

AliasPattern

AliasPatternType

AliasType

ApiProfile

BasicDependency

CloudError

DebugSetting

Dependency

DeploymentDiagnosticsDefinition

DeploymentExtended

DeploymentExtensionConfigItem

DeploymentExtensionDefinition

DeploymentMode

DeploymentPropertiesExtended

ErrorAdditionalInfo

ErrorResponse

ExtensionConfigPropertyType

KeyVaultParameterReference

KeyVaultReference

Level

OnErrorDeploymentExtended

OnErrorDeploymentType

ParametersLink

Provider

ProviderAuthorizationConsentState

ProviderExtendedLocation

ProviderResourceType

ProvisioningState

ResourceReference

TemplateLink

ValidationLevel

ZoneMapping