Tenant Configuration - Get Sync State

サービス:

API Management

API バージョン:

2024-05-01

構成データベースと Git リポジトリの間の最新の同期の状態を取得します。

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/syncState?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 バージョン。

応答

名前	型	説明
200 OK	TenantConfigurationSyncStateContract	同期状態の結果。
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

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

例

ApiManagementTenantAccessSyncState

要求のサンプル

HTTP

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

応答のサンプル

状態コード:

200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/configuration/syncState",
  "type": "Microsoft.ApiManagement/service/tenant/syncState",
  "name": "syncState",
  "properties": {
    "branch": "master",
    "commitId": "de891c2342c7058dde45e5e624eae7e558c94683",
    "isExport": true,
    "isSynced": true,
    "isGitEnabled": true,
    "syncDate": "2021-04-13T01:15:53.9824995Z",
    "configurationChangeDate": "2021-04-13T00:11:43.862781Z",
    "lastOperationId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/tenant/configuration/operationResults/6074f0bd093a9d0dac3d7347"
  }
}

定義

名前	説明
configurationIdName	Git 構成操作の識別子。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
TenantConfigurationSyncStateContract	テナント構成の同期状態の結果。

configurationIdName

列挙

Git 構成操作の識別子。

値	説明
configuration

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

TenantConfigurationSyncStateContract

Object

テナント構成の同期状態の結果。

名前	型	説明
id	string	リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.branch	string	Git ブランチの名前。
properties.commitId	string	最新のコミット ID。
properties.configurationChangeDate	string (date-time)	最新の構成変更の日付。 日付は、ISO 8601 標準で指定された yyyy-MM-ddTHH:mm:ssZ 形式に準拠しています。
properties.isExport	boolean	最後の同期が保存された (true) かデプロイ (false) 操作かを示す値。
properties.isGitEnabled	boolean	Git 構成アクセスが有効かどうかを示す値。
properties.isSynced	boolean	最後の同期が構成の変更より後だったかどうかを示す値。
properties.lastOperationId	string	最新のテナント構成操作識別子
properties.syncDate	string (date-time)	最新の同期の日付。 日付は、ISO 8601 標準で指定された yyyy-MM-ddTHH:mm:ssZ 形式に準拠しています。
type	string	リソースの種類。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"