Microsoft.Resources デプロイ 2023-07-01
[アーティクル] 12/17/2024
2 人の共同作成者
フィードバック
この記事の内容
Bicep の場合は、このリソースの種類ではなく モジュールを使用 検討してください。
Bicep リソース定義
デプロイ リソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.Resources/deployments リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.Resources/deployments@2023-07-01' = {
scope: resourceSymbolicName or scope
location: 'string'
name: 'string'
properties: {
debugSetting: {
detailLevel: 'string'
}
expressionEvaluationOptions: {
scope: 'string'
}
mode: 'string'
onErrorDeployment: {
deploymentName: 'string'
type: 'string'
}
parameters: {
{customized property}: {
reference: {
keyVault: {
id: 'string'
}
secretName: 'string'
secretVersion: 'string'
}
value: any(Azure.Bicep.Types.Concrete.AnyType)
}
}
parametersLink: {
contentVersion: 'string'
uri: 'string'
}
template: any(Azure.Bicep.Types.Concrete.AnyType)
templateLink: {
contentVersion: 'string'
id: 'string'
queryString: 'string'
relativePath: 'string'
uri: 'string'
}
}
tags: {
{customized property}: 'string'
}
}
プロパティ値
DebugSetting
名前
形容
価値
detailLevel
デバッグのためにログに記録する情報の種類を指定します。 許可される値は none、requestContent、responseContent、または requestContent と responseContent の両方でコンマで区切られています。 既定値は none です。 この値を設定するときは、デプロイ時に渡す情報の種類を慎重に検討してください。 要求または応答に関する情報をログに記録することで、展開操作を通じて取得される機密データを公開する可能性があります。
糸
DeploymentParameter
DeploymentPropertiesOrDeploymentPropertiesExtended
名前
形容
価値
debugSetting
デプロイのデバッグ設定。
DebugSetting
expressionEvaluationOptions
親テンプレートのスコープ内でテンプレート式を評価するか、入れ子になったテンプレートを評価するかを指定します。 入れ子になったテンプレートにのみ適用されます。 指定しない場合、既定値は outer です。
ExpressionEvaluationOptions
モード
リソースのデプロイに使用されるモード。 この値には、Incremental または Complete のいずれかを指定できます。 増分モードでは、テンプレートに含まれていない既存のリソースを削除せずにリソースがデプロイされます。 完全モードでは、リソースがデプロイされ、テンプレートに含まれていないリソース グループ内の既存のリソースが削除されます。 リソースを誤って削除する可能性があるため、完全モードを使用する場合は注意してください。
'Complete'
onErrorDeployment
エラー動作でのデプロイ。
OnErrorDeploymentOrOnErrorDeploymentExtended
パラメーター
テンプレートのデプロイ パラメーターを定義する名前と値のペア。 この要素は、既存のパラメーター ファイルへのリンクではなく、要求でパラメーター値を直接指定する場合に使用します。 parametersLink プロパティまたは parameters プロパティを使用しますが、両方を使用することはできません。 JObject または整形式の JSON 文字列を指定できます。
DeploymentPropertiesParameters
parametersLink
パラメーター ファイルの URI。 この要素を使用して、既存のパラメーター ファイルにリンクします。 parametersLink プロパティまたは parameters プロパティを使用しますが、両方を使用することはできません。
ParametersLink
テンプレート
テンプレートの内容。 この要素は、既存のテンプレートへのリンクではなく、要求でテンプレート構文を直接渡す場合に使用します。 JObject または整形式の JSON 文字列を指定できます。 templateLink プロパティまたは template プロパティを使用しますが、両方は使用しないでください。
任意
templateLink
テンプレートの URI。 templateLink プロパティまたは template プロパティを使用しますが、両方は使用しないでください。
TemplateLink
DeploymentPropertiesParameters
ExpressionEvaluationOptions
名前
形容
価値
スコープ
入れ子になったテンプレート内のパラメーター、変数、関数の評価に使用するスコープ。
'Inner'
KeyVaultParameterReference
名前
形容
価値
keyVault
Azure Key Vault リファレンス。
KeyVaultReference (必須)
secretName
Azure Key Vault シークレット名。
string (必須)
secretVersion
Azure Key Vault シークレットのバージョン。
糸
KeyVaultReference
名前
形容
価値
身分証明書
Azure Key Vault リソース ID。
string (必須)
Microsoft.Resources/deployments
名前
形容
価値
場所
デプロイ データを格納する場所。
糸
名前
リソース名
糸^[-\w\._\(\)]+$ (必須)
プロパティ
展開プロパティ。
DeploymentPropertiesOrDeploymentPropertiesExtended (必須)
スコープ
デプロイ スコープとは異なるスコープでリソースを作成するときに使用します。
このプロパティをリソースのシンボリック名に設定して、拡張リソース を適用します。
タグ
リソース タグ
タグ名と値のディクショナリ。 テンプレート の タグを参照してください
OnErrorDeploymentOrOnErrorDeploymentExtended
名前
形容
価値
deploymentName
エラー ケースで使用するデプロイ。
糸
種類
エラー動作の種類でのデプロイ。 指定できる値は LastSuccessful と SpecificDeployment です。
'LastSuccessful'
ParametersLink
名前
形容
価値
contentVersion
含まれている場合は、テンプレートの ContentVersion と一致する必要があります。
糸
uri
パラメーター ファイルの URI。
string (必須)
TemplateLink
名前
形容
価値
contentVersion
含まれている場合は、テンプレートの ContentVersion と一致する必要があります。
糸
身分証明書
テンプレート スペックのリソース ID。id または uri プロパティを使用しますが、両方は使用しないでください。
糸
queryString
templateLink URI で使用するクエリ文字列 (SAS トークンなど)。
糸
relativePath
relativePath プロパティを使用すると、親に対する相対位置にリンクされたテンプレートを配置できます。 親テンプレートが TemplateSpec にリンクされている場合、TemplateSpec 内の成果物が参照されます。 親が URI にリンクされている場合、子デプロイは親 URI と relativePath URI の組み合わせになります。
糸
uri
デプロイするテンプレートの URI。 uri または id プロパティを使用しますが、両方は使用しないでください。
糸
ARM テンプレート リソース定義
デプロイ リソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.Resources/deployments リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.Resources/deployments",
"apiVersion": "2023-07-01",
"name": "string",
"location": "string",
"properties": {
"debugSetting": {
"detailLevel": "string"
},
"expressionEvaluationOptions": {
"scope": "string"
},
"mode": "string",
"onErrorDeployment": {
"deploymentName": "string",
"type": "string"
},
"parameters": {
"{customized property}": {
"reference": {
"keyVault": {
"id": "string"
},
"secretName": "string",
"secretVersion": "string"
},
"value": {}
}
},
"parametersLink": {
"contentVersion": "string",
"uri": "string"
},
"template": {},
"templateLink": {
"contentVersion": "string",
"id": "string",
"queryString": "string",
"relativePath": "string",
"uri": "string"
}
},
"tags": {
"{customized property}": "string"
}
}
プロパティ値
DebugSetting
名前
形容
価値
detailLevel
デバッグのためにログに記録する情報の種類を指定します。 許可される値は none、requestContent、responseContent、または requestContent と responseContent の両方でコンマで区切られています。 既定値は none です。 この値を設定するときは、デプロイ時に渡す情報の種類を慎重に検討してください。 要求または応答に関する情報をログに記録することで、展開操作を通じて取得される機密データを公開する可能性があります。
糸
DeploymentParameter
DeploymentPropertiesOrDeploymentPropertiesExtended
名前
形容
価値
debugSetting
デプロイのデバッグ設定。
DebugSetting
expressionEvaluationOptions
親テンプレートのスコープ内でテンプレート式を評価するか、入れ子になったテンプレートを評価するかを指定します。 入れ子になったテンプレートにのみ適用されます。 指定しない場合、既定値は outer です。
ExpressionEvaluationOptions
モード
リソースのデプロイに使用されるモード。 この値には、Incremental または Complete のいずれかを指定できます。 増分モードでは、テンプレートに含まれていない既存のリソースを削除せずにリソースがデプロイされます。 完全モードでは、リソースがデプロイされ、テンプレートに含まれていないリソース グループ内の既存のリソースが削除されます。 リソースを誤って削除する可能性があるため、完全モードを使用する場合は注意してください。
'Complete'
onErrorDeployment
エラー動作でのデプロイ。
OnErrorDeploymentOrOnErrorDeploymentExtended
パラメーター
テンプレートのデプロイ パラメーターを定義する名前と値のペア。 この要素は、既存のパラメーター ファイルへのリンクではなく、要求でパラメーター値を直接指定する場合に使用します。 parametersLink プロパティまたは parameters プロパティを使用しますが、両方を使用することはできません。 JObject または整形式の JSON 文字列を指定できます。
DeploymentPropertiesParameters
parametersLink
パラメーター ファイルの URI。 この要素を使用して、既存のパラメーター ファイルにリンクします。 parametersLink プロパティまたは parameters プロパティを使用しますが、両方を使用することはできません。
ParametersLink
テンプレート
テンプレートの内容。 この要素は、既存のテンプレートへのリンクではなく、要求でテンプレート構文を直接渡す場合に使用します。 JObject または整形式の JSON 文字列を指定できます。 templateLink プロパティまたは template プロパティを使用しますが、両方は使用しないでください。
任意
templateLink
テンプレートの URI。 templateLink プロパティまたは template プロパティを使用しますが、両方は使用しないでください。
TemplateLink
DeploymentPropertiesParameters
ExpressionEvaluationOptions
名前
形容
価値
スコープ
入れ子になったテンプレート内のパラメーター、変数、関数の評価に使用するスコープ。
'Inner'
KeyVaultParameterReference
名前
形容
価値
keyVault
Azure Key Vault リファレンス。
KeyVaultReference (必須)
secretName
Azure Key Vault シークレット名。
string (必須)
secretVersion
Azure Key Vault シークレットのバージョン。
糸
KeyVaultReference
名前
形容
価値
身分証明書
Azure Key Vault リソース ID。
string (必須)
Microsoft.Resources/deployments
名前
形容
価値
apiVersion
API のバージョン
'2023-07-01'
場所
デプロイ データを格納する場所。
糸
名前
リソース名
糸^[-\w\._\(\)]+$ (必須)
プロパティ
展開プロパティ。
DeploymentPropertiesOrDeploymentPropertiesExtended (必須)
タグ
リソース タグ
タグ名と値のディクショナリ。 テンプレート の タグを参照してください
種類
リソースの種類
'Microsoft.Resources/deployments'
OnErrorDeploymentOrOnErrorDeploymentExtended
名前
形容
価値
deploymentName
エラー ケースで使用するデプロイ。
糸
種類
エラー動作の種類でのデプロイ。 指定できる値は LastSuccessful と SpecificDeployment です。
'LastSuccessful'
ParametersLink
名前
形容
価値
contentVersion
含まれている場合は、テンプレートの ContentVersion と一致する必要があります。
糸
uri
パラメーター ファイルの URI。
string (必須)
TemplateLink
名前
形容
価値
contentVersion
含まれている場合は、テンプレートの ContentVersion と一致する必要があります。
糸
身分証明書
テンプレート スペックのリソース ID。id または uri プロパティを使用しますが、両方は使用しないでください。
糸
queryString
templateLink URI で使用するクエリ文字列 (SAS トークンなど)。
糸
relativePath
relativePath プロパティを使用すると、親に対する相対位置にリンクされたテンプレートを配置できます。 親テンプレートが TemplateSpec にリンクされている場合、TemplateSpec 内の成果物が参照されます。 親が URI にリンクされている場合、子デプロイは親 URI と relativePath URI の組み合わせになります。
糸
uri
デプロイするテンプレートの URI。 uri または id プロパティを使用しますが、両方は使用しないでください。
糸
デプロイ リソースの種類は、次を対象とする操作でデプロイできます。
各 API バージョンで変更されたプロパティの一覧については、変更ログの参照してください。
Microsoft.Resources/deployments リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.Resources/deployments@2023-07-01"
name = "string"
parent_id = "string"
location = "string"
tags = {
{customized property} = "string"
}
body = jsonencode({
properties = {
debugSetting = {
detailLevel = "string"
}
expressionEvaluationOptions = {
scope = "string"
}
mode = "string"
onErrorDeployment = {
deploymentName = "string"
type = "string"
}
parameters = {
{customized property} = {
reference = {
keyVault = {
id = "string"
}
secretName = "string"
secretVersion = "string"
}
value = ?
}
}
parametersLink = {
contentVersion = "string"
uri = "string"
}
template = ?
templateLink = {
contentVersion = "string"
id = "string"
queryString = "string"
relativePath = "string"
uri = "string"
}
}
})
}
プロパティ値
DebugSetting
名前
形容
価値
detailLevel
デバッグのためにログに記録する情報の種類を指定します。 許可される値は none、requestContent、responseContent、または requestContent と responseContent の両方でコンマで区切られています。 既定値は none です。 この値を設定するときは、デプロイ時に渡す情報の種類を慎重に検討してください。 要求または応答に関する情報をログに記録することで、展開操作を通じて取得される機密データを公開する可能性があります。
糸
DeploymentParameter
DeploymentPropertiesOrDeploymentPropertiesExtended
名前
形容
価値
debugSetting
デプロイのデバッグ設定。
DebugSetting
expressionEvaluationOptions
親テンプレートのスコープ内でテンプレート式を評価するか、入れ子になったテンプレートを評価するかを指定します。 入れ子になったテンプレートにのみ適用されます。 指定しない場合、既定値は outer です。
ExpressionEvaluationOptions
モード
リソースのデプロイに使用されるモード。 この値には、Incremental または Complete のいずれかを指定できます。 増分モードでは、テンプレートに含まれていない既存のリソースを削除せずにリソースがデプロイされます。 完全モードでは、リソースがデプロイされ、テンプレートに含まれていないリソース グループ内の既存のリソースが削除されます。 リソースを誤って削除する可能性があるため、完全モードを使用する場合は注意してください。
'Complete'
onErrorDeployment
エラー動作でのデプロイ。
OnErrorDeploymentOrOnErrorDeploymentExtended
パラメーター
テンプレートのデプロイ パラメーターを定義する名前と値のペア。 この要素は、既存のパラメーター ファイルへのリンクではなく、要求でパラメーター値を直接指定する場合に使用します。 parametersLink プロパティまたは parameters プロパティを使用しますが、両方を使用することはできません。 JObject または整形式の JSON 文字列を指定できます。
DeploymentPropertiesParameters
parametersLink
パラメーター ファイルの URI。 この要素を使用して、既存のパラメーター ファイルにリンクします。 parametersLink プロパティまたは parameters プロパティを使用しますが、両方を使用することはできません。
ParametersLink
テンプレート
テンプレートの内容。 この要素は、既存のテンプレートへのリンクではなく、要求でテンプレート構文を直接渡す場合に使用します。 JObject または整形式の JSON 文字列を指定できます。 templateLink プロパティまたは template プロパティを使用しますが、両方は使用しないでください。
任意
templateLink
テンプレートの URI。 templateLink プロパティまたは template プロパティを使用しますが、両方は使用しないでください。
TemplateLink
DeploymentPropertiesParameters
ExpressionEvaluationOptions
名前
形容
価値
スコープ
入れ子になったテンプレート内のパラメーター、変数、関数の評価に使用するスコープ。
'Inner'
KeyVaultParameterReference
名前
形容
価値
keyVault
Azure Key Vault リファレンス。
KeyVaultReference (必須)
secretName
Azure Key Vault シークレット名。
string (必須)
secretVersion
Azure Key Vault シークレットのバージョン。
糸
KeyVaultReference
名前
形容
価値
身分証明書
Azure Key Vault リソース ID。
string (必須)
Microsoft.Resources/deployments
名前
形容
価値
場所
デプロイ データを格納する場所。
糸
名前
リソース名
糸^[-\w\._\(\)]+$ (必須)
parent_id
この拡張リソースを適用するリソースの ID。
string (必須)
プロパティ
展開プロパティ。
DeploymentPropertiesOrDeploymentPropertiesExtended (必須)
タグ
リソース タグ
タグ名と値のディクショナリ。
種類
リソースの種類
"Microsoft.Resources/deployments@2023-07-01"
OnErrorDeploymentOrOnErrorDeploymentExtended
名前
形容
価値
deploymentName
エラー ケースで使用するデプロイ。
糸
種類
エラー動作の種類でのデプロイ。 指定できる値は LastSuccessful と SpecificDeployment です。
'LastSuccessful'
ParametersLink
名前
形容
価値
contentVersion
含まれている場合は、テンプレートの ContentVersion と一致する必要があります。
糸
uri
パラメーター ファイルの URI。
string (必須)
TemplateLink
名前
形容
価値
contentVersion
含まれている場合は、テンプレートの ContentVersion と一致する必要があります。
糸
身分証明書
テンプレート スペックのリソース ID。id または uri プロパティを使用しますが、両方は使用しないでください。
糸
queryString
templateLink URI で使用するクエリ文字列 (SAS トークンなど)。
糸
relativePath
relativePath プロパティを使用すると、親に対する相対位置にリンクされたテンプレートを配置できます。 親テンプレートが TemplateSpec にリンクされている場合、TemplateSpec 内の成果物が参照されます。 親が URI にリンクされている場合、子デプロイは親 URI と relativePath URI の組み合わせになります。
糸
uri
デプロイするテンプレートの URI。 uri または id プロパティを使用しますが、両方は使用しないでください。
糸