次の方法で共有


Product Api - Create Or Update

指定された製品に API を追加します。

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}?api-version=2022-08-01

URI パラメーター

名前 / 必須 説明
apiId
path True

string

API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在以外のリビジョンには があります。rev=n はサフィックスで、n はリビジョン番号です。

正規表現パターン: ^[^*#&+:<>?]+$

productId
path True

string

製品識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。

resourceGroupName
path True

string

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

serviceName
path True

string

API Management サービスの名前。

正規表現パターン: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

subscriptionId
path True

string

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

api-version
query True

string

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

応答

名前 説明
200 OK

ApiContract

指定された API は既に製品に追加されています。

201 Created

ApiContract

API は正常に製品に追加されました。

Other Status Codes

ErrorResponse

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

セキュリティ

azure_auth

Azure Active Directory OAuth2 フロー。

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

スコープ

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

ApiManagementCreateProductApi

要求のサンプル

PUT https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/products/testproduct/apis/echo-api?api-version=2022-08-01

応答のサンプル

{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "5931a75ae4bbd512a88c680b",
  "properties": {
    "displayName": "EchoApi",
    "apiRevision": "1",
    "serviceUrl": "https://contoso.com/apis/echo",
    "path": "",
    "protocols": [
      "http",
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}
{
  "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/5931a75ae4bbd512a88c680b",
  "type": "Microsoft.ApiManagement/service/apis",
  "name": "5931a75ae4bbd512a88c680b",
  "properties": {
    "displayName": "EchoApi",
    "apiRevision": "1",
    "serviceUrl": "https://contoso.com/apis/echo",
    "path": "",
    "protocols": [
      "http",
      "https"
    ],
    "subscriptionKeyParameterNames": {
      "header": "Ocp-Apim-Subscription-Key",
      "query": "subscription-key"
    },
    "isCurrent": true
  }
}

定義

名前 説明
ApiContactInformation

API の連絡先情報

ApiContract

API の詳細。

ApiLicenseInformation

API ライセンス情報

ApiType

API の種類。

ApiVersionSetContractDetails

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

AuthenticationSettingsContract

API 認証の設定。

bearerTokenSendingMethods

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

ErrorFieldContract

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

ErrorResponse

エラー応答。

OAuth2AuthenticationSettingsContract

API OAuth2 認証設定の詳細。

OpenIdAuthenticationSettingsContract

API OAuth2 認証設定の詳細。

Protocol

この API の操作を呼び出すことができるプロトコルを記述します。

SubscriptionKeyParameterNamesContract

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

versioningScheme

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

ApiContactInformation

API の連絡先情報

名前 説明
email

string

連絡先/organizationのメール アドレス。 電子メール アドレスの形式にする必要があります

name

string

連絡先/organizationの識別名

url

string

連絡先情報を指す URL。 URL の形式にする必要があります

ApiContract

API の詳細。

名前 説明
id

string

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

name

string

リソースの名前

properties.apiRevision

string

API のリビジョンについて説明します。 値が指定されていない場合、既定のリビジョン 1 が作成されます

properties.apiRevisionDescription

string

API リビジョンの説明。

properties.apiVersion

string

API がバージョン管理されている場合の API のバージョン識別子を示します

properties.apiVersionDescription

string

API バージョンの説明。

properties.apiVersionSet

ApiVersionSetContractDetails

バージョン セットの詳細

properties.apiVersionSetId

string

関連する ApiVersionSet のリソース識別子。

properties.authenticationSettings

AuthenticationSettingsContract

この API に含まれる認証設定のコレクション。

properties.contact

ApiContactInformation

API の連絡先情報。

properties.description

string

API の説明。 HTML 書式設定タグを含めることができます。

properties.displayName

string

API 名。 1 から 300 文字の長さにする必要があります。

properties.isCurrent

boolean

API リビジョンが現在の API リビジョンであるかどうかを示します。

properties.isOnline

boolean

API リビジョンにゲートウェイ経由でアクセスできるかどうかを示します。

properties.license

ApiLicenseInformation

API のライセンス情報。

properties.path

string

API Management サービス インスタンス内のこの API とそのすべてのリソース パスを一意に識別する相対 URL。 この API のパブリック URL を作成するために、サービス インスタンスの作成時に指定された API エンドポイントのベース URL に追加されます。

properties.protocols

Protocol[]

この API の操作を呼び出すことができるプロトコルを記述します。

properties.serviceUrl

string

この 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

API ライセンス情報

名前 説明
name

string

API に使用されるライセンス名

url

string

API に使用されるライセンスの URL。 URL の形式にする必要があります

ApiType

API の種類。

名前 説明
graphql

string

http

string

soap

string

websocket

string

ApiVersionSetContractDetails

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

API 認証の設定。

名前 説明
oAuth2

OAuth2AuthenticationSettingsContract

OAuth2 認証設定

oAuth2AuthenticationSettings

OAuth2AuthenticationSettingsContract[]

この API に含まれる OAuth2 認証設定のコレクション。

openid

OpenIdAuthenticationSettingsContract

OpenID Connect の認証設定

openidAuthenticationSettings

OpenIdAuthenticationSettingsContract[]

この API に含まれる Open ID Connect 認証設定のコレクション。

bearerTokenSendingMethods

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

名前 説明
authorizationHeader

string

アクセス トークンは、ベアラー スキーマを使用して Authorization ヘッダーで送信されます

query

string

アクセス トークンはクエリ パラメーターとして送信されます。

ErrorFieldContract

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

名前 説明
code

string

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

message

string

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

target

string

プロパティ名。

ErrorResponse

エラー応答。

名前 説明
error.code

string

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

error.details

ErrorFieldContract[]

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

error.message

string

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

OAuth2AuthenticationSettingsContract

API OAuth2 認証設定の詳細。

名前 説明
authorizationServerId

string

OAuth 承認サーバーの識別子。

scope

string

操作スコープ。

OpenIdAuthenticationSettingsContract

API OAuth2 認証設定の詳細。

名前 説明
bearerTokenSendingMethods

bearerTokenSendingMethods[]

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

openidProviderId

string

OAuth 承認サーバーの識別子。

Protocol

この API の操作を呼び出すことができるプロトコルを記述します。

名前 説明
http

string

https

string

ws

string

wss

string

SubscriptionKeyParameterNamesContract

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

名前 説明
header

string

サブスクリプション キー ヘッダー名。

query

string

サブスクリプション キー クエリ文字列パラメーター名。

versioningScheme

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

名前 説明
Header

string

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

Query

string

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

Segment

string

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