次の方法で共有


Deployments - Get

デプロイを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}?api-version=2025-04-01

URI パラメーター

名前 / 必須 説明
deploymentName
path True

string

minLength: 1
maxLength: 64
pattern: ^[-\w\._\(\)]+$

デプロイメントの名前。

resourceGroupName
path True

string

リソース グループの名前。

subscriptionId
path True

string

minLength: 1

ターゲット サブスクリプションの ID。

api-version
query True

string

minLength: 1

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

応答

名前 説明
200 OK

DeploymentExtended

Azureの運用は無事に完了しました。

Other Status Codes

CloudError

予期しないエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 Flow.

型: oauth2
フロー: implicit
Authorization URL (承認 URL): https://login.microsoftonline.com/common/oauth2/authorize

スコープ

名前 説明
user_impersonation ユーザー アカウントを偽装する

定義

名前 説明
Alias

エイリアスの種類。

AliasPath

エイリアスのパスの型。

AliasPathAttributes

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

AliasPathMetadata
AliasPathTokenType

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

AliasPattern

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

AliasPatternType

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

AliasType

エイリアスの型。

ApiProfile
BasicDependency

デプロイの依存関係情報。

CloudError

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

createdByType

リソースを作成した ID の種類。

DebugSetting

デバッグ設定。

Dependency

デプロイの依存関係情報。

DeploymentDiagnosticsDefinition
DeploymentExtended

デプロイ情報。

DeploymentExtensionConfigItem
DeploymentExtensionDefinition
DeploymentMode

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

DeploymentPropertiesExtended

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

ErrorAdditionalInfo

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

ErrorResponse

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

ExtensionConfigPropertyType
KeyVaultParameterReference

Azure Key Vault parameter reference.

KeyVaultReference

Azure Key Vault reference.

Level

追加の応答レベルを示します。

OnErrorDeploymentExtended

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

OnErrorDeploymentType

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

ParametersLink

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

Provider

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

ProviderAuthorizationConsentState

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

ProviderExtendedLocation

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

ProviderResourceType

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

ProvisioningState

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

ResourceReference

リソース ID モデル。

systemData

リソースの作成と最後の変更に関連するメタデータ。

TemplateLink

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

ValidationLevel

デプロイメントで実行される検証のレベル。

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

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

説明
None

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

Modifiable

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

AliasPathMetadata

名前 説明
attributes

AliasPathAttributes

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

type

AliasPathTokenType

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

AliasPathTokenType

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

説明
NotSpecified

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

Any

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

String

トークン型は文字列です。

Object

トークン型はオブジェクトです。

Array

トークン型は配列です。

Integer

トークン型は整数です。

Number

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

Boolean

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

AliasPattern

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

名前 説明
phrase

string

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

type

AliasPatternType

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

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

ErrorResponse

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

createdByType

リソースを作成した ID の種類。

説明
User
Application
ManagedIdentity
Key

DebugSetting

デバッグ設定。

名前 説明
detailLevel

string

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

Dependency

デプロイの依存関係情報。

名前 説明
dependsOn

BasicDependency[]

依存関係の一覧。

id

string

依存関係の ID。

resourceName

string

依存関係リソース名。

resourceType

string

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

DeploymentDiagnosticsDefinition

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

level

Level

追加の応答レベルを示します。

message

string

エラー メッセージ。

target

string

エラーターゲット。

DeploymentExtended

デプロイ情報。

名前 説明
id

string

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

location

string

デプロイの場所。

name

string

リソースの名前

properties

DeploymentPropertiesExtended

展開のプロパティ。

systemData

systemData

create By と modifiedBy の情報を含む Azure Resource Manager メタデータ。

tags

object

デプロイ タグ

type

string

リソースの型。 例えば「Microsoft。Compute/virtualMachines」または「Microsoft」などです。ストレージ/ストレージアカウント」

DeploymentExtensionConfigItem

名前 説明
keyVaultReference

KeyVaultParameterReference

拡張設定プロパティの秘密値を取得するために使われたAzure Key Vault参照。

type

ExtensionConfigPropertyType

拡張機能設定プロパティの値の型。

value

拡張構成プロパティの値。

DeploymentExtensionDefinition

名前 説明
alias

string

デプロイメント・テンプレートで定義されている拡張機能の別名。

config

<string,  DeploymentExtensionConfigItem>

拡張機能の構成。

configId

string

拡張機能の構成 ID。 拡張機能内のデプロイ コントロール プレーンを一意に識別します。

name

string

拡張機能の名前。

version

string

拡張機能のバージョン。

DeploymentMode

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

説明
Incremental

インクリメンタル

Complete

完了

DeploymentPropertiesExtended

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

名前 説明
correlationId

string

デプロイの関連付け ID。

debugSetting

DebugSetting

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

dependencies

Dependency[]

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

diagnostics

DeploymentDiagnosticsDefinition[]

検証プロセス中に収集された診断情報が含まれます。

duration

string

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

error

ErrorResponse

デプロイ エラー。

extensions

DeploymentExtensionDefinition[]

このデプロイで使用される拡張機能。

mode

DeploymentMode

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

onErrorDeployment

OnErrorDeploymentExtended

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

outputResources

ResourceReference[]

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

outputs

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

parameters

デプロイ パラメーター。

parametersLink

ParametersLink

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

providers

Provider[]

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

provisioningState

ProvisioningState

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

templateHash

string

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

templateLink

TemplateLink

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

timestamp

string (date-time)

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

validatedResources

ResourceReference[]

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

validationLevel

ValidationLevel

デプロイの検証レベル

ErrorAdditionalInfo

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

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorResponse

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

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorResponse[]

エラーの詳細。

message

string

エラー メッセージ。

target

string

エラーターゲット。

ExtensionConfigPropertyType

説明
String

文字列値を表すプロパティの型。

Int

整数値を表すプロパティの型。

Bool

ブール値を表すプロパティの型。

Array

配列値を表すプロパティの型。

Object

オブジェクト値を表すプロパティの型。

SecureString

セキュリティで保護された文字列値を表すプロパティの種類。

SecureObject

セキュア・オブジェクト値を表すプロパティ・タイプ。

KeyVaultParameterReference

Azure Key Vault parameter reference.

名前 説明
keyVault

KeyVaultReference

Azure Key Vault reference.

secretName

string

Azure Key Vault secret name.

secretVersion

string

Azure Key Vault secret version.

KeyVaultReference

Azure Key Vault reference.

名前 説明
id

string

Azure Key Vault resource id.

Level

追加の応答レベルを示します。

説明
Warning

Warnung

Info

情報

Error

エラー

OnErrorDeploymentExtended

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

名前 説明
deploymentName

string

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

provisioningState

string

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

type

OnErrorDeploymentType

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

OnErrorDeploymentType

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

説明
LastSuccessful

ラストサクトリー

SpecificDeployment

SpecificDeployment

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

名前 説明
contentVersion

string

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

uri

string

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

Provider

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

名前 説明
id

string

プロバイダー ID。

namespace

string

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

providerAuthorizationConsentState

ProviderAuthorizationConsentState

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

registrationPolicy

string

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

registrationState

string

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

resourceTypes

ProviderResourceType[]

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

ProviderAuthorizationConsentState

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

説明
NotSpecified

指定なし

Required

必須

NotRequired

NotRequired

Consented

同意済み

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

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

説明
NotSpecified

指定なし

Accepted

承認済み

Running

Running

Ready

準備完了

Creating

作成

Created

作成済み

Deleting

削除中

Deleted

削除済み

Canceled

取り消し済み

Failed

失敗

Succeeded

成功しました

Updating

更新中

ResourceReference

リソース ID モデル。

名前 説明
apiVersion

string

リソースがデプロイされた API バージョン。

extension

DeploymentExtensionDefinition

リソースがデプロイされた拡張機能。

id

string

完全に適格化されたAzureリソースID。

identifiers

拡張可能なリソース識別子。

resourceType

string

リソースの種類。

systemData

リソースの作成と最後の変更に関連するメタデータ。

名前 説明
createdAt

string (date-time)

リソース作成のタイムスタンプ (UTC)。

createdBy

string

リソースを作成した ID。

createdByType

createdByType

リソースを作成した ID の種類。

lastModifiedAt

string (date-time)

リソースの最終変更のタイムスタンプ (UTC)

lastModifiedBy

string

リソースを最後に変更した ID。

lastModifiedByType

createdByType

リソースを最後に変更した ID の種類。

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

名前 説明
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[]