Microsoft.ApiManagement サービス/サブスクリプション 2022-04-01-preview
Bicep リソース定義
サービス/サブスクリプションのリソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ApiManagement/service/subscriptions リソースを作成するには、次の Bicep をテンプレートに追加します。
resource symbolicname 'Microsoft.ApiManagement/service/subscriptions@2022-04-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
allowTracing: bool
displayName: 'string'
ownerId: 'string'
primaryKey: 'string'
scope: 'string'
secondaryKey: 'string'
state: 'string'
}
}
プロパティ値
service/subscriptions
| 名前 | 説明 | 値 |
|---|---|---|
| name | リソース名 Bicep で子リソースの名前と型を設定する方法を参照してください。 |
string (必須) 文字数制限: 1 から 80 有効な文字: 英数字とハイフン。 先頭は文字、末尾は英数字にします。 |
| parent | Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。 詳細については、「 親リソースの外部にある子リソース」を参照してください。 |
種類のリソースのシンボル名: service |
| properties | サブスクリプション コントラクトのプロパティ。 | SubscriptionCreateParameterPropertiesOrSubscriptionC... |
SubscriptionCreateParameterPropertiesOrSubscriptionC...
| 名前 | 説明 | 値 |
|---|---|---|
| allowTracing | トレースを有効にできるかどうかを決定します | [bool] |
| displayName | サブスクリプションの名前。 | string (必須) |
| ownerId | /users/{userId} 形式でサブスクリプションを作成しているユーザー (ユーザー ID パス) | string |
| primaryKey | プライマリ サブスクリプション キー。 要求時に指定されていない場合は、キーが自動的に生成されます。 | string |
| scope | /products/{productId} や /apis または /apis/{apiId} などのスコープ。 | string (必須) |
| secondaryKey | セカンダリ サブスクリプション キー。 要求時に指定されていない場合は、キーが自動的に生成されます。 | string |
| state | 初期サブスクリプションの状態。 値が指定されていない場合、サブスクリプションは送信済み状態で作成されます。 可能な状態は * アクティブです。 サブスクリプションがアクティブで、 * 中断 – サブスクリプションがブロックされ、サブスクライバーは製品の API を呼び出すことができません。* 送信済み - サブスクリプション要求は開発者によって行われましたが、まだ承認または拒否されていません。* 拒否 – サブスクリプション要求が管理者によって拒否されました。* 取り消されました。 * 有効期限切れ – サブスクリプションが有効期限に達し、非アクティブ化されました。 | 'active' 'cancelled' 'expired' 'rejected' 'submitted' 'suspended' |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template | 説明 |
|---|---|
テンプレートを使用して API Management インスタンスとそのすべてのサブリソースを作成する |
このテンプレートでは、API Management サービスを作成し、サブエンティティを構成する方法を示します |
ARM テンプレート リソース定義
サービス/サブスクリプションのリソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ - リソース グループのデプロイ コマンドに関するページを参照してください
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ApiManagement/service/subscriptions リソースを作成するには、次の JSON をテンプレートに追加します。
{
"type": "Microsoft.ApiManagement/service/subscriptions",
"apiVersion": "2022-04-01-preview",
"name": "string",
"properties": {
"allowTracing": "bool",
"displayName": "string",
"ownerId": "string",
"primaryKey": "string",
"scope": "string",
"secondaryKey": "string",
"state": "string"
}
}
プロパティ値
service/subscriptions
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | 'Microsoft.ApiManagement/service/subscriptions' |
| apiVersion | リソース API のバージョン | '2022-04-01-preview' |
| name | リソース名 JSON ARM テンプレートで子リソースの名前と型を設定する方法を参照してください。 |
string (必須) 文字制限: 1 から 80 有効な文字: 英数字とハイフン。 先頭は文字、末尾は英数字にします。 |
| properties | サブスクリプション コントラクトのプロパティ。 | SubscriptionCreateParameterPropertiesOrSubscriptionC... |
SubscriptionCreateParameterPropertiesOrSubscriptionC...
| 名前 | 説明 | 値 |
|---|---|---|
| allowTracing | トレースを有効にできるかどうかを判断します | [bool] |
| displayName | サブスクリプションの名前。 | string (必須) |
| ownerId | サブスクリプションが /users/{userId} の形式で作成されているユーザー (ユーザー ID パス) | string |
| primaryKey | プライマリ サブスクリプション キー。 要求キー中に指定しない場合は、自動的に生成されます。 | string |
| scope | /products/{productId} や /apis または /apis/{apiId} などのスコープ。 | string (必須) |
| secondaryKey | セカンダリ サブスクリプション キー。 要求キー中に指定しない場合は、自動的に生成されます。 | string |
| state | 初期サブスクリプションの状態。 値が指定されていない場合は、送信済み状態でサブスクリプションが作成されます。 可能な状態は * アクティブです。 サブスクリプションがアクティブで、 * 中断 – サブスクリプションがブロックされ、サブスクライバーは製品の API を呼び出すことができません。送信済み - サブスクリプション要求は開発者によって行われましたが、まだ承認または拒否されていません。* 拒否されました。 サブスクリプション要求は管理者によって拒否されました。* 取り消されました。サブスクリプションは開発者または管理者によってキャンセルされました * 有効期限切れ – サブスクリプションが有効期限に達し、非アクティブ化されました。 | 'active' 'cancelled' 'expired' 'rejected' 'submitted' 'suspended' |
クイック スタート テンプレート
次のクイックスタート テンプレートでは、このリソースの種類をデプロイします。
| Template | 説明 |
|---|---|
| テンプレートを使用して API Management インスタンスとそのすべてのサブリソースを作成する |
このテンプレートでは、API Management サービスを作成し、サブエンティティを構成する方法を示します |
Terraform (AzAPI プロバイダー) リソース定義
サービス/サブスクリプション リソースの種類は、次を対象とする操作でデプロイできます。
- リソース グループ
各 API バージョンの変更されたプロパティの一覧については、「 変更ログ」を参照してください。
リソース形式
Microsoft.ApiManagement/service/subscriptions リソースを作成するには、次の Terraform をテンプレートに追加します。
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ApiManagement/service/subscriptions@2022-04-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
allowTracing = bool
displayName = "string"
ownerId = "string"
primaryKey = "string"
scope = "string"
secondaryKey = "string"
state = "string"
}
})
}
プロパティ値
service/subscriptions
| 名前 | 説明 | 値 |
|---|---|---|
| type | リソースの種類 | "Microsoft.ApiManagement/service/subscriptions@2022-04-01-preview" |
| name | リソース名 | string (必須) 文字制限: 1 から 80 有効な文字: 英数字とハイフン。 先頭は文字、末尾は英数字にします。 |
| parent_id | このリソースの親であるリソースの ID。 | 種類のリソースの ID: サービス |
| properties | サブスクリプション コントラクトのプロパティ。 | SubscriptionCreateParameterPropertiesOrSubscriptionC... |
SubscriptionCreateParameterPropertiesOrSubscriptionC...
| 名前 | 説明 | 値 |
|---|---|---|
| allowTracing | トレースを有効にできるかどうかを判断します | [bool] |
| displayName | サブスクリプションの名前。 | string (必須) |
| ownerId | サブスクリプションが /users/{userId} の形式で作成されているユーザー (ユーザー ID パス) | string |
| primaryKey | プライマリ サブスクリプション キー。 要求キー中に指定しない場合は、自動的に生成されます。 | string |
| scope | /products/{productId} や /apis または /apis/{apiId} などのスコープ。 | string (必須) |
| secondaryKey | セカンダリ サブスクリプション キー。 要求キー中に指定しない場合は、自動的に生成されます。 | string |
| state | 初期サブスクリプションの状態。 値が指定されていない場合、サブスクリプションは送信済み状態で作成されます。 可能な状態は * アクティブです。 サブスクリプションがアクティブで、 * 中断 – サブスクリプションがブロックされ、サブスクライバーは製品の API を呼び出すことができません。* 送信済み - サブスクリプション要求は開発者によって行われましたが、まだ承認または拒否されていません。* 拒否 – サブスクリプション要求が管理者によって拒否されました。* 取り消されました。 * 有効期限切れ – サブスクリプションが有効期限に達し、非アクティブ化されました。 | "active" "取り消されました" "有効期限切れ" "rejected" "submitted" "中断" |