Microsoft.ApiManagement service/apis 2021-01-01-preview

[アーティクル]
12/21/2024

Bicep リソース定義

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

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

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

リソースの形式

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

resource symbolicname 'Microsoft.ApiManagement/service/apis@2021-01-01-preview' = {
  parent: resourceSymbolicName
  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'
    }
  }
}

プロパティ値

ApiContactInformation

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

ApiCreateOrUpdatePropertiesOrApiContractProperties

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

ApiCreateOrUpdatePropertiesWsdlSelector

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

ApiLicenseInformation

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

ApiVersionSetContractDetails

名前	形容	価値
形容	API バージョンセットの説明。	糸
身分証明書	既存の 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

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": "2021-01-01-preview",
  "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"
    }
  }
}

プロパティ値

ApiContactInformation

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

ApiCreateOrUpdatePropertiesOrApiContractProperties

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

ApiCreateOrUpdatePropertiesWsdlSelector

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

ApiLicenseInformation

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

ApiVersionSetContractDetails

名前	形容	価値
形容	API バージョンセットの説明。	糸
身分証明書	既存の 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

Microsoft.ApiManagement/service/apis

名前	形容	価値
apiVersion	API のバージョン	'2021-01-01-preview'
名前	リソース名	糸制約：最小長 = 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@2021-01-01-preview"
  name = "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"
      }
    }
  })
}

プロパティ値

ApiContactInformation

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

ApiCreateOrUpdatePropertiesOrApiContractProperties

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

ApiCreateOrUpdatePropertiesWsdlSelector

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

ApiLicenseInformation

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

ApiVersionSetContractDetails

名前	形容	価値
形容	API バージョンセットの説明。	糸
身分証明書	既存の 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

Microsoft.ApiManagement/service/apis

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

OAuth2AuthenticationSettingsContract

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

OpenIdAuthenticationSettingsContract

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

SubscriptionKeyParameterNamesContract

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

次の方法で共有

Microsoft.ApiManagement service/apis 2021-01-01-preview

Bicep リソース定義

リソースの形式

プロパティ値

ApiContactInformation

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesWsdlSelector

ApiLicenseInformation

ApiVersionSetContractDetails

AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

SubscriptionKeyParameterNamesContract

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

リソースの形式

プロパティ値

ApiContactInformation

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesWsdlSelector

ApiLicenseInformation

ApiVersionSetContractDetails

AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

SubscriptionKeyParameterNamesContract

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

リソースの形式

プロパティ値

ApiContactInformation

ApiCreateOrUpdatePropertiesOrApiContractProperties

ApiCreateOrUpdatePropertiesWsdlSelector

ApiLicenseInformation

ApiVersionSetContractDetails

AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

OAuth2AuthenticationSettingsContract

OpenIdAuthenticationSettingsContract

SubscriptionKeyParameterNamesContract

フィードバック

その他のリソース

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