Deployments - List At Subscription Scope

サブスクリプションのすべてのデプロイを取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/?api-version=2021-04-01
GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/?$filter={$filter}&$top={$top}&api-version=2021-04-01

URI パラメーター

名前 / 必須 説明
subscriptionId
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

DeploymentListResult

OK - デプロイの配列を返します。

Other Status Codes

CloudError

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー

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

Scopes

名前 説明
user_impersonation ユーザー アカウントの借用

定義

名前 説明
Alias

エイリアスの種類。

AliasPath

エイリアスのパスの型。

AliasPathAttributes

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

AliasPathMetadata
AliasPathTokenType

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

AliasPattern

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

AliasPatternType

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

AliasType

エイリアスの型。

ApiProfile
BasicDependency

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

CloudError

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

DebugSetting

デバッグ設定。

Dependency

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

DeploymentExtended

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

DeploymentListResult

デプロイの一覧です。

DeploymentMode

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

DeploymentPropertiesExtended

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

ErrorAdditionalInfo

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

ErrorResponse

エラー応答

OnErrorDeploymentExtended

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

OnErrorDeploymentType

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

ParametersLink

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

Provider

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

ProviderAuthorizationConsentState

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

ProviderExtendedLocation

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

ProviderResourceType

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

ProvisioningState

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

ResourceReference

リソース ID モデル。

TemplateLink

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

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

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

名前 説明
Modifiable

string

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

None

string

別名パスが参照しているトークンには属性がありません。

AliasPathMetadata

名前 説明
attributes

AliasPathAttributes

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

type

AliasPathTokenType

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

AliasPathTokenType

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

名前 説明
Any

string

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

Array

string

トークン型は配列です。

Boolean

string

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

Integer

string

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

NotSpecified

string

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

Number

string

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

Object

string

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

String

string

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

AliasPattern

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

名前 説明
phrase

string

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

type

AliasPatternType

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

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

ErrorResponse

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

DebugSetting

デバッグ設定。

名前 説明
detailLevel

string

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

Dependency

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

名前 説明
dependsOn

BasicDependency[]

依存関係の一覧。

id

string

依存関係の ID。

resourceName

string

依存関係リソース名。

resourceType

string

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

DeploymentExtended

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

名前 説明
id

string

配置の ID。

location

string

デプロイの場所。

name

string

デプロイの名前。

properties

DeploymentPropertiesExtended

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

tags

object

デプロイ タグ

type

string

デプロイの種類。

DeploymentListResult

デプロイの一覧です。

名前 説明
nextLink

string

次の結果セットを取得するために使用する URL。

value

DeploymentExtended[]

デプロイの配列。

DeploymentMode

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

名前 説明
Complete

string

Incremental

string

DeploymentPropertiesExtended

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

名前 説明
correlationId

string

デプロイの関連付け ID。

debugSetting

DebugSetting

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

dependencies

Dependency[]

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

duration

string

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

error

ErrorResponse

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

mode

DeploymentMode

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

onErrorDeployment

OnErrorDeploymentExtended

エラー時の展開の動作。

outputResources

ResourceReference[]

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

outputs

object

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

parameters

object

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

parametersLink

ParametersLink

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

providers

Provider[]

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

provisioningState

ProvisioningState

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

templateHash

string

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

templateLink

TemplateLink

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

timestamp

string

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

validatedResources

ResourceReference[]

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

ErrorAdditionalInfo

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

名前 説明
info

object

追加情報。

type

string

追加情報の種類。

ErrorResponse

エラー応答

名前 説明
additionalInfo

ErrorAdditionalInfo[]

エラーの追加情報。

code

string

エラー コード。

details

ErrorResponse[]

エラーの詳細です。

message

string

エラー メッセージ。

target

string

エラーのターゲット。

OnErrorDeploymentExtended

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

名前 説明
deploymentName

string

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

provisioningState

string

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

type

OnErrorDeploymentType

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

OnErrorDeploymentType

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

名前 説明
LastSuccessful

string

SpecificDeployment

string

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

名前 説明
contentVersion

string

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

uri

string

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

Provider

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

名前 説明
id

string

プロバイダー ID。

namespace

string

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

providerAuthorizationConsentState

ProviderAuthorizationConsentState

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

registrationPolicy

string

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

registrationState

string

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

resourceTypes

ProviderResourceType[]

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

ProviderAuthorizationConsentState

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

名前 説明
Consented

string

NotRequired

string

NotSpecified

string

Required

string

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

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

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

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

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