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

Deployments - Create Or Update At Tenant Scope

服务:

Resource Management

API 版本:

2021-04-01

在租户范围内部署资源。
可以直接在请求中提供模板和参数，也可以链接到 JSON 文件。

PUT https://management.azure.com/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2021-04-01

URI 参数

名称	在	必需	类型	说明
deploymentName	path	True	string	部署的名称。 正则表达式模式: ^[-\w\._\(\)]+$
api-version	query	True	string	要用于此操作的 API 版本。

请求正文

名称	必需	类型	说明
location	True	string	用于存储部署数据的位置。
properties	True	DeploymentProperties	部署属性。
tags		object	部署标记

响应

名称	类型	说明
200 OK	DeploymentExtended	确定 - 返回有关部署的信息，包括预配状态。
201 Created	DeploymentExtended	Created - 返回有关部署的信息，包括预配状态。
Other Status Codes	CloudError	描述操作失败原因的错误响应。

安全性

azure_auth

Azure Active Directory OAuth2 流

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

作用域

名称	说明
user_impersonation	模拟用户帐户

示例

Create deployment at tenant scope.

示例请求

HTTP

PUT https://management.azure.com/providers/Microsoft.Resources/deployments/tenant-dep01?api-version=2021-04-01

{
  "location": "eastus",
  "properties": {
    "templateLink": {
      "uri": "https://example.com/exampleTemplate.json"
    },
    "parameters": {},
    "mode": "Incremental"
  },
  "tags": {
    "tagKey1": "tag-value-1",
    "tagKey2": "tag-value-2"
  }
}

Go

package armresources_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/resources/armresources"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4fd842fb73656039ec94ce367bcedee25a57bd18/specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/PutDeploymentAtTenant.json
func ExampleDeploymentsClient_BeginCreateOrUpdateAtTenantScope() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armresources.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	poller, err := clientFactory.NewDeploymentsClient().BeginCreateOrUpdateAtTenantScope(ctx, "tenant-dep01", armresources.ScopedDeployment{
		Location: to.Ptr("eastus"),
		Properties: &armresources.DeploymentProperties{
			Mode:       to.Ptr(armresources.DeploymentModeIncremental),
			Parameters: map[string]any{},
			TemplateLink: &armresources.TemplateLink{
				URI: to.Ptr("https://example.com/exampleTemplate.json"),
			},
		},
		Tags: map[string]*string{
			"tagKey1": to.Ptr("tag-value-1"),
			"tagKey2": to.Ptr("tag-value-2"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	res, err := poller.PollUntilDone(ctx, nil)
	if err != nil {
		log.Fatalf("failed to pull the result: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DeploymentExtended = armresources.DeploymentExtended{
	// 	Name: to.Ptr("tenant-dep01"),
	// 	Type: to.Ptr("Microsoft.Resources/deployments"),
	// 	ID: to.Ptr("/providers/Microsoft.Resources/deployments/tenant-dep01"),
	// 	Location: to.Ptr("eastus"),
	// 	Properties: &armresources.DeploymentPropertiesExtended{
	// 		CorrelationID: to.Ptr("00000000-0000-0000-0000-000000000000"),
	// 		Dependencies: []*armresources.Dependency{
	// 			{
	// 				DependsOn: []*armresources.BasicDependency{
	// 					{
	// 						ID: to.Ptr("/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name"),
	// 						ResourceName: to.Ptr("policy-definition-name"),
	// 						ResourceType: to.Ptr("Microsoft.Authorization/policyDefinitions"),
	// 				}},
	// 				ID: to.Ptr("/providers/Microsoft.Authorization/policyAssignments/location-lock"),
	// 				ResourceName: to.Ptr("location-lock"),
	// 				ResourceType: to.Ptr("Microsoft.Authorization/policyAssignments"),
	// 		}},
	// 		Duration: to.Ptr("PT1.2970875S"),
	// 		Mode: to.Ptr(armresources.DeploymentModeIncremental),
	// 		Parameters: map[string]any{
	// 		},
	// 		Providers: []*armresources.Provider{
	// 			{
	// 				Namespace: to.Ptr("Microsoft.Authorization"),
	// 				ResourceTypes: []*armresources.ProviderResourceType{
	// 					{
	// 						Locations: []*string{
	// 							nil},
	// 							ResourceType: to.Ptr("policyDefinitions"),
	// 						},
	// 						{
	// 							Locations: []*string{
	// 								nil},
	// 								ResourceType: to.Ptr("policyAssignments"),
	// 						}},
	// 					},
	// 					{
	// 						Namespace: to.Ptr("Microsoft.Resources"),
	// 						ResourceTypes: []*armresources.ProviderResourceType{
	// 							{
	// 								Locations: []*string{
	// 									to.Ptr("eastus")},
	// 									ResourceType: to.Ptr("deployments"),
	// 							}},
	// 					}},
	// 					ProvisioningState: to.Ptr(armresources.ProvisioningStateSucceeded),
	// 					Timestamp: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2019-04-24T22:52:38.789Z"); return t}()),
	// 				},
	// 				Tags: map[string]*string{
	// 					"tagKey1": to.Ptr("tag-value-1"),
	// 					"tagKey2": to.Ptr("tag-value-2"),
	// 				},
	// 			}
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { ResourceManagementClient } = require("@azure/arm-resources");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to You can provide the template and parameters directly in the request or link to JSON files.
 *
 * @summary You can provide the template and parameters directly in the request or link to JSON files.
 * x-ms-original-file: specification/resources/resource-manager/Microsoft.Resources/stable/2021-04-01/examples/PutDeploymentAtTenant.json
 */
async function createDeploymentAtTenantScope() {
  const subscriptionId =
    process.env["RESOURCES_SUBSCRIPTION_ID"] || "00000000-0000-0000-0000-000000000000";
  const deploymentName = "tenant-dep01";
  const parameters = {
    location: "eastus",
    properties: {
      mode: "Incremental",
      parameters: {},
      templateLink: { uri: "https://example.com/exampleTemplate.json" },
    },
    tags: { tagKey1: "tag-value-1", tagKey2: "tag-value-2" },
  };
  const credential = new DefaultAzureCredential();
  const client = new ResourceManagementClient(credential, subscriptionId);
  const result = await client.deployments.beginCreateOrUpdateAtTenantScopeAndWait(
    deploymentName,
    parameters
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

示例响应

状态代码:

200

{
  "id": "/providers/Microsoft.Resources/deployments/tenant-dep01",
  "name": "tenant-dep01",
  "type": "Microsoft.Resources/deployments",
  "location": "eastus",
  "properties": {
    "parameters": {},
    "mode": "Incremental",
    "provisioningState": "Accepted",
    "timestamp": "2019-04-24T22:52:38.7895563Z",
    "duration": "PT1.2970875S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Authorization",
        "resourceTypes": [
          {
            "resourceType": "policyDefinitions",
            "locations": [
              null
            ]
          },
          {
            "resourceType": "policyAssignments",
            "locations": [
              null
            ]
          }
        ]
      },
      {
        "namespace": "Microsoft.Resources",
        "resourceTypes": [
          {
            "resourceType": "deployments",
            "locations": [
              "eastus"
            ]
          }
        ]
      }
    ],
    "dependencies": [
      {
        "dependsOn": [
          {
            "id": "/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
            "resourceType": "Microsoft.Authorization/policyDefinitions",
            "resourceName": "policy-definition-name"
          }
        ],
        "id": "/providers/Microsoft.Authorization/policyAssignments/location-lock",
        "resourceType": "Microsoft.Authorization/policyAssignments",
        "resourceName": "location-lock"
      }
    ]
  },
  "tags": {
    "tagKey1": "tag-value-1",
    "tagKey2": "tag-value-2"
  }
}

状态代码:

201

{
  "id": "/providers/Microsoft.Resources/deployments/tenant-dep01",
  "name": "tenant-dep01",
  "type": "Microsoft.Resources/deployments",
  "location": "eastus",
  "properties": {
    "parameters": {},
    "mode": "Incremental",
    "provisioningState": "Accepted",
    "timestamp": "2019-04-24T22:52:38.7895563Z",
    "duration": "PT1.2970875S",
    "correlationId": "00000000-0000-0000-0000-000000000000",
    "providers": [
      {
        "namespace": "Microsoft.Authorization",
        "resourceTypes": [
          {
            "resourceType": "policyDefinitions",
            "locations": [
              null
            ]
          },
          {
            "resourceType": "policyAssignments",
            "locations": [
              null
            ]
          }
        ]
      },
      {
        "namespace": "Microsoft.Resources",
        "resourceTypes": [
          {
            "resourceType": "deployments",
            "locations": [
              "eastus"
            ]
          }
        ]
      }
    ],
    "dependencies": [
      {
        "dependsOn": [
          {
            "id": "/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name",
            "resourceType": "Microsoft.Authorization/policyDefinitions",
            "resourceName": "policy-definition-name"
          }
        ],
        "id": "/providers/Microsoft.Authorization/policyAssignments/location-lock",
        "resourceType": "Microsoft.Authorization/policyAssignments",
        "resourceName": "location-lock"
      }
    ]
  },
  "tags": {
    "tagKey1": "tag-value-1",
    "tagKey2": "tag-value-2"
  }
}

定义

名称	说明
Alias	别名类型。
AliasPath	别名的路径的类型。
AliasPathAttributes	别名路径引用的令牌的属性。
AliasPathMetadata
AliasPathTokenType	别名路径引用的标记的类型。
AliasPattern	别名路径的模式类型。
AliasPatternType	别名模式的类型
AliasType	别名的类型。
ApiProfile
BasicDependency	部署依赖关系信息。
CloudError	资源管理请求的错误响应。
DebugSetting	调试设置。
Dependency	部署依赖关系信息。
DeploymentExtended	部署信息。
DeploymentMode	用于部署资源的模式。 此值可以是“增量”或“完成”。 在增量模式下，将在不删除模板中未包含的现有资源的情况下部署资源。 在“完成”模式下，部署资源，并删除资源组中未包含在模板中的现有资源。 使用“完成”模式时要小心，因为可能会无意中删除资源。
DeploymentProperties	部署属性。
DeploymentPropertiesExtended	包含其他详细信息的部署属性。
ErrorAdditionalInfo	资源管理错误附加信息。
ErrorResponse	错误响应
ExpressionEvaluationOptions	指定是在父模板还是嵌套模板的范围内计算模板表达式。
ExpressionEvaluationOptionsScopeType	用于计算嵌套模板中参数、变量和函数的范围。
OnErrorDeployment	针对错误行为进行部署。
OnErrorDeploymentExtended	针对错误行为的部署以及其他详细信息。
OnErrorDeploymentType	错误行为类型的部署。 可能的值为 LastSuccessful 和 SpecificDeployment。
ParametersLink	表示对部署参数的引用的实体。
Provider	资源提供程序信息。
ProviderAuthorizationConsentState	提供程序授权同意状态。
ProviderExtendedLocation	提供程序扩展位置。
ProviderResourceType	由资源提供程序管理的资源类型。
ProvisioningState	表示预配状态。
ResourceReference	资源 ID 模型。
ScopedDeployment	部署操作参数。
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

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

名称	类型	说明
Complete	string
Incremental	string

DeploymentProperties

部署属性。

名称	类型	说明
debugSetting	DebugSetting	部署的调试设置。
expressionEvaluationOptions	ExpressionEvaluationOptions	指定是在父模板还是嵌套模板的范围内计算模板表达式。 仅适用于嵌套模板。 如果未指定，默认值为 outer。
mode	DeploymentMode	用于部署资源的模式。 此值可以是“增量”或“完成”。 在增量模式下，将在不删除模板中未包含的现有资源的情况下部署资源。 在“完成”模式下，部署资源，并删除资源组中未包含在模板中的现有资源。 使用“完成”模式时要小心，因为可能会无意中删除资源。
onErrorDeployment	OnErrorDeployment	错误行为的部署。
parameters	object	定义模板部署参数的名称和值对。 如果要直接在请求中提供参数值，而不是链接到现有参数文件，请使用此元素。 使用 parametersLink 属性或 parameters 属性，但不能同时使用两者。 它可以是 JObject 或格式正确的 JSON 字符串。
parametersLink	ParametersLink	参数文件的 URI。 使用此元素链接到现有参数文件。 使用 parametersLink 属性或 parameters 属性，但不能同时使用两者。
template	object	模板内容。 如果要直接在请求中传递模板语法，而不是链接到现有模板，请使用此元素。 它可以是 JObject 或格式正确的 JSON 字符串。 使用 templateLink 属性或模板属性，但不能同时使用两者。
templateLink	TemplateLink	模板的 URI。 使用 templateLink 属性或模板属性，但不能同时使用两者。

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	错误目标。

ExpressionEvaluationOptions

指定是在父模板还是嵌套模板的范围内计算模板表达式。

名称	类型	说明
scope	ExpressionEvaluationOptionsScopeType	用于计算嵌套模板中参数、变量和函数的范围。

ExpressionEvaluationOptionsScopeType

用于计算嵌套模板中参数、变量和函数的范围。

名称	类型	说明
Inner	string
NotSpecified	string
Outer	string

OnErrorDeployment

针对错误行为进行部署。

名称	类型	说明
deploymentName	string	要针对错误情况使用的部署。
type	OnErrorDeploymentType	错误行为类型的部署。 可能的值为 LastSuccessful 和 SpecificDeployment。

OnErrorDeploymentExtended

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

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

OnErrorDeploymentType

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

名称	类型	说明
LastSuccessful	string
SpecificDeployment	string

ParametersLink

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

名称	类型	说明
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。

ScopedDeployment

部署操作参数。

名称	类型	说明
location	string	用于存储部署数据的位置。
properties	DeploymentProperties	部署属性。
tags	object	部署标记

TemplateLink

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

名称	类型	说明
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[]