Microsoft.ApiManagement サービス/workspaces/products
- 最新の を
する - 2023-09-01-preview
Bicep リソース定義
サービス/ワークスペース/製品のリソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.ApiManagement/service/workspaces/products リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.ApiManagement/service/workspaces/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/workspaces/products
| 名前 | 形容 | 価値 |
|---|---|---|
| 名前 | リソース名 Bicepで子リソースの名前と種類 |
string (必須) |
| 親 | 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 |
| 条件 | 製品使用条件。 製品をサブスクライブしようとしている開発者は、サブスクリプション プロセスを完了する前に、これらの条件に同意する必要があります。 | 糸 |
ARM テンプレート リソース定義
サービス/ワークスペース/製品のリソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループの - リソース グループのデプロイ コマンド 参照
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.ApiManagement/service/workspaces/products リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.ApiManagement/service/workspaces/products",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"approvalRequired": "bool",
"description": "string",
"displayName": "string",
"state": "string",
"subscriptionRequired": "bool",
"subscriptionsLimit": "int",
"terms": "string"
}
}
プロパティ値
service/workspaces/products
| 名前 | 形容 | 価値 |
|---|---|---|
| 種類 | リソースの種類 | 'Microsoft.ApiManagement/service/workspaces/products' |
| apiVersion | リソース API のバージョン | '2023-09-01-preview' |
| 名前 | リソース名 JSON ARM テンプレートで子リソースの名前と型 |
string (必須) |
| プロパティ | 製品エンティティ コントラクトのプロパティ。 | 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 |
| 条件 | 製品使用条件。 製品をサブスクライブしようとしている開発者は、サブスクリプション プロセスを完了する前に、これらの条件に同意する必要があります。 | 糸 |
Terraform (AzAPI プロバイダー) リソース定義
サービス/ワークスペース/製品のリソースの種類は、次を対象とする操作と共にデプロイできます。
- リソース グループの
各 API バージョンで変更されたプロパティの一覧については、変更ログの
リソースの形式
Microsoft.ApiManagement/service/workspaces/products リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/workspaces/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/workspaces/products
| 名前 | 形容 | 価値 |
|---|---|---|
| 種類 | リソースの種類 | "Microsoft.ApiManagement/service/workspaces/products@2023-09-01-preview" |
| 名前 | リソース名 | string (必須) |
| 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 |
| 条件 | 製品使用条件。 製品をサブスクライブしようとしている開発者は、サブスクリプション プロセスを完了する前に、これらの条件に同意する必要があります。 | 糸 |