次の方法で共有

Microsoft.ApiManagement service/apis 2016-07-07

  • [アーティクル]

Bicep リソース定義

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

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

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

リソースの形式

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

resource symbolicname 'Microsoft.ApiManagement/service/apis@2016-07-07' = {
  parent: resourceSymbolicName
  authenticationSettings: {
    oAuth2: {
      authorizationServerId: 'string'
      scope: 'string'
    }
  }
  description: 'string'
  name: 'string'
  path: 'string'
  protocols: [
    'string'
  ]
  serviceUrl: 'string'
  subscriptionKeyParameterNames: {
    header: 'string'
    query: 'string'
  }
}

プロパティ値

AuthenticationSettingsContract

名前 形容 価値
oAuth2 API OAuth2 認証設定の詳細。 OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

名前 形容 価値
authenticationSettings この API に含まれる認証設定のコレクション。 AuthenticationSettingsContract
形容 API の説明。 HTML 書式設定タグを含めることができます。 糸
名前 リソース名 糸

制約：
最小長 = 1
最大長 = 1
パターン = ^[^*#&+:<>?]+$ (必須)
親 Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「親リソースの外部 子リソース」を参照してください。		 種類のリソースのシンボリック名: サービス
パス この API と API Management サービス インスタンス内のすべてのリソース パスを一意に識別する相対 URL。 この API のパブリック URL を形成するために、サービス インスタンスの作成時に指定された API エンドポイントのベース URL に追加されます。 糸

制約：
最大長 = (必須)
プロトコル この API の操作を呼び出すことができるプロトコルについて説明します。 次のいずれかを含む文字列配列:
'Http'
'Https' (必須)
serviceUrl この API を実装するバックエンド サービスの絶対 URL。 糸

制約：
最小長 = 1
最大長 = 1 (必須)
subscriptionKeyParameterNames API を使用できるようにするプロトコル。 SubscriptionKeyParameterNamesContract の

OAuth2AuthenticationSettingsContract

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

SubscriptionKeyParameterNamesContract

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

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

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

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

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

リソースの形式

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

{
  "type": "Microsoft.ApiManagement/service/apis",
  "apiVersion": "2016-07-07",
  "name": "string",
  "authenticationSettings": {
    "oAuth2": {
      "authorizationServerId": "string",
      "scope": "string"
    }
  },
  "description": "string",
  "path": "string",
  "protocols": [ "string" ],
  "serviceUrl": "string",
  "subscriptionKeyParameterNames": {
    "header": "string",
    "query": "string"
  }
}

プロパティ値

AuthenticationSettingsContract

名前 形容 価値
oAuth2 API OAuth2 認証設定の詳細。 OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

名前 形容 価値
apiVersion API のバージョン '2016-07-07'
authenticationSettings この API に含まれる認証設定のコレクション。 AuthenticationSettingsContract
形容 API の説明。 HTML 書式設定タグを含めることができます。 糸
名前 リソース名 糸

制約：
最小長 = 1
最大長 = 1
パターン = ^[^*#&+:<>?]+$ (必須)
パス この API と API Management サービス インスタンス内のすべてのリソース パスを一意に識別する相対 URL。 この API のパブリック URL を形成するために、サービス インスタンスの作成時に指定された API エンドポイントのベース URL に追加されます。 糸

制約：
最大長 = (必須)
プロトコル この API の操作を呼び出すことができるプロトコルについて説明します。 次のいずれかを含む文字列配列:
'Http'
'Https' (必須)
serviceUrl この API を実装するバックエンド サービスの絶対 URL。 糸

制約：
最小長 = 1
最大長 = 1 (必須)
subscriptionKeyParameterNames API を使用できるようにするプロトコル。 SubscriptionKeyParameterNamesContract の
種類 リソースの種類 'Microsoft.ApiManagement/service/apis'

OAuth2AuthenticationSettingsContract

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

SubscriptionKeyParameterNamesContract

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

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

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

  • リソース グループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/apis@2016-07-07"
  name = "string"
  authenticationSettings = {
    oAuth2 = {
      authorizationServerId = "string"
      scope = "string"
    }
  }
  description = "string"
  path = "string"
  protocols = [
    "string"
  ]
  serviceUrl = "string"
  subscriptionKeyParameterNames = {
    header = "string"
    query = "string"
  }
}

プロパティ値

AuthenticationSettingsContract

名前 形容 価値
oAuth2 API OAuth2 認証設定の詳細。 OAuth2AuthenticationSettingsContract

Microsoft.ApiManagement/service/apis

名前 形容 価値
authenticationSettings この API に含まれる認証設定のコレクション。 AuthenticationSettingsContract
形容 API の説明。 HTML 書式設定タグを含めることができます。 糸
名前 リソース名 糸

制約：
最小長 = 1
最大長 = 1
パターン = ^[^*#&+:<>?]+$ (必須)
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: サービス
パス この API と API Management サービス インスタンス内のすべてのリソース パスを一意に識別する相対 URL。 この API のパブリック URL を形成するために、サービス インスタンスの作成時に指定された API エンドポイントのベース URL に追加されます。 糸

制約：
最大長 = (必須)
プロトコル この API の操作を呼び出すことができるプロトコルについて説明します。 次のいずれかを含む文字列配列:
'Http'
'Https' (必須)
serviceUrl この API を実装するバックエンド サービスの絶対 URL。 糸

制約：
最小長 = 1
最大長 = 1 (必須)
subscriptionKeyParameterNames API を使用できるようにするプロトコル。 SubscriptionKeyParameterNamesContract の
種類 リソースの種類 "Microsoft.ApiManagement/service/apis@2016-07-07"

OAuth2AuthenticationSettingsContract

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

SubscriptionKeyParameterNamesContract

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