Microsoft.ApiManagement サービス/製品

  • [アーティクル]

Bicep リソース定義

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

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

リソース形式

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

resource symbolicname 'Microsoft.ApiManagement/service/products@2023-05-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    approvalRequired: bool
    description: 'string'
    displayName: 'string'
    state: 'string'
    subscriptionRequired: bool
    subscriptionsLimit: int
    terms: 'string'
  }
}

プロパティ値

service/products

名前 説明 値
name リソース名

Bicep で子リソースの名前と型を設定する方法を参照してください。		 string (必須)

文字数制限: 1 から 80

有効な文字:
英数字とハイフン。

先頭は文字、末尾は英数字にします。
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部にある子リソース」を参照してください。		 種類のリソースのシンボル名: service
properties 製品エンティティ コントラクトのプロパティ。 ProductContractProperties

ProductContractProperties

名前 説明 値
approvalRequired サブスクリプションの承認が必要かどうか。 false の場合、新しいサブスクリプションが自動的に承認され、サブスクライブ直後に開発者が製品の API を呼び出すことができます。 true の場合、管理者は、開発者が製品の API を使用する前に、サブスクリプションを手動で承認する必要があります。 subscriptionRequired プロパティが存在し、値が false の場合にのみ存在できます。 [bool]
description 製品の説明。 HTML 書式設定タグを含めることができます。 string
displayName 製品名。 string (必須)
state 製品が公開されているかどうか。 公開された製品は、開発者ポータルのユーザーが検出できます。 公開されていない製品は、管理者にのみ表示されます。 Product の既定の状態は発行されません。 'notPublished'
'発行済み'
subscriptionRequired この製品に含まれる API にアクセスするために製品サブスクリプションが必要かどうか。 true の場合、製品は "保護済み" と呼ばれ、製品に含まれる API への要求を成功させるために有効なサブスクリプション キーが必要です。 false の場合、製品は "オープン" と呼ばれ、製品に含まれる API への要求はサブスクリプション キーなしで行うことができます。 新しい製品を作成するときに プロパティを省略した場合、値は true と見なされます。 [bool]
subscriptionsLimit ユーザーがこの製品に対して同時に必要なサブスクリプションの数かどうか。 ユーザーサブスクリプションごとに無制限を許可するには、null または省略に設定します。 subscriptionRequired プロパティが存在し、値が false の場合にのみ存在できます。 INT
terms 製品の使用条件。 製品をサブスクライブしようとする開発者に提示される条件です。開発者は、サブスクリプション プロセスを完了する前にこれらの条件に同意する必要があります。 string

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

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

Template 説明
テンプレートを使用して API Management インスタンスとそのすべてのサブリソースを作成する

Azure にデプロイする		 このテンプレートでは、API Management サービスを作成し、サブエンティティを構成する方法を示します
Azure Front Door を Azure API Managementの前に作成する

Azure にデプロイする		 このサンプルでは、Azure Front Door を Azure API Managementの前でグローバル ロード バランサーとして使用する方法を示します。

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

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

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

リソース形式

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

{
  "type": "Microsoft.ApiManagement/service/products",
  "apiVersion": "2023-05-01-preview",
  "name": "string",
  "properties": {
    "approvalRequired": "bool",
    "description": "string",
    "displayName": "string",
    "state": "string",
    "subscriptionRequired": "bool",
    "subscriptionsLimit": "int",
    "terms": "string"
  }
}

プロパティ値

service/products

名前 説明 値
type リソースの種類 'Microsoft.ApiManagement/service/products'
apiVersion リソース API のバージョン '2023-05-01-preview'
name リソース名

JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。		 string (必須)

文字数制限: 1 から 80

有効な文字:
英数字とハイフン。

先頭は文字、末尾は英数字にします。
properties 製品エンティティ コントラクトのプロパティ。 ProductContractProperties

ProductContractProperties

名前 説明 値
approvalRequired サブスクリプションの承認が必要かどうか。 false の場合、新しいサブスクリプションが自動的に承認され、サブスクライブ直後に開発者が製品の API を呼び出すことができます。 true の場合、管理者は、開発者が製品の API を使用する前に、サブスクリプションを手動で承認する必要があります。 subscriptionRequired プロパティが存在し、値が false の場合にのみ存在できます。 [bool]
description 製品の説明。 HTML 書式設定タグを含めることができます。 string
displayName 製品名。 string (必須)
state 製品が公開されているかどうか。 公開された製品は、開発者ポータルのユーザーが検出できます。 公開されていない製品は、管理者にのみ表示されます。 Product の既定の状態は発行されません。 'notPublished'
'発行済み'
subscriptionRequired この製品に含まれる API にアクセスするために製品サブスクリプションが必要かどうか。 true の場合、製品は "保護済み" と呼ばれ、製品に含まれる API への要求を成功させるために有効なサブスクリプション キーが必要です。 false の場合、製品は "オープン" と呼ばれ、製品に含まれる API への要求はサブスクリプション キーなしで行うことができます。 新しい製品を作成するときに プロパティを省略した場合、値は true と見なされます。 [bool]
subscriptionsLimit ユーザーがこの製品に対して同時に必要なサブスクリプションの数かどうか。 ユーザーサブスクリプションごとに無制限を許可するには、null または省略に設定します。 subscriptionRequired プロパティが存在し、値が false の場合にのみ存在できます。 INT
terms 製品の使用条件。 製品をサブスクライブしようとする開発者に提示される条件です。開発者は、サブスクリプション プロセスを完了する前にこれらの条件に同意する必要があります。 string

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

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

Template 説明
テンプレートを使用して API Management インスタンスとそのすべてのサブリソースを作成する

Azure にデプロイする		 このテンプレートでは、API Management サービスを作成し、サブエンティティを構成する方法を示します
Azure Front Door を Azure API Managementの前に作成する

Azure にデプロイする		 このサンプルでは、Azure Front Door を Azure API Managementの前でグローバル ロード バランサーとして使用する方法を示します。

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

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

  • リソース グループ

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

リソース形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/products@2023-05-01-preview"
  name = "string"
  parent_id = "string"
  body = jsonencode({
    properties = {
      approvalRequired = bool
      description = "string"
      displayName = "string"
      state = "string"
      subscriptionRequired = bool
      subscriptionsLimit = int
      terms = "string"
    }
  })
}

プロパティ値

service/products

名前 説明 値
type リソースの種類 "Microsoft.ApiManagement/service/products@2023-05-01-preview"
name リソース名 string (必須)

文字数制限: 1 から 80

有効な文字:
英数字とハイフン。

先頭は文字、末尾は英数字にします。
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: サービス
properties 製品エンティティ コントラクトのプロパティ。 ProductContractProperties

ProductContractProperties

名前 説明 値
approvalRequired サブスクリプションの承認が必要かどうか。 false の場合、新しいサブスクリプションが自動的に承認され、サブスクライブ直後に開発者が製品の API を呼び出すことができます。 true の場合、管理者は、開発者が製品の API を使用する前に、サブスクリプションを手動で承認する必要があります。 subscriptionRequired プロパティが存在し、値が false の場合にのみ存在できます。 [bool]
description 製品の説明。 HTML 書式設定タグを含めることができます。 string
displayName 製品名。 string (必須)
state 製品が公開されているかどうか。 公開された製品は、開発者ポータルのユーザーが検出できます。 公開されていない製品は、管理者にのみ表示されます。 Product の既定の状態は発行されません。 "notPublished"
"発行済み"
subscriptionRequired この製品に含まれる API にアクセスするために製品サブスクリプションが必要かどうか。 true の場合、製品は "保護済み" と呼ばれ、製品に含まれる API への要求を成功させるために有効なサブスクリプション キーが必要です。 false の場合、製品は "オープン" と呼ばれ、製品に含まれる API への要求はサブスクリプション キーなしで行うことができます。 新しい製品を作成するときに プロパティを省略した場合、値は true と見なされます。 [bool]
subscriptionsLimit ユーザーがこの製品に対して同時に必要なサブスクリプションの数かどうか。 ユーザーサブスクリプションごとに無制限を許可するには、null または省略に設定します。 subscriptionRequired プロパティが存在し、値が false の場合にのみ存在できます。 INT
terms 製品の使用条件。 製品をサブスクライブしようとする開発者に提示される条件です。開発者は、サブスクリプション プロセスを完了する前にこれらの条件に同意する必要があります。 string