Deployments - List By Resource Group
リソース グループのすべてのデプロイを取得します。
GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/?api-version=2025-04-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/?$filter={$filter}&$top={$top}&api-version=2025-04-01
URI パラメーター
| 名前 | / | 必須 | 型 | 説明 |
|---|---|---|---|---|
|
resource
|
path | True |
string minLength: 1maxLength: 90 pattern: ^[-\w\._\(\)]+$ |
取得するデプロイを含むリソース グループの名前。 名前は大文字と小文字が区別されます。 |
|
subscription
|
path | True |
string |
Microsoft Azure サブスクリプション ID。 |
|
api-version
|
query | True |
string |
この操作に使用する API バージョン。 |
|
$filter
|
query |
string |
操作に適用するフィルター。 たとえば、$filter=provisioningState eq '{state}' を使用できます。 |
|
|
$top
|
query |
integer (int32) |
取得する結果の数。 null が渡された場合は、すべてのデプロイを返します。 |
応答
| 名前 | 型 | 説明 |
|---|---|---|
| 200 OK |
OK - デプロイの配列を返します。 |
|
| Other Status Codes |
操作が失敗した理由を説明するエラー応答。 |
セキュリティ
azure_auth
Azure Active Directory OAuth2 フロー
型:
oauth2
フロー:
implicit
Authorization URL (承認 URL):
https://login.microsoftonline.com/common/oauth2/authorize
スコープ
| 名前 | 説明 |
|---|---|
| user_impersonation | ユーザー アカウントを偽装する |
定義
| 名前 | 説明 |
|---|---|
| Alias |
エイリアスの種類。 |
|
Alias |
エイリアスのパスの型。 |
|
Alias |
エイリアス パスが参照しているトークンの属性。 |
|
Alias |
|
|
Alias |
エイリアス パスが参照しているトークンの型。 |
|
Alias |
エイリアス パスのパターンの型。 |
|
Alias |
エイリアス パターンの種類 |
|
Alias |
エイリアスの型。 |
|
Api |
|
|
Basic |
デプロイの依存関係情報。 |
|
Cloud |
リソース管理要求のエラー応答。 |
|
Debug |
デバッグ設定。 |
| Dependency |
デプロイの依存関係情報。 |
|
Deployment |
|
|
Deployment |
デプロイ情報。 |
|
Deployment |
|
|
Deployment |
|
|
Deployment |
デプロイの一覧。 |
|
Deployment |
リソースのデプロイに使用されるモード。 この値には、Incremental または Complete のいずれかを指定できます。 増分モードでは、テンプレートに含まれていない既存のリソースを削除せずにリソースがデプロイされます。 完全モードでは、リソースがデプロイされ、テンプレートに含まれていないリソース グループ内の既存のリソースが削除されます。 リソースを誤って削除する可能性があるため、完全モードを使用する場合は注意してください。 |
|
Deployment |
追加の詳細を含む展開プロパティ。 |
|
Error |
リソース管理エラーの追加情報。 |
|
Error |
エラー応答 |
|
Extension |
|
|
Key |
Azure Key Vault パラメーターリファレンス。 |
|
Key |
Azure Key Vault リファレンス。 |
| Level |
追加の応答レベルを示します。 |
|
On |
追加の詳細を含むエラー動作でのデプロイ。 |
|
On |
エラー動作の種類でのデプロイ。 指定できる値は LastSuccessful と SpecificDeployment です。 |
|
Parameters |
デプロイ パラメーターへの参照を表すエンティティ。 |
| Provider |
リソース プロバイダー情報。 |
|
Provider |
プロバイダー承認の同意の状態。 |
|
Provider |
プロバイダーの拡張場所。 |
|
Provider |
リソース プロバイダーによって管理されるリソースの種類。 |
|
Provisioning |
プロビジョニングの状態を示します。 |
|
Resource |
リソース ID モデル。 |
|
Template |
テンプレートへの参照を表すエンティティ。 |
|
Validation |
デプロイメントで実行される検証のレベル。 |
|
Zone |
Alias
エイリアスの種類。
| 名前 | 型 | 説明 |
|---|---|---|
| defaultMetadata |
既定のエイリアス パスのメタデータ。 既定のパスと、メタデータを持たないエイリアス パスに適用されます |
|
| defaultPath |
string |
エイリアスの既定のパス。 |
| defaultPattern |
エイリアスの既定のパターン。 |
|
| name |
string |
エイリアス名。 |
| paths |
エイリアスのパス。 |
|
| type |
エイリアスの型。 |
AliasPath
エイリアスのパスの型。
| 名前 | 型 | 説明 |
|---|---|---|
| apiVersions |
string[] |
API のバージョン。 |
| metadata |
エイリアス パスのメタデータ。 存在しない場合は、エイリアスの既定のメタデータにフォールバックします。 |
|
| path |
string |
エイリアスのパス。 |
| pattern |
エイリアス パスのパターン。 |
AliasPathAttributes
エイリアス パスが参照しているトークンの属性。
| 値 | 説明 |
|---|---|
| None |
エイリアス パスが参照しているトークンには属性がありません。 |
| Modifiable |
エイリアス パスが参照しているトークンは、'modify' 効果を持つポリシーによって変更できます。 |
AliasPathMetadata
| 名前 | 型 | 説明 |
|---|---|---|
| attributes |
エイリアス パスが参照しているトークンの属性。 |
|
| type |
エイリアス パスが参照しているトークンの型。 |
AliasPathTokenType
エイリアス パスが参照しているトークンの型。
| 値 | 説明 |
|---|---|
| NotSpecified |
トークンの種類が指定されていません。 |
| Any |
トークンの種類は何でもかまいません。 |
| String |
トークン型は文字列です。 |
| Object |
トークン型はオブジェクトです。 |
| Array |
トークン型は配列です。 |
| Integer |
トークン型は整数です。 |
| Number |
トークンの種類は数値です。 |
| Boolean |
トークンの種類はブール値です。 |
AliasPattern
エイリアス パスのパターンの型。
| 名前 | 型 | 説明 |
|---|---|---|
| phrase |
string |
エイリアス パターン フレーズ。 |
| type |
エイリアス パターンの種類 |
|
| variable |
string |
エイリアス パターン変数。 |
AliasPatternType
エイリアス パターンの種類
| 値 | 説明 |
|---|---|
| NotSpecified |
NotSpecified は許可されていません。 |
| Extract |
抽出は、唯一の許容値です。 |
AliasType
エイリアスの型。
| 値 | 説明 |
|---|---|
| NotSpecified |
エイリアスの種類が不明です (エイリアス型を指定しない場合と同じです)。 |
| PlainText |
エイリアス値はシークレットではありません。 |
| Mask |
エイリアス値はシークレットです。 |
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 |
依存関係リソースの種類。 |
DeploymentDiagnosticsDefinition
| 名前 | 型 | 説明 |
|---|---|---|
| additionalInfo |
エラーの追加情報。 |
|
| code |
string |
エラー コード。 |
| level |
追加の応答レベルを示します。 |
|
| message |
string |
エラー メッセージ。 |
| target |
string |
エラーターゲット。 |
DeploymentExtended
デプロイ情報。
| 名前 | 型 | 説明 |
|---|---|---|
| id |
string |
デプロイの ID。 |
| ___location |
string |
デプロイの場所。 |
| name |
string |
デプロイメントの名前。 |
| properties |
展開のプロパティ。 |
|
| tags |
object |
デプロイ タグ |
| type |
string |
デプロイの種類。 |
DeploymentExtensionConfigItem
| 名前 | 型 | 説明 |
|---|---|---|
| keyVaultReference |
拡張機能の config プロパティのシークレット値を取得するために使用される Azure Key Vault 参照。 |
|
| type |
拡張機能設定プロパティの値の型。 |
|
| value |
拡張構成プロパティの値。 |
DeploymentExtensionDefinition
| 名前 | 型 | 説明 |
|---|---|---|
| alias |
string |
デプロイメント・テンプレートで定義されている拡張機能の別名。 |
| config |
<string,
Deployment |
拡張機能の構成。 |
| configId |
string |
拡張機能の構成 ID。 拡張機能内のデプロイ コントロール プレーンを一意に識別します。 |
| name |
string |
拡張機能の名前。 |
| version |
string |
拡張機能のバージョン。 |
DeploymentListResult
デプロイの一覧。
| 名前 | 型 | 説明 |
|---|---|---|
| nextLink |
string |
次の結果セットの取得に使用する URL。 |
| value |
デプロイの配列。 |
DeploymentMode
リソースのデプロイに使用されるモード。 この値には、Incremental または Complete のいずれかを指定できます。 増分モードでは、テンプレートに含まれていない既存のリソースを削除せずにリソースがデプロイされます。 完全モードでは、リソースがデプロイされ、テンプレートに含まれていないリソース グループ内の既存のリソースが削除されます。 リソースを誤って削除する可能性があるため、完全モードを使用する場合は注意してください。
| 値 | 説明 |
|---|---|
| Incremental | |
| Complete |
DeploymentPropertiesExtended
追加の詳細を含む展開プロパティ。
| 名前 | 型 | 説明 |
|---|---|---|
| correlationId |
string |
デプロイの関連付け ID。 |
| debugSetting |
デプロイのデバッグ設定。 |
|
| dependencies |
デプロイの依存関係の一覧。 |
|
| diagnostics |
検証プロセス中に収集された診断情報が含まれます。 |
|
| duration |
string |
テンプレートのデプロイの期間。 |
| error |
エラー応答 |
|
| extensions |
このデプロイで使用される拡張機能。 |
|
| mode |
デプロイ モード。 指定できる値は Incremental と Complete です。 |
|
| onErrorDeployment |
エラー動作でのデプロイ。 |
|
| outputResources |
プロビジョニングされたリソースの配列。 |
|
| outputs |
object |
デプロイの出力を表すキーと値のペア。 |
| parameters |
object |
デプロイ パラメーター。 |
| parametersLink |
パラメーターを参照する URI。 |
|
| providers |
Provider[] |
デプロイに必要なリソース プロバイダーの一覧。 |
| provisioningState |
プロビジョニングの状態を示します。 |
|
| templateHash |
string |
テンプレートに対して生成されたハッシュ。 |
| templateLink |
テンプレートを参照する URI。 |
|
| timestamp |
string (date-time) |
テンプレートデプロイのタイムスタンプ。 |
| validatedResources |
検証済みリソースの配列。 |
|
| validationLevel |
デプロイの検証レベル |
ErrorAdditionalInfo
リソース管理エラーの追加情報。
| 名前 | 型 | 説明 |
|---|---|---|
| info |
object |
追加情報。 |
| type |
string |
追加情報の種類。 |
ErrorResponse
エラー応答
| 名前 | 型 | 説明 |
|---|---|---|
| additionalInfo |
エラーの追加情報。 |
|
| code |
string |
エラー コード。 |
| details |
エラーの詳細。 |
|
| message |
string |
エラー メッセージ。 |
| target |
string |
エラーターゲット。 |
ExtensionConfigPropertyType
| 値 | 説明 |
|---|---|
| String |
文字列値を表すプロパティの型。 |
| Int |
整数値を表すプロパティの型。 |
| Bool |
ブール値を表すプロパティの型。 |
| Array |
配列値を表すプロパティの型。 |
| Object |
オブジェクト値を表すプロパティの型。 |
| SecureString |
セキュリティで保護された文字列値を表すプロパティの種類。 |
| SecureObject |
セキュア・オブジェクト値を表すプロパティ・タイプ。 |
KeyVaultParameterReference
Azure Key Vault パラメーターリファレンス。
| 名前 | 型 | 説明 |
|---|---|---|
| keyVault |
Azure Key Vault リファレンス。 |
|
| secretName |
string |
Azure Key Vault シークレット名。 |
| secretVersion |
string |
Azure Key Vault シークレットのバージョン。 |
KeyVaultReference
Azure Key Vault リファレンス。
| 名前 | 型 | 説明 |
|---|---|---|
| id |
string |
Azure Key Vault リソース ID。 |
Level
追加の応答レベルを示します。
| 値 | 説明 |
|---|---|
| Warning | |
| Info | |
| Error |
OnErrorDeploymentExtended
追加の詳細を含むエラー動作でのデプロイ。
| 名前 | 型 | 説明 |
|---|---|---|
| deploymentName |
string |
エラー ケースで使用するデプロイ。 |
| provisioningState |
string |
エラー時のデプロイのプロビジョニングの状態。 |
| type |
エラー動作の種類でのデプロイ。 指定できる値は LastSuccessful と SpecificDeployment です。 |
OnErrorDeploymentType
エラー動作の種類でのデプロイ。 指定できる値は LastSuccessful と SpecificDeployment です。
| 値 | 説明 |
|---|---|
| LastSuccessful | |
| SpecificDeployment |
ParametersLink
デプロイ パラメーターへの参照を表すエンティティ。
| 名前 | 型 | 説明 |
|---|---|---|
| contentVersion |
string |
含まれている場合は、テンプレートの ContentVersion と一致する必要があります。 |
| uri |
string |
パラメーター ファイルの URI。 |
Provider
リソース プロバイダー情報。
| 名前 | 型 | 説明 |
|---|---|---|
| id |
string |
プロバイダー ID。 |
| namespace |
string |
リソース プロバイダーの名前空間。 |
| providerAuthorizationConsentState |
プロバイダー承認の同意の状態。 |
|
| registrationPolicy |
string |
リソース プロバイダーの登録ポリシー。 |
| registrationState |
string |
リソース プロバイダーの登録状態。 |
| resourceTypes |
プロバイダー リソースの種類のコレクション。 |
ProviderAuthorizationConsentState
プロバイダー承認の同意の状態。
| 値 | 説明 |
|---|---|
| NotSpecified | |
| Required | |
| NotRequired | |
| Consented |
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
プロビジョニングの状態を示します。
| 値 | 説明 |
|---|---|
| NotSpecified | |
| Accepted | |
| Running | |
| Ready | |
| Creating | |
| Created | |
| Deleting | |
| Deleted | |
| Canceled | |
| Failed | |
| Succeeded | |
| Updating |
ResourceReference
リソース ID モデル。
| 名前 | 型 | 説明 |
|---|---|---|
| apiVersion |
string |
リソースがデプロイされた API バージョン。 |
| extension |
リソースがデプロイされた拡張機能。 |
|
| id |
string |
完全修飾 Azure リソース ID。 |
| identifiers |
object |
拡張可能なリソース識別子。 |
| resourceType |
string |
リソースの種類。 |
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 プロパティを使用しますが、両方は使用しないでください。 |
ValidationLevel
デプロイメントで実行される検証のレベル。
| 値 | 説明 |
|---|---|
| Template |
テンプレートの静的解析が実行されます。 |
| Provider |
テンプレートの静的分析が実行され、セマンティック検証のためにリソース宣言がリソース プロバイダーに送信されます。 呼び出し元が各リソースに対する RBAC 書き込みアクセス許可を持っていることを検証します。 |
| ProviderNoRbac |
テンプレートの静的分析が実行され、セマンティック検証のためにリソース宣言がリソース プロバイダーに送信されます。 呼び出し元が各リソースに対する RBAC 書き込みアクセス許可を持っているかどうかの検証をスキップします。 |
ZoneMapping
| 名前 | 型 | 説明 |
|---|---|---|
| ___location |
string |
ゾーン マッピングの場所。 |
| zones |
string[] |