Microsoft.ApiManagement service/apis 2018-01-01

• 最新の を する
• 2024-06-01-preview
• 2024-05-01
• 2023-09-01-preview
• 2023-05-01-preview
• 2023-03-01-preview
• 2022-09-01-preview
• 2022-08-01
• 2022-04-01-preview
• 2021-12-01-preview
• 2021-08-01
• 2021-04-01-preview
• 2021-01-01-preview
• 2020-12-01
• 2020-06-01-preview
• 2019-12-01
• 2019-12-01-preview
• 2019-01-01
• 2018-06-01-preview
• 2018-01-01
• 2017-03-01
• 2016-10-10
• 2016-07-07

Bicep リソース定義

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

• リソース グループの - リソース グループのデプロイ コマンド 参照

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

リソースの形式

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

resource symbolicname 'Microsoft.ApiManagement/service/apis@2018-01-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    apiRevision: 'string'
    apiRevisionDescription: 'string'
    apiType: 'string'
    apiVersion: 'string'
    apiVersionDescription: 'string'
    apiVersionSet: {
      description: 'string'
      id: 'string'
      versionHeaderName: 'string'
      versioningScheme: 'string'
      versionQueryName: 'string'
    }
    apiVersionSetId: 'string'
    authenticationSettings: {
      oAuth2: {
        authorizationServerId: 'string'
        scope: 'string'
      }
      openid: {
        bearerTokenSendingMethods: [
          'string'
        ]
        openidProviderId: 'string'
      }
      subscriptionKeyRequired: bool
    }
    contentFormat: 'string'
    contentValue: 'string'
    description: 'string'
    displayName: 'string'
    path: 'string'
    protocols: [
      'string'
    ]
    serviceUrl: 'string'
    subscriptionKeyParameterNames: {
      header: 'string'
      query: 'string'
    }
    type: 'string'
    wsdlSelector: {
      wsdlEndpointName: 'string'
      wsdlServiceName: 'string'
    }
  }
}

プロパティ値

ApiCreateOrUpdatePropertiesOrApiContractProperties

名前	形容	価値
apiRevision	API のリビジョンについて説明します。 値が指定されていない場合は、既定のリビジョン 1 が作成されます	糸 制約： 最小長 = 1 最大長 = 1
apiRevisionDescription	API リビジョンの説明。	糸 制約： 最大長 =
apiType	作成する API の種類。 SOAP to REST API を作成 * http * soap SOAP パススルー API を作成します。	'http' 'soap'
apiVersion	API がバージョン管理されている場合は、API のバージョン識別子を示します	糸 制約： 最大長 =
apiVersionDescription	API バージョンの説明。	糸 制約： 最大長 =
apiVersionSet	API バージョン セットには、関連する一連の API バージョンの共通構成が含まれています	ApiVersionSetContractDetails
apiVersionSetId	関連する ApiVersionSet のリソース識別子。	糸
authenticationSettings	この API に含まれる認証設定のコレクション。	AuthenticationSettingsContract
contentFormat	API がインポートされるコンテンツの形式。	'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link'
contentValue	API のインポート時のコンテンツ値。	糸
形容	API の説明。 HTML 書式設定タグを含めることができます。	糸
displayName	API 名。	糸 制約： 最小長 = 1 最大長 = 1
パス	この API と API Management サービス インスタンス内のすべてのリソース パスを一意に識別する相対 URL。 この API のパブリック URL を形成するために、サービス インスタンスの作成時に指定された API エンドポイントのベース URL に追加されます。	糸 制約： 最大長 = (必須)
プロトコル	この API の操作を呼び出すことができるプロトコルについて説明します。	次のいずれかを含む文字列配列: 'http' 'https'
serviceUrl	この API を実装するバックエンド サービスの絶対 URL。	糸 制約： 最大長 =
subscriptionKeyParameterNames	API を使用できるようにするプロトコル。	SubscriptionKeyParameterNamesContract の
種類	API の種類。	'http' 'soap'
wsdlSelector	WSDL のインポートをドキュメントのサブセットに制限する条件。	ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

名前	形容	価値
wsdlEndpointName	WSDL からインポートするエンドポイント (ポート) の名前	糸
wsdlServiceName	WSDL からインポートするサービスの名前	糸

ApiVersionSetContractDetails

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

AuthenticationSettingsContract

名前	形容	価値
oAuth2	OAuth2 認証の設定	OAuth2AuthenticationSettingsContract
openid	OpenID Connect の認証設定	OpenIdAuthenticationSettingsContract
subscriptionKeyRequired	この API の呼び出し中にサブスクリプション キーが必要かどうかを指定します。true - API は閉じた製品にのみ含まれます。false - API はオープン製品のみに含まれます。null - 製品が混在しています。	bool

Microsoft.ApiManagement/service/apis

名前	形容	価値
名前	リソース名	糸 制約： 最小長 = 1 最大長 = 1 パターン = ^[^*#&+:<>?]+$ (必須)
親	Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「親リソースの外部 子リソース」を参照してください。	種類のリソースのシンボリック名: サービス
プロパティ	更新プロパティの API エンティティの作成。	ApiCreateOrUpdatePropertiesOrApiContractProperties

OAuth2AuthenticationSettingsContract

名前	形容	価値
authorizationServerId	OAuth 承認サーバー識別子。	糸
スコープ	操作スコープ。	糸

OpenIdAuthenticationSettingsContract

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

SubscriptionKeyParameterNamesContract

名前	形容	価値
ヘッダ	サブスクリプション キーのヘッダー名。	糸
クエリ	サブスクリプション キークエリ文字列パラメーター名。	糸

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

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

• リソース グループの - リソース グループのデプロイ コマンド 参照

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

リソースの形式

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

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2018-01-01",
  "name": "string",
  "properties": {
    "apiRevision": "string",
    "apiRevisionDescription": "string",
    "apiType": "string",
    "apiVersion": "string",
    "apiVersionDescription": "string",
    "apiVersionSet": {
      "description": "string",
      "id": "string",
      "versionHeaderName": "string",
      "versioningScheme": "string",
      "versionQueryName": "string"
    },
    "apiVersionSetId": "string",
    "authenticationSettings": {
      "oAuth2": {
        "authorizationServerId": "string",
        "scope": "string"
      },
      "openid": {
        "bearerTokenSendingMethods": [ "string" ],
        "openidProviderId": "string"
      },
      "subscriptionKeyRequired": "bool"
    },
    "contentFormat": "string",
    "contentValue": "string",
    "description": "string",
    "displayName": "string",
    "path": "string",
    "protocols": [ "string" ],
    "serviceUrl": "string",
    "subscriptionKeyParameterNames": {
      "header": "string",
      "query": "string"
    },
    "type": "string",
    "wsdlSelector": {
      "wsdlEndpointName": "string",
      "wsdlServiceName": "string"
    }
  }
}

プロパティ値

ApiCreateOrUpdatePropertiesOrApiContractProperties

名前	形容	価値
apiRevision	API のリビジョンについて説明します。 値が指定されていない場合は、既定のリビジョン 1 が作成されます	糸 制約： 最小長 = 1 最大長 = 1
apiRevisionDescription	API リビジョンの説明。	糸 制約： 最大長 =
apiType	作成する API の種類。 SOAP to REST API を作成 * http * soap SOAP パススルー API を作成します。	'http' 'soap'
apiVersion	API がバージョン管理されている場合は、API のバージョン識別子を示します	糸 制約： 最大長 =
apiVersionDescription	API バージョンの説明。	糸 制約： 最大長 =
apiVersionSet	API バージョン セットには、関連する一連の API バージョンの共通構成が含まれています	ApiVersionSetContractDetails
apiVersionSetId	関連する ApiVersionSet のリソース識別子。	糸
authenticationSettings	この API に含まれる認証設定のコレクション。	AuthenticationSettingsContract
contentFormat	API がインポートされるコンテンツの形式。	'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link'
contentValue	API のインポート時のコンテンツ値。	糸
形容	API の説明。 HTML 書式設定タグを含めることができます。	糸
displayName	API 名。	糸 制約： 最小長 = 1 最大長 = 1
パス	この API と API Management サービス インスタンス内のすべてのリソース パスを一意に識別する相対 URL。 この API のパブリック URL を形成するために、サービス インスタンスの作成時に指定された API エンドポイントのベース URL に追加されます。	糸 制約： 最大長 = (必須)
プロトコル	この API の操作を呼び出すことができるプロトコルについて説明します。	次のいずれかを含む文字列配列: 'http' 'https'
serviceUrl	この API を実装するバックエンド サービスの絶対 URL。	糸 制約： 最大長 =
subscriptionKeyParameterNames	API を使用できるようにするプロトコル。	SubscriptionKeyParameterNamesContract の
種類	API の種類。	'http' 'soap'
wsdlSelector	WSDL のインポートをドキュメントのサブセットに制限する条件。	ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

名前	形容	価値
wsdlEndpointName	WSDL からインポートするエンドポイント (ポート) の名前	糸
wsdlServiceName	WSDL からインポートするサービスの名前	糸

ApiVersionSetContractDetails

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

AuthenticationSettingsContract

名前	形容	価値
oAuth2	OAuth2 認証の設定	OAuth2AuthenticationSettingsContract
openid	OpenID Connect の認証設定	OpenIdAuthenticationSettingsContract
subscriptionKeyRequired	この API の呼び出し中にサブスクリプション キーが必要かどうかを指定します。true - API は閉じた製品にのみ含まれます。false - API はオープン製品のみに含まれます。null - 製品が混在しています。	bool

Microsoft.ApiManagement/service/apis

名前	形容	価値
apiVersion	API のバージョン	'2018-01-01'
名前	リソース名	糸 制約： 最小長 = 1 最大長 = 1 パターン = ^[^*#&+:<>?]+$ (必須)
プロパティ	更新プロパティの API エンティティの作成。	ApiCreateOrUpdatePropertiesOrApiContractProperties
種類	リソースの種類	'Microsoft.ApiManagement/service/apis'

OAuth2AuthenticationSettingsContract

名前	形容	価値
authorizationServerId	OAuth 承認サーバー識別子。	糸
スコープ	操作スコープ。	糸

OpenIdAuthenticationSettingsContract

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

SubscriptionKeyParameterNamesContract

名前	形容	価値
ヘッダ	サブスクリプション キーのヘッダー名。	糸
クエリ	サブスクリプション キークエリ文字列パラメーター名。	糸

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

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

• リソース グループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2018-01-01"
  name = "string"
  body = jsonencode({
    properties = {
      apiRevision = "string"
      apiRevisionDescription = "string"
      apiType = "string"
      apiVersion = "string"
      apiVersionDescription = "string"
      apiVersionSet = {
        description = "string"
        id = "string"
        versionHeaderName = "string"
        versioningScheme = "string"
        versionQueryName = "string"
      }
      apiVersionSetId = "string"
      authenticationSettings = {
        oAuth2 = {
          authorizationServerId = "string"
          scope = "string"
        }
        openid = {
          bearerTokenSendingMethods = [
            "string"
          ]
          openidProviderId = "string"
        }
        subscriptionKeyRequired = bool
      }
      contentFormat = "string"
      contentValue = "string"
      description = "string"
      displayName = "string"
      path = "string"
      protocols = [
        "string"
      ]
      serviceUrl = "string"
      subscriptionKeyParameterNames = {
        header = "string"
        query = "string"
      }
      type = "string"
      wsdlSelector = {
        wsdlEndpointName = "string"
        wsdlServiceName = "string"
      }
    }
  })
}

プロパティ値

ApiCreateOrUpdatePropertiesOrApiContractProperties

名前	形容	価値
apiRevision	API のリビジョンについて説明します。 値が指定されていない場合は、既定のリビジョン 1 が作成されます	糸 制約： 最小長 = 1 最大長 = 1
apiRevisionDescription	API リビジョンの説明。	糸 制約： 最大長 =
apiType	作成する API の種類。 SOAP to REST API を作成 * http * soap SOAP パススルー API を作成します。	'http' 'soap'
apiVersion	API がバージョン管理されている場合は、API のバージョン識別子を示します	糸 制約： 最大長 =
apiVersionDescription	API バージョンの説明。	糸 制約： 最大長 =
apiVersionSet	API バージョン セットには、関連する一連の API バージョンの共通構成が含まれています	ApiVersionSetContractDetails
apiVersionSetId	関連する ApiVersionSet のリソース識別子。	糸
authenticationSettings	この API に含まれる認証設定のコレクション。	AuthenticationSettingsContract
contentFormat	API がインポートされるコンテンツの形式。	'swagger-json' 'swagger-link-json' 'wadl-link-json' 'wadl-xml' 'wsdl' 'wsdl-link'
contentValue	API のインポート時のコンテンツ値。	糸
形容	API の説明。 HTML 書式設定タグを含めることができます。	糸
displayName	API 名。	糸 制約： 最小長 = 1 最大長 = 1
パス	この API と API Management サービス インスタンス内のすべてのリソース パスを一意に識別する相対 URL。 この API のパブリック URL を形成するために、サービス インスタンスの作成時に指定された API エンドポイントのベース URL に追加されます。	糸 制約： 最大長 = (必須)
プロトコル	この API の操作を呼び出すことができるプロトコルについて説明します。	次のいずれかを含む文字列配列: 'http' 'https'
serviceUrl	この API を実装するバックエンド サービスの絶対 URL。	糸 制約： 最大長 =
subscriptionKeyParameterNames	API を使用できるようにするプロトコル。	SubscriptionKeyParameterNamesContract の
種類	API の種類。	'http' 'soap'
wsdlSelector	WSDL のインポートをドキュメントのサブセットに制限する条件。	ApiCreateOrUpdatePropertiesWsdlSelector

ApiCreateOrUpdatePropertiesWsdlSelector

名前	形容	価値
wsdlEndpointName	WSDL からインポートするエンドポイント (ポート) の名前	糸
wsdlServiceName	WSDL からインポートするサービスの名前	糸

ApiVersionSetContractDetails

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

AuthenticationSettingsContract

名前	形容	価値
oAuth2	OAuth2 認証の設定	OAuth2AuthenticationSettingsContract
openid	OpenID Connect の認証設定	OpenIdAuthenticationSettingsContract
subscriptionKeyRequired	この API の呼び出し中にサブスクリプション キーが必要かどうかを指定します。true - API は閉じた製品にのみ含まれます。false - API はオープン製品のみに含まれます。null - 製品が混在しています。	bool

Microsoft.ApiManagement/service/apis

名前	形容	価値
名前	リソース名	糸 制約： 最小長 = 1 最大長 = 1 パターン = ^[^*#&+:<>?]+$ (必須)
parent_id	このリソースの親であるリソースの ID。	種類のリソースの ID: サービス
プロパティ	更新プロパティの API エンティティの作成。	ApiCreateOrUpdatePropertiesOrApiContractProperties
種類	リソースの種類	"Microsoft.ApiManagement/service/apis@2018-01-01"

OAuth2AuthenticationSettingsContract

名前	形容	価値
authorizationServerId	OAuth 承認サーバー識別子。	糸
スコープ	操作スコープ。	糸

OpenIdAuthenticationSettingsContract

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

SubscriptionKeyParameterNamesContract

名前	形容	価値
ヘッダ	サブスクリプション キーのヘッダー名。	糸
クエリ	サブスクリプション キークエリ文字列パラメーター名。	糸