Microsoft.ApiManagement サービス/製品

[アーティクル]
07/24/2024

Bicep リソース定義

サービス/製品のリソースの種類は、次をターゲットとする操作と共にデプロイできます。

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

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

リソースの形式

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

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

プロパティ値

service/products

名前	形容	価値
名前	リソース名 Bicepで子リソースの名前と種類設定する方法を参照してください。	string (必須) 文字制限: 1 ~ 80 有効な文字: 英数字とハイフン。文字で始まり、英数字で終わる。
親	Bicep では、子リソースの親リソースを指定できます。このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。詳細については、「親リソースの外部子リソース」を参照してください。	種類のリソースのシンボリック名: サービス
プロパティ	製品エンティティコントラクトのプロパティ。	ProductContractProperties

ProductContractProperties

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

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

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

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

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

サービス/製品のリソースの種類は、次をターゲットとする操作と共にデプロイできます。

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

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

リソースの形式

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

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

プロパティ値

service/products

名前	形容	価値
種類	リソースの種類	'Microsoft.ApiManagement/service/products'
apiVersion	リソース API のバージョン	'2023-09-01-preview'
名前	リソース名 JSON ARM テンプレートで子リソースの名前と型設定する方法を参照してください。	string (必須) 文字制限: 1 ~ 80 有効な文字: 英数字とハイフン。文字で始まり、英数字で終わる。
プロパティ	製品エンティティコントラクトのプロパティ。	ProductContractProperties

ProductContractProperties

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

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

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

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

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

サービス/製品のリソースの種類は、次をターゲットとする操作と共にデプロイできます。

リソースグループの

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

リソースの形式

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

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/products@2023-09-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

名前	形容	価値
種類	リソースの種類	"Microsoft.ApiManagement/service/products@2023-09-01-preview"
名前	リソース名	string (必須) 文字制限: 1 ~ 80 有効な文字: 英数字とハイフン。文字で始まり、英数字で終わる。
parent_id	このリソースの親であるリソースの ID。	種類のリソースの ID: サービス
プロパティ	製品エンティティコントラクトのプロパティ。	ProductContractProperties

ProductContractProperties

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

次の方法で共有

Microsoft.ApiManagement サービス/製品

Bicep リソース定義

リソースの形式

プロパティ値

service/products

ProductContractProperties

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

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

リソースの形式

プロパティ値

service/products

ProductContractProperties

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

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

リソースの形式

プロパティ値

service/products

ProductContractProperties

フィードバック

その他のリソース

次の方法で共有

Microsoft.ApiManagement サービス/製品

Bicep リソース定義

リソースの形式

プロパティ値

service/products

ProductContractProperties

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

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

リソースの形式

プロパティ値

service/products

ProductContractProperties

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

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

リソースの形式

プロパティ値

service/products

ProductContractProperties

フィードバック

その他のリソース

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

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

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