Apis - Get

リファレンス

サービス:: API Management

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

識別子で指定された API の詳細を取得します。

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

URI パラメーター

名前	/	必須	型	説明
apiId	path	True	string minLength: 1 maxLength: 256 pattern: ^[^*#&+:<>?]+$	API リビジョン識別子。現在の API Management サービスインスタンスで一意である必要があります。現在のリビジョン以外のリビジョンには、rev=n はサフィックスであり、n はリビジョン番号です。
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	ApiContract	応答本文には、指定された API エンティティが含まれています。ヘッダー ETag: string
Other Status Codes	ErrorResponse	操作が失敗した理由を説明するエラー応答。

名前

型

説明

200 OK

ApiContract

応答本文には、指定された 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	ユーザーアカウントを偽装する

例

ApiManagementGetApiContract

ApiManagementGetApiRevisionContract

ApiManagementGetApiContract

要求のサンプル

HTTP

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

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "57d1f7558aa04f15146d9d8a",
  "properties": {
    "displayName": "Service",
    "apiRevision": "1",
    "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx",
    "path": "schulte",
    "protocols": [
      "https"
    ],
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "authorizationServerId2283",
        "scope": "oauth2scope2580"
      },
      "oAuth2AuthenticationSettings": [
        {
          "authorizationServerId": "authorizationServerId2283",
          "scope": "oauth2scope2580"
        },
        {
          "authorizationServerId": "authorizationServerId2284",
          "scope": "oauth2scope2581"
        }
      ]
    },
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "type": "soap",
    "isCurrent": true,
    "isOnline": true
  }
}

ApiManagementGetApiRevisionContract

要求のサンプル

HTTP

GET https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3?api-version=2024-05-01

応答のサンプル

状態コード:: 200

{
  "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/echo-api;rev=3",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "echo-api;rev=3",
  "properties": {
    "displayName": "Service",
    "apiRevision": "3",
    "serviceUrl": "https://api.plexonline.com/DataSource/Service.asmx",
    "path": "schulte",
    "protocols": [
      "https"
    ],
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "authorizationServerId2283",
        "scope": "oauth2scope2580"
      },
      "oAuth2AuthenticationSettings": [
        {
          "authorizationServerId": "authorizationServerId2283",
          "scope": "oauth2scope2580"
        },
        {
          "authorizationServerId": "authorizationServerId2284",
          "scope": "oauth2scope2581"
        }
      ]
    },
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "apiRevisionDescription": "fixed bug in contract"
  }
}

定義

名前	説明
ApiContactInformation	API の連絡先情報
ApiContract	API の詳細。
ApiLicenseInformation	API ライセンス情報
ApiType	API の種類。
ApiVersionSetContractDetails	API バージョンセットには、関連する一連の API バージョンの共通構成が含まれています
AuthenticationSettingsContract	API 認証の設定。
bearerTokenSendingMethods	サーバーにトークンを送信する方法。
ErrorAdditionalInfo	リソース管理エラーの追加情報。
ErrorDetail	エラーの詳細。
ErrorResponse	エラー応答
OAuth2AuthenticationSettingsContract	API OAuth2 認証設定の詳細。
OpenIdAuthenticationSettingsContract	API OAuth2 認証設定の詳細。
Protocol	この API の操作を呼び出すことができるプロトコルについて説明します。
SubscriptionKeyParameterNamesContract	サブスクリプションキーパラメーター名の詳細。
versioningScheme	API バージョン識別子が HTTP 要求内の場所を決定する値。

ApiContactInformation

Object

API の連絡先情報

名前	型	説明
email	string	連絡先の個人/組織の電子メールアドレス。電子メールアドレスの形式にする必要があります
name	string	連絡先の個人/組織の識別名
url	string	連絡先情報を指す URL。 URL の形式にする必要があります

ApiContract

Object

API の詳細。

名前	型	説明
id	string	リソースの完全修飾リソース ID。例 - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	リソースの名前
properties.apiRevision	string minLength: 1 maxLength: 100	API のリビジョンについて説明します。値が指定されていない場合は、既定のリビジョン 1 が作成されます
properties.apiRevisionDescription	string maxLength: 256	API リビジョンの説明。
properties.apiVersion	string maxLength: 100	API がバージョン管理されている場合は、API のバージョン識別子を示します
properties.apiVersionDescription	string maxLength: 256	API バージョンの説明。
properties.apiVersionSet	ApiVersionSetContractDetails	バージョンセットの詳細
properties.apiVersionSetId	string	関連する ApiVersionSet のリソース識別子。
properties.authenticationSettings	AuthenticationSettingsContract	この API に含まれる認証設定のコレクション。
properties.contact	ApiContactInformation	API の連絡先情報。
properties.description	string	API の説明。 HTML 書式設定タグを含めることができます。
properties.displayName	string minLength: 1 maxLength: 300	API 名。長さは 1 ~ 300 文字にする必要があります。
properties.isCurrent	boolean	API リビジョンが現在の API リビジョンであるかどうかを示します。
properties.isOnline	boolean	API リビジョンにゲートウェイ経由でアクセスできるかどうかを示します。
properties.license	ApiLicenseInformation	API のライセンス情報。
properties.path	string minLength: 0 maxLength: 400	この API と API Management サービスインスタンス内のすべてのリソースパスを一意に識別する相対 URL。この API のパブリック URL を形成するために、サービスインスタンスの作成時に指定された API エンドポイントのベース URL に追加されます。
properties.protocols	Protocol[]	この API の操作を呼び出すことができるプロトコルについて説明します。
properties.provisioningState	string	プロビジョニングの状態
properties.serviceUrl	string minLength: 0 maxLength: 2000	この API を実装するバックエンドサービスの絶対 URL。 2,000 文字を超えることはできません。
properties.sourceApiId	string	ソース API の API 識別子。
properties.subscriptionKeyParameterNames	SubscriptionKeyParameterNamesContract	API を使用できるようにするプロトコル。
properties.subscriptionRequired	boolean	API にアクセスするために API サブスクリプションまたは製品サブスクリプションが必要かどうかを指定します。
properties.termsOfServiceUrl	string	API のサービス利用規約への URL。 URL の形式にする必要があります。
properties.type	ApiType	API の種類。
type	string	リソースの種類。例: "Microsoft.Compute/virtualMachines" または "Microsoft.Storage/storageAccounts"

ApiLicenseInformation

Object

API ライセンス情報

名前	型	説明
name	string	API に使用されるライセンス名
url	string	API に使用されるライセンスの URL。 URL の形式にする必要があります

ApiType

列挙

API の種類。

値	説明
graphql
grpc
http
odata
soap
websocket

ApiVersionSetContractDetails

Object

API バージョンセットには、関連する一連の API バージョンの共通構成が含まれています

名前	型	説明
description	string	API バージョンセットの説明。
id	string	既存の API バージョンセットの識別子。新しいバージョンセットを作成するには、この値を省略します。
name	string	API バージョンセットの表示名。
versionHeaderName	string	versioningScheme が `header`に設定されている場合に API バージョンを示す HTTP ヘッダーパラメーターの名前。
versionQueryName	string	versioningScheme が `query`に設定されている場合に API バージョンを示すクエリパラメーターの名前。
versioningScheme	versioningScheme	API バージョン識別子が HTTP 要求内の場所を決定する値。

AuthenticationSettingsContract

Object

API 認証の設定。

名前	型	説明
oAuth2	OAuth2AuthenticationSettingsContract	OAuth2 認証の設定
oAuth2AuthenticationSettings	OAuth2AuthenticationSettingsContract[]	この API に含まれる OAuth2 認証設定のコレクション。
openid	OpenIdAuthenticationSettingsContract	OpenID Connect の認証設定
openidAuthenticationSettings	OpenIdAuthenticationSettingsContract[]	この API に含まれる Open ID Connect 認証設定のコレクション。

bearerTokenSendingMethods

列挙

サーバーにトークンを送信する方法。

値	説明
authorizationHeader	アクセストークンは、Bearer スキーマを使用して Authorization ヘッダーで送信されます
query	アクセストークンはクエリパラメーターとして送信されます。

ErrorAdditionalInfo

Object

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

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

ErrorDetail

Object

エラーの詳細。

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

ErrorResponse

Object

エラー応答

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

OAuth2AuthenticationSettingsContract

Object

API OAuth2 認証設定の詳細。

名前	型	説明
authorizationServerId	string	OAuth 承認サーバー識別子。
scope	string	操作スコープ。

OpenIdAuthenticationSettingsContract

Object

API OAuth2 認証設定の詳細。

名前	型	説明
bearerTokenSendingMethods	bearerTokenSendingMethods[]	サーバーにトークンを送信する方法。
openidProviderId	string	OAuth 承認サーバー識別子。

Protocol

列挙

この API の操作を呼び出すことができるプロトコルについて説明します。

値	説明
http
https
ws
wss

SubscriptionKeyParameterNamesContract

Object

サブスクリプションキーパラメーター名の詳細。

名前	型	説明
header	string	サブスクリプションキーのヘッダー名。
query	string	サブスクリプションキークエリ文字列パラメーター名。

versioningScheme

列挙

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

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

次の方法で共有

Apis - Get

URI パラメーター

応答

セキュリティ

azure_auth

スコープ

例

ApiManagementGetApiContract

要求のサンプル

応答のサンプル

ApiManagementGetApiRevisionContract

要求のサンプル

応答のサンプル

定義

ApiContactInformation

ApiContract

ApiLicenseInformation

ApiType

ApiVersionSetContractDetails

AuthenticationSettingsContract

bearerTokenSendingMethods

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

Protocol

SubscriptionKeyParameterNamesContract

versioningScheme

その他のリソース