Deployments - Create Or Update At Tenant Scope
テナント スコープでリソースをデプロイします。
テンプレートとパラメーターは、要求または JSON ファイルへのリンクで直接指定できます。
PUT https://management.azure.com/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2021-04-01
URI パラメーター
名前 | / | 必須 | 型 | 説明 |
---|---|---|---|---|
deployment
|
path | True |
string |
デプロイの名前。 正規表現パターン: |
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
要求本文
名前 | 必須 | 型 | 説明 |
---|---|---|---|
location | True |
string |
デプロイ データを格納する場所。 |
properties | True |
配置プロパティです。 |
|
tags |
object |
デプロイ タグ |
応答
名前 | 型 | 説明 |
---|---|---|
200 OK |
OK - プロビジョニングの状態など、デプロイに関する情報を返します。 |
|
201 Created |
Created - プロビジョニングの状態など、デプロイに関する情報を返します。 |
|
Other Status Codes |
操作に失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
名前 | 説明 |
---|---|
user_impersonation | ユーザー アカウントの借用 |
例
Create deployment at tenant scope.
要求のサンプル
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"
}
}
応答のサンプル
{
"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"
}
}
{
"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 |
エイリアスの種類。 |
Alias |
エイリアスのパスの型。 |
Alias |
エイリアス パスが参照しているトークンの属性。 |
Alias |
|
Alias |
エイリアス パスが参照しているトークンの型。 |
Alias |
エイリアス パスのパターンの型。 |
Alias |
エイリアス パターンの種類 |
Alias |
エイリアスの型。 |
Api |
|
Basic |
デプロイメントの依存関係情報です。 |
Cloud |
リソース管理要求のエラー応答。 |
Debug |
デバッグ設定。 |
Dependency |
デプロイメントの依存関係情報です。 |
Deployment |
デプロイメント情報です。 |
Deployment |
リソースのデプロイに使用されるモード。 この値には、増分または完了のいずれかを指定できます。 Incremental モードでは、テンプレートに含まれていない既存のリソースを削除することなくリソースがデプロイされます。 完全モードでは、リソースがデプロイされ、テンプレートに含まれていないリソース グループ内の既存のリソースが削除されます。 リソースを意図せずに削除する可能性があるため、Complete モードを使用する場合は注意してください。 |
Deployment |
デプロイメントのプロパティです。 |
Deployment |
追加の詳細を含む展開プロパティ。 |
Error |
リソース管理エラーの追加情報。 |
Error |
エラー応答 |
Expression |
テンプレート式を親テンプレートのスコープ内で評価するか、入れ子になったテンプレートで評価するかを指定します。 |
Expression |
入れ子になったテンプレート内のパラメーター、変数、関数の評価に使用するスコープ。 |
On |
エラーの動作に対するデプロイ。 |
On |
追加の詳細を含むエラー動作でのデプロイ。 |
On |
エラー動作の種類でのデプロイ。 指定できる値は LastSuccessful と SpecificDeployment です。 |
Parameters |
デプロイ パラメーターへの参照を表すエンティティ。 |
Provider |
リソース プロバイダーの情報です。 |
Provider |
プロバイダー承認の同意の状態。 |
Provider |
プロバイダーの拡張場所。 |
Provider |
リソース プロバイダーによって管理されるリソースの種類です。 |
Provisioning |
プロビジョニングの状態を示します。 |
Resource |
リソース ID モデル。 |
Scoped |
デプロイ操作パラメーター。 |
Template |
テンプレートへの参照を表すエンティティです。 |
Zone |
Alias
エイリアスの種類。
名前 | 型 | 説明 |
---|---|---|
defaultMetadata |
既定のエイリアス パス メタデータ。 既定のパスと、メタデータを持たないエイリアス パスに適用されます |
|
defaultPath |
string |
エイリアスの既定のパス。 |
defaultPattern |
エイリアスの既定のパターン。 |
|
name |
string |
エイリアス名。 |
paths |
エイリアスのパス。 |
|
type |
エイリアスの型。 |
AliasPath
エイリアスのパスの型。
名前 | 型 | 説明 |
---|---|---|
apiVersions |
string[] |
API のバージョン。 |
metadata |
エイリアス パスのメタデータ。 見つからない場合は、エイリアスの既定のメタデータにフォールバックします。 |
|
path |
string |
エイリアスのパス。 |
pattern |
エイリアス パスのパターン。 |
AliasPathAttributes
エイリアス パスが参照しているトークンの属性。
名前 | 型 | 説明 |
---|---|---|
Modifiable |
string |
エイリアス パスが参照しているトークンは、"modify" 効果を持つポリシーによって変更可能です。 |
None |
string |
別名パスが参照しているトークンには属性がありません。 |
AliasPathMetadata
名前 | 型 | 説明 |
---|---|---|
attributes |
エイリアス パスが参照しているトークンの属性。 |
|
type |
エイリアス パスが参照しているトークンの型。 |
AliasPathTokenType
エイリアス パスが参照しているトークンの型。
名前 | 型 | 説明 |
---|---|---|
Any |
string |
トークンの種類は何でもかまいません。 |
Array |
string |
トークン型は配列です。 |
Boolean |
string |
トークンの種類はブール値です。 |
Integer |
string |
トークンの種類は整数です。 |
NotSpecified |
string |
トークンの種類が指定されていません。 |
Number |
string |
トークンの種類は number です。 |
Object |
string |
トークンの種類は object です。 |
String |
string |
トークンの種類は string です。 |
AliasPattern
エイリアス パスのパターンの型。
名前 | 型 | 説明 |
---|---|---|
phrase |
string |
エイリアス パターン フレーズ。 |
type |
エイリアス パターンの種類 |
|
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 |
エラー応答 |
DebugSetting
デバッグ設定。
名前 | 型 | 説明 |
---|---|---|
detailLevel |
string |
デバッグのためにログに記録する情報の種類を指定します。 許可される値は none、requestContent、responseContent、または requestContent と responseContent の両方をコンマで区切って指定します。 既定値は none です。 この値を設定するときは、デプロイ時に渡す情報の種類を慎重に検討してください。 要求または応答に関する情報をログ記録すると、デプロイ操作で取得される重要なデータを公開する可能性があります。 |
Dependency
デプロイメントの依存関係情報です。
名前 | 型 | 説明 |
---|---|---|
dependsOn |
依存関係の一覧。 |
|
id |
string |
依存関係の ID。 |
resourceName |
string |
依存関係リソース名。 |
resourceType |
string |
依存関係リソースの種類。 |
DeploymentExtended
デプロイメント情報です。
名前 | 型 | 説明 |
---|---|---|
id |
string |
配置の ID。 |
location |
string |
デプロイの場所。 |
name |
string |
デプロイの名前。 |
properties |
デプロイメントのプロパティです。 |
|
tags |
object |
デプロイ タグ |
type |
string |
デプロイの種類。 |
DeploymentMode
リソースのデプロイに使用されるモード。 この値には、増分または完了のいずれかを指定できます。 Incremental モードでは、テンプレートに含まれていない既存のリソースを削除することなくリソースがデプロイされます。 完全モードでは、リソースがデプロイされ、テンプレートに含まれていないリソース グループ内の既存のリソースが削除されます。 リソースを意図せずに削除する可能性があるため、Complete モードを使用する場合は注意してください。
名前 | 型 | 説明 |
---|---|---|
Complete |
string |
|
Incremental |
string |
DeploymentProperties
デプロイメントのプロパティです。
名前 | 型 | 説明 |
---|---|---|
debugSetting |
デプロイのデバッグ設定。 |
|
expressionEvaluationOptions |
テンプレート式を親テンプレートのスコープ内で評価するか、入れ子になったテンプレートで評価するかを指定します。 入れ子になったテンプレートにのみ適用されます。 指定しない場合、既定値は outer です。 |
|
mode |
リソースのデプロイに使用されるモード。 この値には、増分または完了のいずれかを指定できます。 Incremental モードでは、テンプレートに含まれていない既存のリソースを削除することなくリソースがデプロイされます。 完全モードでは、リソースがデプロイされ、テンプレートに含まれていないリソース グループ内の既存のリソースが削除されます。 リソースを意図せずに削除する可能性があるため、Complete モードを使用する場合は注意してください。 |
|
onErrorDeployment |
エラーの動作に対するデプロイ。 |
|
parameters |
object |
テンプレートのデプロイ パラメーターを定義する名前と値のペア。 この要素は、既存のパラメーター ファイルへのリンクではなく、要求でパラメーター値を直接指定する場合に使用します。 parametersLink プロパティまたは parameters プロパティを使用しますが、両方は使用しません。 JObject または整形式の JSON 文字列を指定できます。 |
parametersLink |
パラメーター ファイルの URI。 この要素を使用して、既存のパラメーター ファイルにリンクします。 parametersLink プロパティまたは parameters プロパティを使用しますが、両方は使用しません。 |
|
template |
object |
テンプレートの内容。 この要素は、既存のテンプレートへのリンクではなく、要求でテンプレート構文を直接渡す場合に使用します。 JObject または整形式の JSON 文字列を指定できます。 templateLink プロパティまたはテンプレート プロパティを使用しますが、両方は使用しません。 |
templateLink |
テンプレートの URI。 templateLink プロパティまたはテンプレート プロパティを使用しますが、両方は使用しません。 |
DeploymentPropertiesExtended
追加の詳細を含む展開プロパティ。
名前 | 型 | 説明 |
---|---|---|
correlationId |
string |
デプロイの関連付け ID。 |
debugSetting |
デプロイのデバッグ設定。 |
|
dependencies |
デプロイの依存関係の一覧。 |
|
duration |
string |
テンプレートのデプロイの期間。 |
error |
エラー応答 |
|
mode |
デプロイ モード。 指定できる値は、増分と完了です。 |
|
onErrorDeployment |
エラーの動作に対するデプロイ。 |
|
outputResources |
プロビジョニングされたリソースの配列。 |
|
outputs |
object |
デプロイ出力を表すキーと値のペア。 |
parameters |
object |
デプロイのパラメーターです。 |
parametersLink |
パラメーターを参照する URI。 |
|
providers |
Provider[] |
デプロイに必要なリソース プロバイダーの一覧。 |
provisioningState |
プロビジョニングの状態を示します。 |
|
templateHash |
string |
テンプレート用に生成されたハッシュ。 |
templateLink |
テンプレートを参照する URI。 |
|
timestamp |
string |
テンプレートデプロイのタイムスタンプ。 |
validatedResources |
検証済みリソースの配列。 |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
名前 | 型 | 説明 |
---|---|---|
info |
object |
追加情報。 |
type |
string |
追加情報の種類。 |
ErrorResponse
エラー応答
名前 | 型 | 説明 |
---|---|---|
additionalInfo |
エラーの追加情報。 |
|
code |
string |
エラー コード。 |
details |
エラーの詳細です。 |
|
message |
string |
エラー メッセージ。 |
target |
string |
エラーのターゲット。 |
ExpressionEvaluationOptions
テンプレート式を親テンプレートのスコープ内で評価するか、入れ子になったテンプレートで評価するかを指定します。
名前 | 型 | 説明 |
---|---|---|
scope |
入れ子になったテンプレート内のパラメーター、変数、関数の評価に使用するスコープ。 |
ExpressionEvaluationOptionsScopeType
入れ子になったテンプレート内のパラメーター、変数、関数の評価に使用するスコープ。
名前 | 型 | 説明 |
---|---|---|
Inner |
string |
|
NotSpecified |
string |
|
Outer |
string |
OnErrorDeployment
エラーの動作に対するデプロイ。
名前 | 型 | 説明 |
---|---|---|
deploymentName |
string |
エラーケースで使用するデプロイ。 |
type |
エラー動作の種類でのデプロイ。 指定できる値は LastSuccessful と SpecificDeployment です。 |
OnErrorDeploymentExtended
追加の詳細を含むエラー動作でのデプロイ。
名前 | 型 | 説明 |
---|---|---|
deploymentName |
string |
エラー ケースで使用するデプロイ。 |
provisioningState |
string |
エラーデプロイ時の のプロビジョニングの状態。 |
type |
エラー動作の種類でのデプロイ。 指定できる値は LastSuccessful と SpecificDeployment です。 |
OnErrorDeploymentType
エラー動作の種類でのデプロイ。 指定できる値は LastSuccessful と SpecificDeployment です。
名前 | 型 | 説明 |
---|---|---|
LastSuccessful |
string |
|
SpecificDeployment |
string |
ParametersLink
デプロイ パラメーターへの参照を表すエンティティ。
名前 | 型 | 説明 |
---|---|---|
contentVersion |
string |
含まれている場合は、テンプレート内の ContentVersion と一致する必要があります。 |
uri |
string |
パラメーター ファイルの URI。 |
Provider
リソース プロバイダーの情報です。
名前 | 型 | 説明 |
---|---|---|
id |
string |
プロバイダー ID。 |
namespace |
string |
リソース プロバイダーの名前空間。 |
providerAuthorizationConsentState |
プロバイダー承認の同意の状態。 |
|
registrationPolicy |
string |
リソース プロバイダーの登録ポリシー。 |
registrationState |
string |
リソース プロバイダーの登録状態。 |
resourceTypes |
プロバイダー リソースの種類のコレクション。 |
ProviderAuthorizationConsentState
プロバイダー承認の同意の状態。
名前 | 型 | 説明 |
---|---|---|
Consented |
string |
|
NotRequired |
string |
|
NotSpecified |
string |
|
Required |
string |
ProviderExtendedLocation
プロバイダーの拡張場所。
名前 | 型 | 説明 |
---|---|---|
extendedLocations |
string[] |
Azure の場所の拡張された場所。 |
location |
string |
Azure の場所。 |
type |
string |
拡張された場所の種類。 |
ProviderResourceType
リソース プロバイダーによって管理されるリソースの種類です。
名前 | 型 | 説明 |
---|---|---|
aliases |
Alias[] |
このリソースの種類でサポートされているエイリアス。 |
apiProfiles |
リソース プロバイダーの API プロファイル。 |
|
apiVersions |
string[] |
API のバージョン。 |
capabilities |
string |
このリソースの種類によって提供される追加機能。 |
defaultApiVersion |
string |
既定の API バージョン。 |
locationMappings |
このリソースの種類でサポートされている場所マッピング。 |
|
locations |
string[] |
このリソースの種類を作成できる場所のコレクション。 |
properties |
object |
プロパティ。 |
resourceType |
string |
リソースの種類。 |
zoneMappings |
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 |
配置プロパティです。 |
|
tags |
object |
デプロイ タグ |
TemplateLink
テンプレートへの参照を表すエンティティです。
名前 | 型 | 説明 |
---|---|---|
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 プロパティを使用しますが、両方は使用しないでください。 |
ZoneMapping
名前 | 型 | 説明 |
---|---|---|
location |
string |
ゾーン マッピングの場所。 |
zones |
string[] |