Azure Resource Manager

Azure Resource Manager により API が公開され、すべての Azure リソースが管理されます。

このコネクタは、次の製品および地域で利用可能です。

サービス クラス リージョン
Logic Apps 標準 すべての Logic Apps 地域
Power Automate プレミアム すべての Power Automate 地域
Power Apps プレミアム すべての Power Apps 地域
Contact
件名 マイクロソフト
URL Microsoft LogicApps サポート
Microsoft Power Automate サポート
Microsoft Power Apps サポート
コネクタ メタデータ
公開元 Microsoft
Web サイト https://azure.microsoft.com/features/resource-manager/

既知の問題と制限事項

エラーが発生して "APIM トークン ヘッダーでつながり参照名 'shared_office365' の有効なつながりが見つかりませんでした" というメッセージが表示された場合は、以下を実行してトラブルシューティングを行うことができます:

  • ブラウザーのキャッシュをクリアします。
  • 接続を削除し、再追加します。

サブスクリプション リソース タグの一覧表示アクションでは、タグ データを管理する基盤となるサービス内の制限により、削除されたタグ データがプルされる場合があります。 回避策として、Http コネクタを使用して Azure Resource Graph(https://learn.microsoft.com/en-us/rest/api/azureresourcegraph/resourcegraph/resources/resources?view=rest-azureresourcegraph-resourcegraph-2022-10-01&tabs=HTTP) 呼び出しを使用します。

接続を作成する

このコネクタは、次の認証タイプをサポートしています:

既定 接続を作成するためのパラメーター。 すべての地域 共有不可

既定

適用できるもの: すべての領域

接続を作成するためのパラメーター。

これは共有可能な接続ではありません。 パワー アプリが別のユーザーと共有されている場合、別のユーザーは新しい接続を明示的に作成するように求められます。

調整制限

名前 呼び出し 更新期間
接続ごとの API 呼び出し 1200 60 秒

アクション

サブスクリプション リソース タグを一覧表示する

すべてのサブスクリプション リソース タグを一覧表示します。

サブスクリプション リソース タグ値を作成または更新する

サブスクリプション リソース タグ値を作成または更新します。

サブスクリプション リソース タグ値を削除する

サブスクリプション リソース タグ値を削除します。

サブスクリプション リソース タグ名を作成または更新する

サブスクリプション リソース タグ名を作成または更新します。

サブスクリプション リソース タグ名を削除する

サブスクリプション リソース タグ名を削除します。

サブスクリプションごとにリソースを一覧表示する

特定のサブスクリプションの下にあるすべてのリソースを読み取ります。 結果は 1,000 以上のレコードでページ分割されます。

サブスクリプションの場所を一覧表示する

サブスクリプションに使用できる場所を一覧表示します。

サブスクリプションを一覧表示する

プリンシパルがアクセスできるすべてのサブスクリプションの一覧を取得します。

サブスクリプションを読み取る

特定のサブスクリプションの詳細を読み取ります。

テンプレート展開をキャンセルする

現在実行中のテンプレート展開をキャンセルします。 保留中のすべてのテンプレート操作は一時停止されます。

テンプレート展開を一覧表示する

すべてのリソース グループのテンプレート展開を一覧表示します。 この操作は、この時点までに何がプロビジョニングされたかを知るのに役立ちます。

テンプレート展開を作成または更新する

名前付きリソース グループのテンプレート展開を作成または更新します。 要求が成功するには、テンプレートとパラメーターが必要です。

テンプレート展開を削除する

リソース グループのテンプレート展開を削除します。 テンプレート展開に関するメタデータのみが削除され、リソースは削除されません。

テンプレート展開を検証する

展開テンプレートを検証します。 この操作には副作用がなく、構文エラーまたは論理エラーのテンプレート展開をテストするために使用できます。

テンプレート展開を読み取る

リソース グループ内のテンプレート展開を読み取ります。

テンプレート展開操作を一覧表示する

すべてのテンプレート展開操作を一覧表示します。 これは、失敗したテンプレート展開のトラブルシューティングに役立ちます。

テンプレート展開操作を読み取る

特定のリソース グループのテンプレート展開操作を読み取ります。 これは、失敗したテンプレート展開のトラブルシューティングに役立ちます。

プロバイダーでリソース操作を呼び出す

Azure リソースで操作を呼び出します。

プロバイダーのリソースを読み取る

リソース オブジェクトを読み取ります。

リソース グループ テンプレートをエクスポートする

既存のリソース グループから展開テンプレートをエクスポートします。 これは、基になるリソースに Microsoft により定義されたスキーマがある場合にのみ成功します。

リソース グループごとにリソースを一覧表示する

リソース グループの下にあるすべてのリソースを一覧表示します。

リソース グループの作成または更新

リソース グループを作成または更新します。 応答コードを使用して、作成 (201) または更新 (200) を区別できます。

リソース グループを一覧表示する

サブスクリプション内のすべてのリソース グループを一覧表示します。 結果は 1,000 以上のレコードでページ分割されます。

リソース グループを削除する

サブスクリプション内の特定のリソース グループを削除します。

リソース グループを読み取る

サブスクリプション内の特定のリソース グループを読み取ります。

リソース プロバイダーの登録を解除する

プロバイダーをサブスクリプションから登録解除します。 サブスクリプションにそのリソース プロバイダーからのリソースがある場合、この操作は失敗します。

リソース プロバイダーを一覧表示する

サブスクリプションに使用できるリソース プロバイダーを一覧表示します。

リソース プロバイダーを登録する

サブスクリプションで使用するリソース プロバイダーを登録します。 これにより、サービスに対するアクセス許可がサブスクリプションにプロビジョニングされます。

リソース プロバイダーを読み取る

サブスクリプション内の特定のリソース プロバイダーを読み取ります。

リソースを作成または更新する

リソースを作成または更新します。 応答コードを使用して、作成 (201) または更新 (200) を区別できます。

リソースを削除する

リソースを削除します。

リソースを読み取る

リソース オブジェクトを読み取ります。

リソース操作を呼び出す

Azure リソースで操作を呼び出します。

展開テンプレートのエクスポート

過去のリソース グループ展開からテンプレートをエクスポートします。

既存のリソース グループを更新する

既存のリソース グループを更新します。 リソースが存在しない場合、この要求は失敗します。

サブスクリプション リソース タグを一覧表示する

すべてのサブスクリプション リソース タグを一覧表示します。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

戻り値

サブスクリプション タグの一覧。

本文​​
TagsListResult

サブスクリプション リソース タグ値を作成または更新する

サブスクリプション リソース タグ値を作成または更新します。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

タグ名
tagName True string

タグの名前。

タグ値
tagValue True string

タグの値です。

戻り値

タグ情報。

本文​​
TagValue

サブスクリプション リソース タグ値を削除する

サブスクリプション リソース タグ値を削除します。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

タグ名
tagName True string

タグの名前。

タグ値
tagValue True string

タグの値です。

サブスクリプション リソース タグ名を作成または更新する

サブスクリプション リソース タグ名を作成または更新します。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

タグ名
tagName True string

タグの名前。

戻り値

タグの詳細。

本文​​
TagDetails

サブスクリプション リソース タグ名を削除する

サブスクリプション リソース タグ名を削除します。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

タグ名
tagName True string

タグの名前。

サブスクリプションごとにリソースを一覧表示する

特定のサブスクリプションの下にあるすべてのリソースを読み取ります。 結果は 1,000 以上のレコードでページ分割されます。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

フィルター​​
$filter string

操作に適用するフィルター。

展開する
$expand string

$expand クエリ パラメーター。

上詰め
$top integer

クエリ パラメーター。 何も渡されない場合、すべての値が返されます。

戻り値

リソースの一覧。

本文​​
ResourceListResult

サブスクリプションの場所を一覧表示する

サブスクリプションに使用できる場所を一覧表示します。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

戻り値

場所一覧の操作応答。

本文​​
LocationListResult

サブスクリプションを一覧表示する

プリンシパルがアクセスできるすべてのサブスクリプションの一覧を取得します。

戻り値

サブスクリプション一覧の操作応答。

本文​​
SubscriptionListResult

サブスクリプションを読み取る

特定のサブスクリプションの詳細を読み取ります。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

戻り値

サブスクリプション情報。

本文​​
Subscription

テンプレート展開をキャンセルする

現在実行中のテンプレート展開をキャンセルします。 保留中のすべてのテンプレート操作は一時停止されます。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

リソース グループ
resourceGroupName True string

リソース グループ名。

展開名
deploymentName True string

リソース グループのテンプレート展開の名前。

テンプレート展開を一覧表示する

すべてのリソース グループのテンプレート展開を一覧表示します。 この操作は、この時点までに何がプロビジョニングされたかを知るのに役立ちます。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

リソース グループ
resourceGroupName True string

リソース グループ名。

フィルター​​
$filter string

操作に適用するフィルター。

上詰め
$top integer

クエリ パラメーター。 何も渡されない場合、すべての値が返されます。

戻り値

展開の一覧。

本文​​
DeploymentListResult

テンプレート展開を作成または更新する

名前付きリソース グループのテンプレート展開を作成または更新します。 要求が成功するには、テンプレートとパラメーターが必要です。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

リソース グループ
resourceGroupName True string

リソース グループ名。

Deployment Name
deploymentName True string

展開の名前。

テンプレートの内容
template object

テンプレートのコンテンツ。 JObject または整形式の JSON 文字列にすることができます。 Template または TemplateLink のいずれかのみを使用します。

テンプレート URI
uri True string

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

テンプレート コンテンツ バージョン
contentVersion string

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

Parameters
parameters object

展開パラメーター。 JObject または整形式の JSON 文字列にすることができます。 Parameters または ParametersLink のいずれかのみを使用します。

パラメーター URI
uri True string

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

パラメーター コンテンツ バージョン
contentVersion string

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

展開モード
mode True string

展開モード。

詳細レベル
detailLevel string

デバッグの詳細レベル。

展開の待機
wait boolean

展開が完了するまでアクションを待機する必要がある場合

戻り値

展開の情報。

本文​​
DeploymentExtended

テンプレート展開を削除する

リソース グループのテンプレート展開を削除します。 テンプレート展開に関するメタデータのみが削除され、リソースは削除されません。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

リソース グループ
resourceGroupName True string

リソース グループ名。

展開名
deploymentName True string

リソース グループのテンプレート展開の名前。

テンプレート展開を検証する

展開テンプレートを検証します。 この操作には副作用がなく、構文エラーまたは論理エラーのテンプレート展開をテストするために使用できます。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

リソース グループ
resourceGroupName True string

リソース グループ名。

展開名
deploymentName True string

リソース グループのテンプレート展開の名前。

テンプレートの内容
template object

テンプレートのコンテンツ。 JObject または整形式の JSON 文字列にすることができます。 Template または TemplateLink のいずれかのみを使用します。

テンプレート URI
uri True string

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

テンプレート コンテンツ バージョン
contentVersion string

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

Parameters
parameters object

展開パラメーター。 JObject または整形式の JSON 文字列にすることができます。 Parameters または ParametersLink のいずれかのみを使用します。

パラメーター URI
uri True string

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

パラメーター コンテンツ バージョン
contentVersion string

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

展開モード
mode True string

展開モード。

詳細レベル
detailLevel string

デバッグの詳細レベル。

戻り値

テンプレート展開応答の検証からの情報。

テンプレート展開を読み取る

リソース グループ内のテンプレート展開を読み取ります。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

リソース グループ
resourceGroupName True string

リソース グループ名。

展開名
deploymentName True string

リソース グループのテンプレート展開の名前。

展開の待機
wait boolean

展開が完了するまでアクションを待機する必要がある場合

戻り値

展開情報。

本文​​
DeploymentExtended

テンプレート展開操作を一覧表示する

すべてのテンプレート展開操作を一覧表示します。 これは、失敗したテンプレート展開のトラブルシューティングに役立ちます。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

リソース グループ
resourceGroupName True string

リソース グループ名。

展開名
deploymentName True string

リソース グループのテンプレート展開の名前。

上詰め
$top integer

クエリ パラメーター。 何も渡されない場合、すべての値が返されます。

戻り値

展開操作の一覧。

テンプレート展開操作を読み取る

特定のリソース グループのテンプレート展開操作を読み取ります。 これは、失敗したテンプレート展開のトラブルシューティングに役立ちます。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

リソース グループ
resourceGroupName True string

リソース グループ名。

展開名
deploymentName True string

リソース グループのテンプレート展開の名前。

操作 ID
operationId True string

操作 ID。

戻り値

展開操作の情報。

本文​​
DeploymentOperation

プロバイダーでリソース操作を呼び出す

Azure リソースで操作を呼び出します。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

リソース プロバイダー
resourceProviderNamespace True string

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

短いリソース ID
shortResourceId True string

リソース名とリソースの種類を含む、リソースの短い ID。 たとえば、sites/mySite

クライアント API バージョン
x-ms-api-version True string

使用する API バージョン。

戻り値

操作からの応答。

回答
object

プロバイダーのリソースを読み取る

リソース オブジェクトを読み取ります。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

リソース プロバイダー
resourceProviderNamespace True string

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

短いリソース ID
shortResourceId True string

リソース名とリソースの種類を含む、リソースの短い ID。 たとえば、sites/mySite

クライアント API バージョン
x-ms-api-version True string

使用する API バージョン。

戻り値

リソース情報。

本文​​
GenericResource

リソース グループ テンプレートをエクスポートする

既存のリソース グループから展開テンプレートをエクスポートします。 これは、基になるリソースに Microsoft により定義されたスキーマがある場合にのみ成功します。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

リソース グループ
resourceGroupName True string

リソース グループ名。

resources
resources array of string

リソースの ID。 現在サポートされている文字列は '*' (すべてのリソース) のみです。 将来の API 更新プログラムでは、特定のリソースのエクスポートがサポートされる予定です。

オプション
options string

エクスポート テンプレート オプション。 サポートされている値には、'IncludeParameterDefaultValue'、'IncludeComments' または 'IncludeParameterDefaultValue、IncludeComments が含まれます

戻り値

リソース グループごとにリソースを一覧表示する

リソース グループの下にあるすべてのリソースを一覧表示します。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

リソース グループ
resourceGroupName True string

リソース グループ名。

フィルター​​
$filter string

操作に適用するフィルター。

展開する
$expand string

$expand クエリ パラメーター。

上詰め
$top integer

クエリ パラメーター。 何も渡されない場合、すべての値が返されます。

戻り値

リソースの一覧。

本文​​
ResourceListResult

リソース グループの作成または更新

リソース グループを作成または更新します。 応答コードを使用して、作成 (201) または更新 (200) を区別できます。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

リソース グループ名
resourceGroupName True string

作成または更新するリソース グループの名前。

ID
id string

リソース グループの ID (例: /subscriptions/XXX/resourceGroups/YYY)。

件名
name string

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

場所
location True string

リソース グループの場所。 リソース グループの作成後に変更することはできません。 米国西部、米国東部、西ヨーロッパ、東アジアなど、サポートされている Azure の場所の 1 つである必要があります。

管理者
managedBy string

このリソース グループを管理するリソースの ID。

Tags
tags object

リソース グループに添付されたタグ。

プロビジョニングの状態
provisioningState string

プロビジョニングの状態。

戻り値

リソース グループの情報。

本文​​
ResourceGroup

リソース グループを一覧表示する

サブスクリプション内のすべてのリソース グループを一覧表示します。 結果は 1,000 以上のレコードでページ分割されます。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

フィルター​​
$filter string

操作に適用するフィルター。

上詰め
$top integer

クエリ パラメーター。 何も渡されない場合、すべての値が返されます。

戻り値

リソース グループの一覧。

リソース グループを削除する

サブスクリプション内の特定のリソース グループを削除します。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

リソース グループ
resourceGroupName True string

リソース グループ名。

リソース グループを読み取る

サブスクリプション内の特定のリソース グループを読み取ります。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

リソース グループ
resourceGroupName True string

リソース グループ名。

戻り値

リソース グループの情報。

本文​​
ResourceGroup

リソース プロバイダーの登録を解除する

プロバイダーをサブスクリプションから登録解除します。 サブスクリプションにそのリソース プロバイダーからのリソースがある場合、この操作は失敗します。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

リソース プロバイダー
resourceProviderNamespace True string

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

戻り値

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

本文​​
Provider

リソース プロバイダーを一覧表示する

サブスクリプションに使用できるリソース プロバイダーを一覧表示します。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

上詰め
$top integer

クエリ パラメーター。 何も渡されない場合、すべての値が返されます。

展開する
$expand string

$expand クエリ パラメーター。

戻り値

リソース プロバイダーの一覧。

本文​​
ProviderListResult

リソース プロバイダーを登録する

サブスクリプションで使用するリソース プロバイダーを登録します。 これにより、サービスに対するアクセス許可がサブスクリプションにプロビジョニングされます。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

リソース プロバイダー
resourceProviderNamespace True string

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

戻り値

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

本文​​
Provider

リソース プロバイダーを読み取る

サブスクリプション内の特定のリソース プロバイダーを読み取ります。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

リソース プロバイダー
resourceProviderNamespace True string

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

展開する
$expand string

$expand クエリ パラメーター。

戻り値

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

本文​​
Provider

リソースを作成または更新する

リソースを作成または更新します。 応答コードを使用して、作成 (201) または更新 (200) を区別できます。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

リソース グループ
resourceGroupName True string

リソース グループ名。

リソース プロバイダー
resourceProviderNamespace True string

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

短いリソース ID
shortResourceId True string

リソース名とリソースの種類を含む、リソースの短い ID。 たとえば、sites/mySite

クライアント API バージョン
x-ms-api-version True string

使用する API バージョン。

ID
id string

リソース ID

件名
name string

リソース名

タイプ
type string

リソースの種類

場所
location string

リソースの場所

Tags
tags object

リソース タグ

Id
name string

プラン ID。

発行者
publisher string

発行元 ID。

Product
product string

オファー ID。

プロモーション コード
promotionCode string

プロモーション コード。

種類
kind string

リソースの種類。

管理者
managedBy string

このリソースを管理するリソースの ID。

件名
name string

SKU 名。

階層
tier string

SKU 階層。

サイズ
size string

SKU サイズ。

家族
family string

SKU ファミリー。

モデル
model string

SKU モデル。

容量
capacity integer

SKU 容量。

プリンシパル ID
principalId string

リソース ID のプリンシパル ID。

テナント ID です
tenantId string

リソースのテナント ID。

タイプ
type string

ID の種類。

プロパティ​​
properties object

リソースのプロパティ。

戻り値

リソース情報。

リソースを削除する

リソースを削除します。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

リソース グループ
resourceGroupName True string

リソース グループ名。

リソース プロバイダー
resourceProviderNamespace True string

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

短いリソース ID
shortResourceId True string

リソース名とリソースの種類を含む、リソースの短い ID。 たとえば、sites/mySite

クライアント API バージョン
x-ms-api-version True string

使用する API バージョン。

リソースを読み取る

リソース オブジェクトを読み取ります。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

リソース グループ
resourceGroupName True string

リソース グループ名。

リソース プロバイダー
resourceProviderNamespace True string

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

短いリソース ID
shortResourceId True string

リソース名とリソースの種類を含む、リソースの短い ID。 たとえば、sites/mySite

クライアント API バージョン
x-ms-api-version True string

使用する API バージョン。

戻り値

リソース情報。

本文​​
GenericResource

リソース操作を呼び出す

Azure リソースで操作を呼び出します。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

リソース グループ
resourceGroupName True string

リソース グループ名。

リソース プロバイダー
resourceProviderNamespace True string

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

短いリソース ID
shortResourceId True string

リソース名とリソースの種類を含む、リソースの短い ID。 たとえば、sites/mySite

クライアント API バージョン
x-ms-api-version True string

使用する API バージョン。

アクション名
actionName True string

呼び出すリソース アクションの名前

戻り値

アクション操作からの応答。

アクション応答
object

展開テンプレートのエクスポート

過去のリソース グループ展開からテンプレートをエクスポートします。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

リソース グループ
resourceGroupName True string

リソース グループ名。

展開名
deploymentName True string

リソース グループのテンプレート展開の名前。

戻り値

展開のエクスポート結果。

本文​​
DeploymentExportResult

既存のリソース グループを更新する

既存のリソース グループを更新します。 リソースが存在しない場合、この要求は失敗します。

パラメーター

名前 キー 必須 説明
サブスクリプション
subscriptionId True string

Microsoft Azure サブスクリプションの一意識別子。 サブスクリプション IDは、各 Azure リソースの ID の一部を構成します。

リソース グループ
resourceGroupName True string

リソース グループ名。

ID
id string

リソース グループの ID (例: /subscriptions/XXX/resourceGroups/YYY)。

件名
name string

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

場所
location True string

リソース グループの場所。 リソース グループの作成後に変更することはできません。 米国西部、米国東部、西ヨーロッパ、東アジアなど、サポートされている Azure の場所の 1 つである必要があります。

管理者
managedBy string

このリソース グループを管理するリソースの ID。

Tags
tags object

リソース グループに添付されたタグ。

プロビジョニングの状態
provisioningState string

プロビジョニングの状態。

戻り値

リソース グループの情報。

本文​​
ResourceGroup

定義

場所

場所の情報。

名前 パス 説明
ID
id string

場所の完全修飾 ID。 たとえば、/subscriptions/00000000-0000-0000-0000-000000000000/locations/westus。

サブスクリプション ID
subscriptionId string

サブスクリプション ID。

ロケーション名
name string

場所の名前。

表示名
displayName string

場所の表示名。

緯度
latitude string

場所の緯度。

経度
longitude string

場所の経度。

LocationListResult

場所一覧の操作応答。

名前 パス 説明
value array of Location

場所。

サブスクリプション

サブスクリプション情報。

名前 パス 説明
ID
id string

完全修飾 ID。たとえば、/subscriptions/00000000-0000-0000-0000-000000000000。

サブスクリプション ID
subscriptionId string

サブスクリプション ID。

テナント ID です
tenantId string

テナント ID。

表示名
displayName string

サブスクリプションの表示名。

完了状態
state string

サブスクリプションの状態。

サブスクリプション ポリシー
subscriptionPolicies SubscriptionPolicies

サブスクリプションのポリシー。

認証ソース
authorizationSource string

要求の承認ソース。 有効な値は、Legacy、RoleBased、Bypassed、Direct、および Management の 1 つ以上の組み合わせです。 たとえば、'Legacy、RoleBased'。

SubscriptionPolicies

サブスクリプションのポリシー。

名前 パス 説明
場所の配置 ID
locationPlacementId string

サブスクリプションの場所の配置 ID。ID は、サブスクリプションで表示されるリージョンを示します。 たとえば、ロケーション配置 ID が Public_2014-09-01 であるサブスクリプションは、Azure パブリック リージョンにアクセスできます。

売上予算 ID
quotaId string

サブスクリプション売上予算 ID。

支出制限
spendingLimit string

サブスクリプションの支出制限。

SubscriptionListResult

サブスクリプション一覧の操作応答。

名前 パス 説明
value array of Subscription

サブスクリプション。

次のリンク
nextLink string

次の結果セットを取得する URL です。

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

名前 パス 説明
テンプレート URI
uri string

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

テンプレート コンテンツ バージョン
contentVersion string

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

展開パラメーターへの参照を表すエンティティ。

名前 パス 説明
パラメーター URI
uri string

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

パラメーター コンテンツ バージョン
contentVersion string

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

DebugSetting

名前 パス 説明
詳細レベル
detailLevel string

デバッグの詳細レベル。

DeploymentExportResult

展開のエクスポート結果。

名前 パス 説明
テンプレート
template object

テンプレートのコンテンツ。

ResourceManagementErrorWithDetails

名前 パス 説明
コード
code string

サーバーから返されたエラー コード。

メッセージ
message string

サーバーから返されたエラー メッセージ。

対象
target string

エラーの対象。

詳細
details array of object

検証エラー。

AliasPathType

エイリアスのパスの種類。

名前 パス 説明
path
path string

エイリアスのパス。

apiVersions
apiVersions array of string

API バージョン。

AliasType

エイリアスの種類。

名前 パス 説明
名前
name string

エイリアスの名前。

パス
paths array of AliasPathType

エイリアスのパス。

ProviderResourceType

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

名前 パス 説明
resourceType
resourceType string

リソースの種類。

場所
locations array of ObjectWithoutType

このリソースの種類が作成される場所のコレクション。

エイリアス
aliases array of AliasType

このリソースの種類によりサポートされるエイリアス。

apiVersions
apiVersions array of string

API バージョン。

プロパティ
properties object

プロパティ。

プロバイダー

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

名前 パス 説明
ID
id string

プロバイダー ID。

名前空間
namespace string

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

登録状態
registrationState string

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

リソースの種類
resourceTypes array of ProviderResourceType

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

BasicDependency

展開の依存関係の情報。

名前 パス 説明
ID
id string

依存関係の ID。

resourceType
resourceType string

展開のリソースの種類。

resourceName
resourceName string

展開のリソース名。

依存関係

展開の依存関係の情報。

名前 パス 説明
dependsOn
dependsOn array of BasicDependency

依存関係の一覧。

ID
id string

依存関係の ID。

resourceType
resourceType string

展開のリソースの種類。

resourceName
resourceName string

展開のリソース名。

DeploymentPropertiesExtended

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

名前 パス 説明
provisioningState
provisioningState string

プロビジョニングの状態。

correlationId
correlationId string

展開の関連付け ID。

timestamp
timestamp date-time

テンプレート展開のタイムスタンプ。

出力
outputs object

展開出力を表すキー/値のペア。

プロバイダー
providers array of Provider

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

依存関係
dependencies array of Dependency

展開依存関係の一覧。

テンプレート
template object

テンプレートのコンテンツ。 Template または TemplateLink のいずれかのみを使用します。

templateLink
templateLink TemplateLink

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

parameters
parameters object

展開パラメーター。 Parameters または ParametersLink のいずれかのみを使用します。

parametersLink
parametersLink ParametersLink

展開パラメーターへの参照を表すエンティティ。

展開モード
mode string

展開モード。

debugSetting
debugSetting DebugSetting

DeploymentValidateResult

テンプレート展開応答の検証からの情報。

名前 パス 説明
エラー
error ResourceManagementErrorWithDetails
プロパティ
properties DeploymentPropertiesExtended

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

DeploymentExtended

展開情報。

名前 パス 説明
ID
id string

展開の ID。

件名
name string

展開の名前。

プロパティ
properties DeploymentPropertiesExtended

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

DeploymentListResult

展開の一覧。

名前 パス 説明
value array of DeploymentExtended

展開の一覧。

次のリンク
nextLink string

次の結果セットを取得する URL です。

ProviderListResult

リソース プロバイダーの一覧。

名前 パス 説明
value array of Provider

リソース プロバイダーの一覧。

nextLink
nextLink string

次の結果セットを取得する URL です。

GenericResource

リソース情報。

名前 パス 説明
ID
id string

リソース ID

件名
name string

リソース名

タイプ
type string

リソースの種類

場所
location string

リソースの場所

タグ
tags object

リソース タグ

計画
plan Plan

リソースの計画。

種類
kind string

リソースの種類。

管理者
managedBy string

このリソースを管理するリソースの ID。

SKU
sku Sku

リソースの SKU。

ID
identity Identity

リソースの ID。

プロパティ​​
properties object

リソースのプロパティ。

プラン

リソースの計画。

名前 パス 説明
ID
name string

プラン ID。

公開元
publisher string

発行元 ID。

製品
product string

オファー ID。

プロモーション コード
promotionCode string

プロモーション コード。

Sku

リソースの SKU。

名前 パス 説明
件名
name string

SKU 名。

階層
tier string

SKU 階層。

サイズ
size string

SKU サイズ。

家族
family string

SKU ファミリー。

モデル
model string

SKU モデル。

容量
capacity integer

SKU 容量。

ID

リソースの ID。

名前 パス 説明
プリンシパル ID
principalId string

リソース ID のプリンシパル ID。

テナント ID です
tenantId string

リソースのテナント ID。

タイプ
type string

ID の種類。

ResourceListResult

リソースの一覧。

名前 パス 説明
value array of GenericResource

リソースの一覧。

次のリンク
nextLink string

次の結果セットを取得する URL です。

リソース グループ

リソース グループの情報。

名前 パス 説明
ID
id string

リソース グループの ID (例: /subscriptions/XXX/resourceGroups/YYY)。

件名
name string

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

場所
location string

リソース グループの場所。 リソース グループの作成後に変更することはできません。 米国西部、米国東部、西ヨーロッパ、東アジアなど、サポートされている Azure の場所の 1 つである必要があります。

管理者
managedBy string

このリソース グループを管理するリソースの ID。

タグ
tags object

リソース グループに添付されたタグ。

プロパティ
properties ResourceGroupProperties

リソース グループのプロパティ。

ResourceGroupProperties

リソース グループのプロパティ。

名前 パス 説明
プロビジョニングの状態
provisioningState string

プロビジョニングの状態。

ResourceGroupListResult

リソース グループの一覧。

名前 パス 説明
value array of ResourceGroup

リソース グループの一覧。

次のリンク
nextLink string

次の結果セットを取得する URL です。

TagCount

タグ数。

名前 パス 説明
タイプ
type string

カウントの種類。

value integer

カウントの値。

TagValue

タグ情報。

名前 パス 説明
タグ ID
id string

タグ ID。

タグ値
tagValue string

タグの値。

タグ数
count TagCount

タグ数。

TagDetails

タグの詳細。

名前 パス 説明
ID
id string

タグ ID。

件名
tagName string

タグの名前。

タグ数
count TagCount

タグ数。

values array of TagValue

タグ値の一覧。

TagsListResult

サブスクリプション タグの一覧。

名前 パス 説明
value array of TagDetails

タグの一覧。

nextLink
nextLink string

次の結果セットを取得する URL です。

TargetResource

対象リソース。

名前 パス 説明
ID
id string

リソースの ID。

件名
resourceName string

リソースの名前。

タイプ
resourceType string

リソースの種類。

HttpMessage

名前 パス 説明
content
content object

HTTP メッセージ コンテンツ。

DeploymentOperationProperties

展開操作プロパティ。

名前 パス 説明
provisioningState
provisioningState string

プロビジョニングの状態。

timestamp
timestamp date-time

操作の日時。

serviceRequestId
serviceRequestId string

展開操作のサービス要求 ID。

statusCode
statusCode string

操作の状態コード。

statusMessage
statusMessage object

操作の状態メッセージ。

対象リソース
targetResource TargetResource

対象リソース。

request
request HttpMessage
応答
response HttpMessage

DeploymentOperation

展開操作の情報。

名前 パス 説明
ID
id string

完全な展開操作 ID。

操作 ID
operationId string

展開操作 ID。

プロパティ
properties DeploymentOperationProperties

展開操作プロパティ。

DeploymentOperationsListResult

展開操作の一覧。

名前 パス 説明
value array of DeploymentOperation

展開の一覧。

次のリンク
nextLink string

次の結果セットを取得する URL です。

ResourceGroupExportResult

名前 パス 説明
テンプレート
template object

テンプレートのコンテンツ。

エラー
error ResourceManagementErrorWithDetails

ObjectWithoutType

オブジェクト

’オブジェクト’ という種類です。