Api Version Set - Get

識別子で指定された API バージョン セットの詳細を取得します。

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

URI パラメーター

名前 / 必須 説明
resourceGroupName
path True

string

リソース グループの名前。 名前の大文字と小文字は区別されます。

serviceName
path True

string

API Management サービスの名前。

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

ターゲット サブスクリプションの ID。

versionSetId
path True

string

API バージョン セット識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。

Regex pattern: ^[^*#&+:<>?]+$

api-version
query True

string

この操作に使用する API バージョン。

応答

名前 説明
200 OK

ApiVersionSetContract

指定した Api バージョン セット エンティティを取得します。

Headers

ETag: string

Other Status Codes

ErrorResponse

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

Scopes

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

ApiManagementGetApiVersionSet

Sample Request

GET https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apiVersionSets/vs1?api-version=2022-08-01

Sample Response

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

定義

名前 説明
ApiVersionSetContract

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

ErrorFieldContract

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

ErrorResponse

エラー応答。

versioningScheme

API バージョン識別子が HTTP 要求内のどこに配置されるのかを決定する値。

ApiVersionSetContract

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

名前 説明
id

string

リソースの完全修飾リソース ID。 例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}

name

string

リソースの名前

properties.description

string

API バージョン セットの説明。

properties.displayName

string

API バージョン セットの名前

properties.versionHeaderName

string

versioningScheme が に header設定されている場合に API バージョンを示す HTTP ヘッダー パラメーターの名前。

properties.versionQueryName

string

versioningScheme が に query設定されている場合に API バージョンを示すクエリ パラメーターの名前。

properties.versioningScheme

versioningScheme

API バージョン識別子が HTTP 要求内のどこに配置されるのかを決定する値。

type

string

リソースの型。 例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ErrorFieldContract

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

名前 説明
code

string

プロパティ レベルのエラー コード。

message

string

プロパティ レベルエラーの人間が判読できる表現。

target

string

プロパティ名。

ErrorResponse

エラー応答。

名前 説明
error.code

string

サービスによって定義されたエラー コード。 このコードは、応答に指定された HTTP エラー コードのサブステータスとして機能します。

error.details

ErrorFieldContract[]

検証エラーが発生した場合に要求で送信される無効なフィールドの一覧。

error.message

string

人が判読できるエラーの表現。

versioningScheme

API バージョン識別子が HTTP 要求内のどこに配置されるのかを決定する値。

名前 説明
Header

string

API バージョンは HTTP ヘッダーで渡されます。

Query

string

API バージョンはクエリ パラメーターで渡されます。

Segment

string

API バージョンはパス セグメントで渡されます。