Deployments - Create Or Update At Tenant Scope

テナント スコープでリソースをデプロイします。
テンプレートとパラメーターは、要求で直接指定することも、JSON ファイルにリンクすることもできます。

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

URI パラメーター

Name In Required Type Description
deploymentName
path True
  • string

デプロイの名前。

Regex pattern: ^[-\w\._\(\)]+$

api-version
query True
  • string

この操作に使用する API バージョン。

要求本文

Name Required Type Description
location True
  • string

デプロイ データを格納する場所。

properties True

配置プロパティです。

tags
  • object

デプロイ タグ

応答

Name Type Description
200 OK

OK - プロビジョニングの状態など、デプロイに関する情報を返します。

201 Created

作成済み - プロビジョニングの状態など、デプロイに関する情報を返します。

Other Status Codes

操作に失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

OAuth2 FlowをAzure Active Directoryする

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation ユーザー アカウントを偽装する

Create deployment at tenant scope.

Sample Request

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"
  }
}

Sample Response

{
  "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

エイリアスの種類。

AliasPath

エイリアスのパスの型。

AliasPathAttributes

エイリアス パスが参照しているトークンの属性。

AliasPathMetadata
AliasPathTokenType

エイリアス パスが参照しているトークンの型。

AliasPattern

エイリアス パスのパターンの型。

AliasPatternType

エイリアス パターンの種類

AliasType

エイリアスの型。

ApiProfile
BasicDependency

デプロイメントの依存関係情報です。

CloudError

リソース管理要求のエラー応答。

DebugSetting

デバッグ設定。

Dependency

デプロイメントの依存関係情報です。

DeploymentExtended

デプロイメント情報です。

DeploymentMode

リソースのデプロイに使用されるモード。 この値には、Incremental または Complete のいずれかを指定できます。 Incremental モードでは、テンプレートに含まれていない既存のリソースを削除することなくリソースがデプロイされます。 完全モードでは、リソースがデプロイされ、テンプレートに含まれていないリソース グループ内の既存のリソースが削除されます。 リソースを誤って削除する可能性があるため、完全モードを使用する場合は注意してください。

DeploymentProperties

デプロイメントのプロパティです。

DeploymentPropertiesExtended

追加の詳細を含む展開プロパティ。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

ErrorResponse

エラー応答

ExpressionEvaluationOptions

テンプレート式を親テンプレートまたは入れ子になったテンプレートのスコープ内で評価するかどうかを指定します。

ExpressionEvaluationOptionsScopeType

入れ子になったテンプレート内のパラメーター、変数、関数の評価に使用するスコープ。

OnErrorDeployment

エラー動作でのデプロイ。

OnErrorDeploymentExtended

追加の詳細を含むエラー動作でのデプロイ。

OnErrorDeploymentType

エラー動作の種類でのデプロイ。 指定できる値は LastSuccessful と SpecificDeployment です。

ParametersLink

デプロイ パラメーターへの参照を表すエンティティ。

Provider

リソース プロバイダーの情報です。

ProviderAuthorizationConsentState

プロバイダー承認の同意の状態。

ProviderExtendedLocation

プロバイダーの拡張場所。

ProviderResourceType

リソース プロバイダーによって管理されるリソースの種類です。

ProvisioningState

プロビジョニングの状態を示します。

ResourceReference

リソース ID モデル。

ScopedDeployment

デプロイ操作のパラメーター。

TemplateLink

テンプレートへの参照を表すエンティティです。

ZoneMapping

Alias

エイリアスの種類。

Name Type Description
defaultMetadata

既定のエイリアス パスのメタデータ。 既定のパスと、メタデータを持たないエイリアス パスに適用されます

defaultPath
  • string

エイリアスの既定のパス。

defaultPattern

エイリアスの既定のパターン。

name
  • string

エイリアス名。

paths

エイリアスのパス。

type

エイリアスの型。

AliasPath

エイリアスのパスの型。

Name Type Description
apiVersions
  • string[]

API のバージョン。

metadata

エイリアス パスのメタデータ。 見つからない場合は、エイリアスの既定のメタデータにフォールバックします。

path
  • string

エイリアスのパス。

pattern

エイリアス パスのパターン。

AliasPathAttributes

エイリアス パスが参照しているトークンの属性。

Name Type Description
Modifiable
  • string

エイリアス パスが参照しているトークンは、'modify' 効果を持つポリシーによって変更できます。

None
  • string

エイリアス パスが参照しているトークンには属性がありません。

AliasPathMetadata

Name Type Description
attributes

エイリアス パスが参照しているトークンの属性。

type

エイリアス パスが参照しているトークンの型。

AliasPathTokenType

エイリアス パスが参照しているトークンの型。

Name Type Description
Any
  • string

トークンの種類は何でもかまいません。

Array
  • string

トークン型は配列です。

Boolean
  • string

トークンの種類はブール値です。

Integer
  • string

トークンの種類は整数です。

NotSpecified
  • string

トークンの種類が指定されていません。

Number
  • string

トークンの種類は number です。

Object
  • string

トークンの種類はオブジェクトです。

String
  • string

トークンの種類は文字列です。

AliasPattern

エイリアス パスのパターンの型。

Name Type Description
phrase
  • string

エイリアス パターン フレーズ。

type

エイリアス パターンの種類

variable
  • string

エイリアス パターン変数。

AliasPatternType

エイリアス パターンの種類

Name Type Description
Extract
  • string

抽出は、唯一の許可される値です。

NotSpecified
  • string

NotSpecified は許可されていません。

AliasType

エイリアスの型。

Name Type Description
Mask
  • string

エイリアス値はシークレットです。

NotSpecified
  • string

エイリアスの種類が不明です (エイリアス型を指定しない場合と同じです)。

PlainText
  • string

エイリアス値はシークレットではありません。

ApiProfile

Name Type Description
apiVersion
  • string

API のバージョン。

profileVersion
  • string

プロファイルのバージョン。

BasicDependency

デプロイメントの依存関係情報です。

Name Type Description
id
  • string

依存関係の ID。

resourceName
  • string

依存関係リソース名。

resourceType
  • string

依存関係リソースの種類。

CloudError

リソース管理要求のエラー応答。

Name Type Description
error

エラー応答
失敗した操作のエラーの詳細を返す、すべての Azure Resource Manager API に対する一般的なエラー応答。 (これは、OData エラー応答形式にも従います)。

DebugSetting

デバッグ設定。

Name Type Description
detailLevel
  • string

デバッグのためにログに記録する情報の種類を指定します。 許可される値は none、requestContent、responseContent、または requestContent と responseContent の両方をコンマで区切って指定します。 既定値は none です。 この値を設定する場合は、デプロイ時に渡す情報の種類を慎重に検討してください。 要求または応答に関する情報をログ記録すると、デプロイ操作で取得される重要なデータを公開する可能性があります。

Dependency

デプロイメントの依存関係情報です。

Name Type Description
dependsOn

依存関係の一覧。

id
  • string

依存関係の ID。

resourceName
  • string

依存関係リソース名。

resourceType
  • string

依存関係リソースの種類。

DeploymentExtended

デプロイメント情報です。

Name Type Description
id
  • string

デプロイの ID。

location
  • string

デプロイの場所。

name
  • string

デプロイの名前。

properties

デプロイメントのプロパティです。

tags
  • object

デプロイ タグ

type
  • string

デプロイの種類。

DeploymentMode

リソースのデプロイに使用されるモード。 この値には、Incremental または Complete のいずれかを指定できます。 Incremental モードでは、テンプレートに含まれていない既存のリソースを削除することなくリソースがデプロイされます。 完全モードでは、リソースがデプロイされ、テンプレートに含まれていないリソース グループ内の既存のリソースが削除されます。 リソースを誤って削除する可能性があるため、完全モードを使用する場合は注意してください。

Name Type Description
Complete
  • string
Incremental
  • string

DeploymentProperties

デプロイメントのプロパティです。

Name Type Description
debugSetting

デプロイのデバッグ設定。

expressionEvaluationOptions

テンプレート式を親テンプレートまたは入れ子になったテンプレートのスコープ内で評価するかどうかを指定します。 入れ子になったテンプレートにのみ適用されます。 指定しない場合、既定値は外側です。

mode

リソースのデプロイに使用されるモード。 この値には、Incremental または Complete のいずれかを指定できます。 Incremental モードでは、テンプレートに含まれていない既存のリソースを削除することなくリソースがデプロイされます。 完全モードでは、リソースがデプロイされ、テンプレートに含まれていないリソース グループ内の既存のリソースが削除されます。 リソースを誤って削除する可能性があるため、完全モードを使用する場合は注意してください。

onErrorDeployment

エラー動作でのデプロイ。

parameters
  • object

テンプレートのデプロイ パラメーターを定義する名前と値のペア。 この要素は、既存のパラメーター ファイルにリンクするのではなく、要求でパラメーター値を直接指定する場合に使用します。 parametersLink プロパティまたは parameters プロパティを使用しますが、両方を使用することはできません。 JObject または整形式の JSON 文字列を指定できます。

parametersLink

パラメーター ファイルの URI。 この要素を使用して、既存のパラメーター ファイルにリンクします。 parametersLink プロパティまたは parameters プロパティを使用しますが、両方を使用することはできません。

template
  • object

テンプレートの内容。 この要素は、既存のテンプレートにリンクするのではなく、要求でテンプレート構文を直接渡す場合に使用します。 JObject または整形式の JSON 文字列を指定できます。 templateLink プロパティまたは template プロパティを使用しますが、両方は使用しないでください。

templateLink

テンプレートの URI。 templateLink プロパティまたは template プロパティを使用しますが、両方は使用しないでください。

DeploymentPropertiesExtended

追加の詳細を含む展開プロパティ。

Name Type Description
correlationId
  • string

デプロイの関連付け ID。

debugSetting

デプロイのデバッグ設定。

dependencies

デプロイの依存関係の一覧。

duration
  • string

テンプレートのデプロイの期間。

error

エラー応答
デプロイ エラー。

mode

デプロイ モード。 指定できる値は、Incremental と Complete です。

onErrorDeployment

エラー動作でのデプロイ。

outputResources

プロビジョニングされたリソースの配列。

outputs
  • object

デプロイ出力を表すキーと値のペア。

parameters
  • object

デプロイのパラメーターです。

parametersLink

パラメーターを参照する URI。

providers

デプロイに必要なリソース プロバイダーの一覧。

provisioningState

プロビジョニングの状態を示します。

templateHash
  • string

テンプレートに対して生成されるハッシュ。

templateLink

テンプレートを参照する URI。

timestamp
  • string

テンプレートデプロイのタイムスタンプ。

validatedResources

検証済みリソースの配列。

ErrorAdditionalInfo

リソース管理エラーの追加情報。

Name Type Description
info
  • object

追加情報。

type
  • string

追加情報の種類。

ErrorResponse

エラー応答

Name Type Description
additionalInfo

エラーの追加情報。

code
  • string

エラー コード。

details

エラーの詳細です。

message
  • string

エラー メッセージ。

target
  • string

エラーターゲット。

ExpressionEvaluationOptions

テンプレート式を親テンプレートまたは入れ子になったテンプレートのスコープ内で評価するかどうかを指定します。

Name Type Description
scope

入れ子になったテンプレート内のパラメーター、変数、関数の評価に使用するスコープ。

ExpressionEvaluationOptionsScopeType

入れ子になったテンプレート内のパラメーター、変数、関数の評価に使用するスコープ。

Name Type Description
Inner
  • string
NotSpecified
  • string
Outer
  • string

OnErrorDeployment

エラー動作でのデプロイ。

Name Type Description
deploymentName
  • string

エラー ケースで使用するデプロイ。

type

エラー動作の種類でのデプロイ。 指定できる値は LastSuccessful と SpecificDeployment です。

OnErrorDeploymentExtended

追加の詳細を含むエラー動作でのデプロイ。

Name Type Description
deploymentName
  • string

エラー ケースで使用するデプロイ。

provisioningState
  • string

エラー時のデプロイのプロビジョニングの状態。

type

エラー動作の種類でのデプロイ。 指定できる値は LastSuccessful と SpecificDeployment です。

OnErrorDeploymentType

エラー動作の種類でのデプロイ。 指定できる値は LastSuccessful と SpecificDeployment です。

Name Type Description
LastSuccessful
  • string
SpecificDeployment
  • string

デプロイ パラメーターへの参照を表すエンティティ。

Name Type Description
contentVersion
  • string

含まれている場合は、テンプレートの ContentVersion と一致する必要があります。

uri
  • string

パラメーター ファイルの URI。

Provider

リソース プロバイダーの情報です。

Name Type Description
id
  • string

プロバイダー ID。

namespace
  • string

リソース プロバイダーの名前空間。

providerAuthorizationConsentState

プロバイダー承認の同意の状態。

registrationPolicy
  • string

リソース プロバイダーの登録ポリシー。

registrationState
  • string

リソース プロバイダーの登録状態。

resourceTypes

プロバイダー リソースの種類のコレクション。

ProviderAuthorizationConsentState

プロバイダー承認の同意の状態。

Name Type Description
Consented
  • string
NotRequired
  • string
NotSpecified
  • string
Required
  • string

ProviderExtendedLocation

プロバイダーの拡張場所。

Name Type Description
extendedLocations
  • string[]

Azure の場所の拡張された場所。

location
  • string

Azure の場所。

type
  • string

拡張場所の種類。

ProviderResourceType

リソース プロバイダーによって管理されるリソースの種類です。

Name Type Description
aliases

このリソースの種類でサポートされているエイリアス。

apiProfiles

リソース プロバイダーの API プロファイル。

apiVersions
  • string[]

API のバージョン。

capabilities
  • string

このリソースの種類によって提供される追加の機能。

defaultApiVersion
  • string

既定の API バージョン。

locationMappings

このリソースの種類でサポートされている場所マッピング。

locations
  • string[]

このリソースの種類を作成できる場所のコレクション。

properties
  • object

プロパティ。

resourceType
  • string

リソースの種類。

zoneMappings

ProvisioningState

プロビジョニングの状態を示します。

Name Type Description
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 モデル。

Name Type Description
id
  • string

完全修飾リソース ID。

ScopedDeployment

デプロイ操作のパラメーター。

Name Type Description
location
  • string

デプロイ データを格納する場所。

properties

配置プロパティです。

tags
  • object

デプロイ タグ

テンプレートへの参照を表すエンティティです。

Name Type Description
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

Name Type Description
location
  • string

ゾーン マッピングの場所。

zones
  • string[]