Api Version Set - Update

リファレンス

サービス:: API Management

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

識別子で指定された Api VersionSet の詳細を更新します。

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apiVersionSets/{versionSetId}?api-version=2024-05-01

URI パラメーター

名前	/	必須	型	説明
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 である必要があります。
versionSetId	path	True	string minLength: 1 maxLength: 80 pattern: ^[^*#&+:<>?]+$	API バージョンセット識別子。現在の API Management サービスインスタンスで一意である必要があります。
api-version	query	True	string minLength: 1	この操作に使用する API バージョン。

要求ヘッダー

名前	必須	型	説明
If-Match	True	string	エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティの状態と一致するか、無条件更新の場合は * にする必要があります。

要求本文

名前	型	説明
properties.description	string	API バージョンセットの説明。
properties.displayName	string minLength: 1 maxLength: 100	API バージョンセットの名前
properties.versionHeaderName	string minLength: 1 maxLength: 100	versioningScheme が `header`に設定されている場合に API バージョンを示す HTTP ヘッダーパラメーターの名前。
properties.versionQueryName	string minLength: 1 maxLength: 100	versioningScheme が `query`に設定されている場合に API バージョンを示すクエリパラメーターの名前。
properties.versioningScheme	versioningScheme	API バージョン識別子が HTTP 要求内の場所を決定する値。

応答

名前	型	説明
200 OK	ApiVersionSetContract	API バージョンセットが正常に更新されました。ヘッダー ETag: string
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

名前

型

説明

200 OK

ApiVersionSetContract

API バージョンセットが正常に更新されました。

ヘッダー

ETag: 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	ユーザーアカウントを偽装する

例

ApiManagementUpdateApiVersionSet

要求のサンプル

HTTP

PATCH https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1?api-version=2024-05-01


{
  "properties": {
    "displayName": "api set 1",
    "versioningScheme": "Segment",
    "description": "Version configuration"
  }
}

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1",
  "type": "Microsoft.ApiManagement/service/api-version-sets",
  "name": "vs1",
  "properties": {
    "displayName": "api set 1",
    "versioningScheme": "Segment",
    "description": "Version configuration"
  }
}

定義

名前	説明
ApiVersionSetContract	API バージョンセットコントラクトの詳細。
ApiVersionSetUpdateParameters	API バージョンセットコントラクトを更新または作成するためのパラメーター。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
versioningScheme	API バージョン識別子が HTTP 要求内の場所を決定する値。

ApiVersionSetContract

Object

API バージョンセットコントラクトの詳細。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.description	string	API バージョンセットの説明。
properties.displayName	string minLength: 1 maxLength: 100	API バージョンセットの名前
properties.versionHeaderName	string minLength: 1 maxLength: 100	versioningScheme が `header`に設定されている場合に API バージョンを示す HTTP ヘッダーパラメーターの名前。
properties.versionQueryName	string minLength: 1 maxLength: 100	versioningScheme が `query`に設定されている場合に API バージョンを示すクエリパラメーターの名前。
properties.versioningScheme	versioningScheme	API バージョン識別子が HTTP 要求内の場所を決定する値。
type	string	リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ApiVersionSetUpdateParameters

Object

API バージョンセットコントラクトを更新または作成するためのパラメーター。

名前	型	説明
properties.description	string	API バージョンセットの説明。
properties.displayName	string minLength: 1 maxLength: 100	API バージョンセットの名前
properties.versionHeaderName	string minLength: 1 maxLength: 100	versioningScheme が `header`に設定されている場合に API バージョンを示す HTTP ヘッダーパラメーターの名前。
properties.versionQueryName	string minLength: 1 maxLength: 100	versioningScheme が `query`に設定されている場合に API バージョンを示すクエリパラメーターの名前。
properties.versioningScheme	versioningScheme	API バージョン識別子が HTTP 要求内の場所を決定する値。

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

versioningScheme

列挙

API バージョン識別子が HTTP 要求内の場所を決定する値。

値	説明
Header	API バージョンは HTTP ヘッダーで渡されます。
Query	API バージョンはクエリパラメーターで渡されます。
Segment	API バージョンはパスセグメントで渡されます。

次の方法で共有

Api Version Set - Update

URI パラメーター

要求ヘッダー

要求本文

応答

セキュリティ

azure_auth

スコープ

例

ApiManagementUpdateApiVersionSet

要求のサンプル

応答のサンプル

定義

ApiVersionSetContract

ApiVersionSetUpdateParameters

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

versioningScheme

その他のリソース