Tenant Configuration - Save

リファレンス

サービス:: API Management

API バージョン:: 2024-05-01

この操作により、現在の構成スナップショットを使用して、リポジトリ内の指定されたブランチへのコミットが作成されます。これは実行時間の長い操作であり、完了までに数分かかる場合があります。

POST https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/save?api-version=2024-05-01

URI パラメーター

名前	/	必須	型	説明
configurationName	path	True	configurationIdName	Git 構成操作の識別子。
resourceGroupName	path	True	string minLength: 1 maxLength: 90	リソースグループの名前。名前では大文字と小文字が区別されません。
serviceName	path	True	string minLength: 1 maxLength: 50 pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$	API Management サービスの名前。
subscriptionId	path	True	string (uuid)	ターゲットサブスクリプションの ID。値は UUID である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求本文

名前	必須	型	説明
properties.branch	True	string	現在の構成スナップショットをコミットする Git ブランチの名前。
properties.force		boolean	値が true の場合、Git リポジトリに上書きされる新しい変更がある場合でも、現在の構成データベースは Git リポジトリにコミットされます。

応答

名前	型	説明
200 OK	OperationResultContract	リポジトリにコミットを作成した結果。
202 Accepted		受け入れ済み: Location ヘッダーには、実行時間の長い操作の状態を確認できる URL が含まれています。ヘッダー location: string
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

名前

型

説明

200 OK

OperationResultContract

リポジトリにコミットを作成した結果。

202 Accepted

受け入れ済み: Location ヘッダーには、実行時間の長い操作の状態を確認できる URL が含まれています。

ヘッダー

location: string

Other Status Codes

ErrorResponse

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

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

例

ApiManagementTenantConfigurationSave

要求のサンプル

HTTP

POST https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/configuration/save?api-version=2024-05-01

{
  "properties": {
    "branch": "master"
  }
}

応答のサンプル

状態コード:: 202

location: https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/operationResults/5a1af57d2a6d2e0b688d751b?api-version=2024-05-01

状態コード:: 200

{
  "id": "6074e652093a9d0dac3d733c",
  "type": "Microsoft.ApiManagement/service/tenant/operationResults",
  "name": "6074e652093a9d0dac3d733c",
  "properties": {
    "status": "Succeeded",
    "started": "2021-04-13T00:31:14.94Z",
    "updated": "2021-04-13T00:31:27.59Z",
    "resultInfo": "The configuration was successfully saved to master as commit c0ae274f6046912107bad734834cbf65918668b6.",
    "actionLog": []
  }
}

定義

名前	説明
AsyncOperationStatus	非同期操作の状態。
configurationIdName	Git 構成操作の識別子。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorFieldContract	エラーフィールドコントラクト。
ErrorResponse	エラー応答
ErrorResponseBody	エラー本文コントラクト。
OperationResultContract	実行時間の長い Git 操作の結果。
OperationResultLogItemContract	作成、更新、または削除されるエンティティのログ。
SaveConfigurationParameter	テナント構成コントラクトの詳細を保存します。

AsyncOperationStatus

列挙

非同期操作の状態。

値	説明
Failed
InProgress
Started
Succeeded

configurationIdName

列挙

Git 構成操作の識別子。

値	説明
configuration

ErrorAdditionalInfo

Object

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

名前	型	説明
info	object	追加情報。
type	string	追加情報の種類。

ErrorDetail

Object

エラーの詳細。

名前	型	説明
additionalInfo	ErrorAdditionalInfo[]	エラーの追加情報。
code	string	エラーコード。
details	ErrorDetail[]	エラーの詳細。
message	string	エラーメッセージ。
target	string	エラーターゲット。

ErrorFieldContract

Object

エラーフィールドコントラクト。

名前	型	説明
code	string	プロパティレベルのエラーコード。
message	string	プロパティレベルエラーの人間が判読できる表現。
target	string	プロパティ名。

ErrorResponse

Object

エラー応答

名前	型	説明
error	ErrorDetail	エラーオブジェクト。

ErrorResponseBody

Object

エラー本文コントラクト。

名前	型	説明
code	string	サービス定義エラーコード。このコードは、応答で指定された HTTP エラーコードのサブステータスとして機能します。
details	ErrorFieldContract[]	検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。
message	string	エラーの人間が判読できる表現。

OperationResultContract

Object

実行時間の長い Git 操作の結果。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.actionLog	OperationResultLogItemContract[]	このプロパティは、TenantConfiguration_Validate操作の一部としてのみ指定される場合です。これには、TenantConfiguration_Deploy操作の一部として更新/作成/削除されるエンティティのログが含まれます。
properties.error	ErrorResponseBody	エラー本文コントラクト
properties.id	string	操作結果識別子。
properties.resultInfo	string	オプションの結果情報。
properties.started	string (date-time)	非同期操作の開始時刻。日付は、ISO 8601 標準で指定された `yyyy-MM-ddTHH:mm:ssZ` 形式に準拠しています。
properties.status	AsyncOperationStatus	非同期操作の状態。
properties.updated	string (date-time)	非同期操作の最終更新時刻。日付は、ISO 8601 標準で指定された `yyyy-MM-ddTHH:mm:ssZ` 形式に準拠しています。
type	string	リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

OperationResultLogItemContract

Object

作成、更新、または削除されるエンティティのログ。

名前	型	説明
action	string	作成、更新、削除などのアクション。
objectKey	string	作成/更新/削除されるエンティティの識別子。
objectType	string	エンティティコントラクトの型。

SaveConfigurationParameter

Object

テナント構成コントラクトの詳細を保存します。

名前	型	説明
properties.branch	string	現在の構成スナップショットをコミットする Git ブランチの名前。
properties.force	boolean	値が true の場合、Git リポジトリに上書きされる新しい変更がある場合でも、現在の構成データベースは Git リポジトリにコミットされます。

次の方法で共有

Tenant Configuration - Save

URI パラメーター

要求本文

応答

セキュリティ

azure_auth

スコープ

例

ApiManagementTenantConfigurationSave

要求のサンプル

応答のサンプル

定義

AsyncOperationStatus

configurationIdName

ErrorAdditionalInfo

ErrorDetail

ErrorFieldContract

ErrorResponse

ErrorResponseBody

OperationResultContract

OperationResultLogItemContract

SaveConfigurationParameter

その他のリソース