Microsoft.ApiManagement service/apis 2021-08-01

[アーティクル]
01/18/2024

Bicep リソース定義

service/apis リソースの種類は、次を対象とする操作でデプロイできます。

リソースグループ - リソースグループのデプロイコマンドを参照してください

各 API バージョンの変更されたプロパティの一覧については、「変更ログ」を参照してください。

リソース形式

Microsoft.ApiManagement/service/apis リソースを作成するには、次の Bicep をテンプレートに追加します。

resource symbolicname 'Microsoft.ApiManagement/service/apis@2021-08-01' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    apiRevision: 'string'
    apiRevisionDescription: 'string'
    apiType: 'string'
    apiVersion: 'string'
    apiVersionDescription: 'string'
    apiVersionSet: {
      description: 'string'
      id: 'string'
      name: 'string'
      versionHeaderName: 'string'
      versioningScheme: 'string'
      versionQueryName: 'string'
    }
    apiVersionSetId: 'string'
    authenticationSettings: {
      oAuth2: {
        authorizationServerId: 'string'
        scope: 'string'
      }
      openid: {
        bearerTokenSendingMethods: [
          'string'
        ]
        openidProviderId: 'string'
      }
    }
    contact: {
      email: 'string'
      name: 'string'
      url: 'string'
    }
    description: 'string'
    displayName: 'string'
    format: 'string'
    isCurrent: bool
    license: {
      name: 'string'
      url: 'string'
    }
    path: 'string'
    protocols: [
      'string'
    ]
    serviceUrl: 'string'
    sourceApiId: 'string'
    subscriptionKeyParameterNames: {
      header: 'string'
      query: 'string'
    }
    subscriptionRequired: bool
    termsOfServiceUrl: 'string'
    type: 'string'
    value: 'string'
    wsdlSelector: {
      wsdlEndpointName: 'string'
      wsdlServiceName: 'string'
    }
  }
}

プロパティ値

service/apis

名前	説明	値
name	リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。	string (必須) 文字制限: 1 から 80 有効な文字: 英数字とハイフン。先頭は文字、末尾は英数字にします。
parent	Bicep では、子リソースの親リソースを指定できます。このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。詳細については、「親リソースの外部の子リソース」を参照してください。	種類のリソースのシンボル名: service
properties	更新プロパティの API エンティティの作成。	ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

名前	説明	値
apiRevision	API のリビジョンについて説明します。値が指定されていない場合は、既定のリビジョン 1 が作成されます	string
apiRevisionDescription	API リビジョンの説明。	string
apiType	作成する API の種類。 * `http` REST API を作成する * `soap` SOAP パススルー API を作成する * `websocket` websocket API を作成します * `graphql`は API GraphQL作成します。	'graphql' 'http' 'soap' 'websocket'
apiVersion	API がバージョン管理されている場合に API のバージョン識別子を示します	string
apiVersionDescription	API バージョンの説明。	string
apiVersionSet	バージョンセットの詳細	ApiVersionSetContractDetails
apiVersionSetId	関連する ApiVersionSet のリソース識別子。	string
authenticationSettings	この API に含まれる認証設定のコレクション。	AuthenticationSettingsContract
contact	API の連絡先情報。	ApiContactInformation
description	API の説明。 HTML 書式設定タグを含めることができます。	string
displayName	API 名。長さは 1 ~ 300 文字にする必要があります。	string
format	API がインポートされるコンテンツの形式。	'graphql-link' 'openapi' 'openapi+json' 'openapi+json-link' 'openapi-link' 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link'
isCurrent	API リビジョンが現在の API リビジョンであるかどうかを示します。	[bool]
license	API のライセンス情報。	ApiLicenseInformation
path	API Management サービスインスタンス内のこの API とそのすべてのリソースパスを一意に識別する相対 URL。この API のパブリック URL を作成するために、サービスインスタンスの作成時に指定された API エンドポイントのベース URL に追加されます。	string (必須)
protocols	この API の操作を呼び出すことができるプロトコルを記述します。	次のいずれかを含む文字列配列: 'http' 'https' 'ws' 'wss'
serviceUrl	この API を実装するバックエンドサービスの絶対 URL。 2,000 文字を超えることはできません。	string
sourceApiId	ソース API の API 識別子。	string
subscriptionKeyParameterNames	API を使用できるようにするプロトコル。	SubscriptionKeyParameterNamesContract
subscriptionRequired	API にアクセスするために API または製品サブスクリプションが必要かどうかを指定します。	[bool]
termsOfServiceUrl	API のサービス利用規約への URL。 URL の形式にする必要があります。	string
type	API の種類。	'graphql' 'http' 'soap' 'websocket'
value	API のインポート時のコンテンツ値。	string
wsdlSelector	WSDL のインポートをドキュメントのサブセットに制限する条件。	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

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

AuthenticationSettingsContract

名前	説明	値
oAuth2	OAuth2 認証設定	OAuth2AuthenticationSettingsContract
openid	OpenID Connect の認証設定	OpenIdAuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

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

OpenIdAuthenticationSettingsContract

名前	説明	値
bearerTokenSendingMethods	サーバーにトークンを送信する方法。	次のいずれかを含む文字列配列: 'authorizationHeader' 'query'
openidProviderId	OAuth 承認サーバーの識別子。	string

ApiContactInformation

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

ApiLicenseInformation

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

SubscriptionKeyParameterNamesContract

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

ApiCreateOrUpdatePropertiesWsdlSelector

名前	説明	値
wsdlEndpointName	WSDL からインポートするエンドポイント (ポート) の名前	string
wsdlServiceName	WSDL からインポートするサービスの名前	string

クイックスタートテンプレート

次のクイックスタートテンプレートでは、このリソースの種類をデプロイします。

Template	説明
テンプレートを使用して API Management インスタンスとそのすべてのサブリソースを作成する	このテンプレートでは、API Management サービスを作成し、サブエンティティを構成する方法を示します
Azure Front Door を Azure API Managementの前に作成する	このサンプルでは、Azure Front Door を Azure API Managementの前でグローバルロードバランサーとして使用する方法を示します。

ARM テンプレートリソース定義

service/apis リソースの種類は、次を対象とする操作でデプロイできます。

リソースグループ - リソースグループのデプロイコマンドに関するページを参照してください

各 API バージョンの変更されたプロパティの一覧については、「変更ログ」を参照してください。

リソース形式

Microsoft.ApiManagement/service/apis リソースを作成するには、次の JSON をテンプレートに追加します。

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2021-08-01",
  "name": "string",
  "properties": {
    "apiRevision": "string",
    "apiRevisionDescription": "string",
    "apiType": "string",
    "apiVersion": "string",
    "apiVersionDescription": "string",
    "apiVersionSet": {
      "description": "string",
      "id": "string",
      "name": "string",
      "versionHeaderName": "string",
      "versioningScheme": "string",
      "versionQueryName": "string"
    },
    "apiVersionSetId": "string",
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "string",
        "scope": "string"
      },
      "openid": {
        "bearerTokenSendingMethods": [ "string" ],
        "openidProviderId": "string"
      }
    },
    "contact": {
      "email": "string",
      "name": "string",
      "url": "string"
    },
    "description": "string",
    "displayName": "string",
    "format": "string",
    "isCurrent": "bool",
    "license": {
      "name": "string",
      "url": "string"
    },
    "path": "string",
    "protocols": [ "string" ],
    "serviceUrl": "string",
    "sourceApiId": "string",
    "subscriptionKeyParameterNames": {
      "header": "string",
      "query": "string"
    },
    "subscriptionRequired": "bool",
    "termsOfServiceUrl": "string",
    "type": "string",
    "value": "string",
    "wsdlSelector": {
      "wsdlEndpointName": "string",
      "wsdlServiceName": "string"
    }
  }
}

プロパティ値

service/apis

名前	説明	値
type	リソースの種類	'Microsoft.ApiManagement/service/apis'
apiVersion	リソース API のバージョン	'2021-08-01'
name	リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。	string (必須) 文字数制限: 1 から 80 有効な文字: 英数字とハイフン。先頭は文字、末尾は英数字にします。
properties	更新プロパティの API エンティティの作成。	ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

名前	説明	値
apiRevision	API のリビジョンについて説明します。値が指定されていない場合、既定のリビジョン 1 が作成されます	string
apiRevisionDescription	API リビジョンの説明。	string
apiType	作成する API の種類。 * `http` REST API を作成する * `soap` SOAP パススルー API を作成する * `websocket` websocket API を作成します * `graphql`は API GraphQL作成します。	'graphql' 'http' 'soap' 'websocket'
apiVersion	API がバージョン管理されている場合に API のバージョン識別子を示します	string
apiVersionDescription	API バージョンの説明。	string
apiVersionSet	バージョンセットの詳細	ApiVersionSetContractDetails
apiVersionSetId	関連する ApiVersionSet のリソース識別子。	string
authenticationSettings	この API に含まれる認証設定のコレクション。	AuthenticationSettingsContract
contact	API の連絡先情報。	ApiContactInformation
description	API の説明。 HTML 書式設定タグを含めることができます。	string
displayName	API 名。長さは 1 ~ 300 文字にする必要があります。	string
format	API がインポートされるコンテンツの形式。	'graphql-link' 'openapi' 'openapi+json' 'openapi+json-link' 'openapi-link' 'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link'
isCurrent	API リビジョンが現在の API リビジョンであるかどうかを示します。	[bool]
license	API のライセンス情報。	ApiLicenseInformation
path	API Management サービスインスタンス内のこの API とそのすべてのリソースパスを一意に識別する相対 URL。この API のパブリック URL を作成するために、サービスインスタンスの作成時に指定された API エンドポイントのベース URL に追加されます。	string (必須)
protocols	この API の操作を呼び出すことができるプロトコルを記述します。	次のいずれかを含む文字列配列: 'http' 'https' 'ws' 'wss'
serviceUrl	この API を実装するバックエンドサービスの絶対 URL。 2,000 文字を超えることはできません。	string
sourceApiId	ソース API の API 識別子。	string
subscriptionKeyParameterNames	API を使用できるようにするプロトコル。	SubscriptionKeyParameterNamesContract
subscriptionRequired	API にアクセスするために API サブスクリプションと Product サブスクリプションのどちらを必要とするかを指定します。	[bool]
termsOfServiceUrl	API の利用規約への URL。 URL の形式にする必要があります。	string
type	API の種類。	'graphql' 'http' 'soap' 'websocket'
value	API のインポート時のコンテンツ値。	string
wsdlSelector	WSDL のインポートをドキュメントのサブセットに制限する条件。	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

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

AuthenticationSettingsContract

名前	説明	値
oAuth2	OAuth2 認証設定	OAuth2AuthenticationSettingsContract
openid	OpenID Connect 認証設定	OpenIdAuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

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

OpenIdAuthenticationSettingsContract

名前	説明	値
bearerTokenSendingMethods	サーバーにトークンを送信する方法。	次のいずれかを含む文字列配列: 'authorizationHeader' 'query'
openidProviderId	OAuth 承認サーバーの識別子。	string

ApiContactInformation

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

ApiLicenseInformation

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

SubscriptionKeyParameterNamesContract

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

ApiCreateOrUpdatePropertiesWsdlSelector

名前	説明	値
wsdlEndpointName	WSDL からインポートするエンドポイント (ポート) の名前	string
wsdlServiceName	WSDL からインポートするサービスの名前	string

クイックスタートテンプレート

次のクイックスタートテンプレートでは、このリソースの種類をデプロイします。

Template	説明
テンプレートを使用して API Management インスタンスとそのすべてのサブリソースを作成する	このテンプレートでは、API Management サービスを作成し、サブエンティティを構成する方法を示します
Azure API Managementの前に Azure Front Door を作成する	このサンプルでは、Azure Front Door を Azure API Managementの前でグローバルロードバランサーとして使用する方法を示します。

Terraform (AzAPI プロバイダー) リソース定義

service/apis リソースの種類は、次を対象とする操作でデプロイできます。

リソースグループ

各 API バージョンの変更されたプロパティの一覧については、「変更ログ」を参照してください。

リソース形式

Microsoft.ApiManagement/service/apis リソースを作成するには、次の Terraform をテンプレートに追加します。

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2021-08-01"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      apiRevision = "string"
      apiRevisionDescription = "string"
      apiType = "string"
      apiVersion = "string"
      apiVersionDescription = "string"
      apiVersionSet = {
        description = "string"
        id = "string"
        name = "string"
        versionHeaderName = "string"
        versioningScheme = "string"
        versionQueryName = "string"
      }
      apiVersionSetId = "string"
      authenticationSettings = {
        oAuth2 = {
          authorizationServerId = "string"
          scope = "string"
        }
        openid = {
          bearerTokenSendingMethods = [
            "string"
          ]
          openidProviderId = "string"
        }
      }
      contact = {
        email = "string"
        name = "string"
        url = "string"
      }
      description = "string"
      displayName = "string"
      format = "string"
      isCurrent = bool
      license = {
        name = "string"
        url = "string"
      }
      path = "string"
      protocols = [
        "string"
      ]
      serviceUrl = "string"
      sourceApiId = "string"
      subscriptionKeyParameterNames = {
        header = "string"
        query = "string"
      }
      subscriptionRequired = bool
      termsOfServiceUrl = "string"
      type = "string"
      value = "string"
      wsdlSelector = {
        wsdlEndpointName = "string"
        wsdlServiceName = "string"
      }
    }
  })
}

プロパティ値

service/apis

名前	説明	値
type	リソースの種類	"Microsoft.ApiManagement/service/apis@2021-08-01"
name	リソース名	string (必須) 文字制限: 1 から 80 有効な文字: 英数字とハイフン。先頭は文字、末尾は英数字にします。
parent_id	このリソースの親であるリソースの ID。	種類のリソースの ID: サービス
properties	更新プロパティの API エンティティの作成。	ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesOrApiContractProperties

名前	説明	値
apiRevision	API のリビジョンについて説明します。値が指定されていない場合は、既定のリビジョン 1 が作成されます	string
apiRevisionDescription	API リビジョンの説明。	string
apiType	作成する API の種類。 * `http` REST API を作成する * `soap` SOAP パススルー API を作成する * `websocket` websocket API を作成します * `graphql`は API GraphQL作成します。	"graphql" "http" "soap" "websocket"
apiVersion	API がバージョン管理されている場合に API のバージョン識別子を示します	string
apiVersionDescription	API バージョンの説明。	string
apiVersionSet	バージョンセットの詳細	ApiVersionSetContractDetails
apiVersionSetId	関連する ApiVersionSet のリソース識別子。	string
authenticationSettings	この API に含まれる認証設定のコレクション。	AuthenticationSettingsContract
contact	API の連絡先情報。	ApiContactInformation
description	API の説明。 HTML 書式設定タグを含めることができます。	string
displayName	API 名。長さは 1 ~ 300 文字にする必要があります。	string
format	API がインポートされるコンテンツの形式。	"graphql-link" "openapi" "openapi+json" "openapi+json-link" "openapi-link" "swagger-json" "swagger-link-json" "wadl-link-json" "wadl-xml" "wsdl" "wsdl-link"
isCurrent	API リビジョンが現在の API リビジョンであるかどうかを示します。	[bool]
license	API のライセンス情報。	ApiLicenseInformation
path	API Management サービスインスタンス内のこの API とそのすべてのリソースパスを一意に識別する相対 URL。この API のパブリック URL を作成するために、サービスインスタンスの作成時に指定された API エンドポイントのベース URL に追加されます。	string (必須)
protocols	この API の操作を呼び出すことができるプロトコルを記述します。	次のいずれかを含む文字列配列: "http" "https" "ws" "wss"
serviceUrl	この API を実装するバックエンドサービスの絶対 URL。 2,000 文字を超えることはできません。	string
sourceApiId	ソース API の API 識別子。	string
subscriptionKeyParameterNames	API を使用できるようにするプロトコル。	SubscriptionKeyParameterNamesContract
subscriptionRequired	API にアクセスするために API サブスクリプションと Product サブスクリプションのどちらを必要とするかを指定します。	[bool]
termsOfServiceUrl	API の利用規約への URL。 URL の形式にする必要があります。	string
type	API の種類。	"graphql" "http" "soap" "websocket"
value	API のインポート時のコンテンツ値。	string
wsdlSelector	WSDL のインポートをドキュメントのサブセットに制限する条件。	ApiCreateOrUpdatePropertiesWsdlSelector

ApiVersionSetContractDetails

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

AuthenticationSettingsContract

名前	説明	値
oAuth2	OAuth2 認証設定	OAuth2AuthenticationSettingsContract
openid	OpenID Connect 認証設定	OpenIdAuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

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

OpenIdAuthenticationSettingsContract

名前	説明	値
bearerTokenSendingMethods	サーバーにトークンを送信する方法。	次のいずれかを含む文字列配列: "authorizationHeader" "query"
openidProviderId	OAuth 承認サーバーの識別子。	string

ApiContactInformation

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

ApiLicenseInformation

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

SubscriptionKeyParameterNamesContract

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

ApiCreateOrUpdatePropertiesWsdlSelector

名前	説明	値
wsdlEndpointName	WSDL からインポートするエンドポイント (ポート) の名前	string
wsdlServiceName	WSDL からインポートするサービスの名前	string

Microsoft.ApiManagement service/apis 2021-08-01

Bicep リソース定義

リソース形式

プロパティ値

service/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

クイック スタート テンプレート

ARM テンプレート リソース定義

リソース形式

プロパティ値

service/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

クイック スタート テンプレート

Terraform (AzAPI プロバイダー) リソース定義

リソース形式

プロパティ値

service/apis

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiVersionSetContractDetails

AuthenticationSettingsContract

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

ApiContactInformation

ApiLicenseInformation

SubscriptionKeyParameterNamesContract

ApiCreateOrUpdatePropertiesWsdlSelector

その他のリソース

クイックスタートテンプレート

ARM テンプレートリソース定義

クイックスタートテンプレート