Microsoft.ApiManagement サービス/サブスクリプション 2023-09-01-preview

  • [アーティクル]

Bicep リソース定義

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

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

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

リソースの形式

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

resource symbolicname 'Microsoft.ApiManagement/service/subscriptions@2023-09-01-preview' = {
  name: 'string'
  parent: resourceSymbolicName
  properties: {
    allowTracing: bool
    displayName: 'string'
    ownerId: 'string'
    primaryKey: 'string'
    scope: 'string'
    secondaryKey: 'string'
    state: 'string'
  }
}

プロパティ値

service/subscriptions

名前 形容 価値
名前 リソース名

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

文字制限: 1 ~ 80

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

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

詳細については、「親リソースの外部 子リソース」を参照してください。		 種類のリソースのシンボリック名: サービス
プロパティ サブスクリプション コントラクトのプロパティ。 SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

名前 形容 価値
allowTracing トレースを有効にできるかどうかを決定します bool
displayName サブスクリプション名。 string (必須)

制約：
最小長 = 1
最大長 = 100
ownerId /users/{userId} 形式でサブスクリプションを作成するユーザー (ユーザー ID パス) 糸
primaryKey プライマリ サブスクリプション キー。 要求時に指定しない場合は、キーが自動的に生成されます。 糸

制約：
最小長 = 1
最大長 = 256
スコープ /products/{productId} や /apis、/apis/{apiId} などのスコープ。 string (必須)
secondaryKey セカンダリ サブスクリプション キー。 要求時に指定しない場合は、キーが自動的に生成されます。 糸

制約：
最小長 = 1
最大長 = 256
状態 初期サブスクリプションの状態。 値が指定されていない場合、サブスクリプションは送信済み状態で作成されます。 可能な状態は *アクティブです。サブスクリプションがアクティブで、* 中断されています。サブスクリプションはブロックされ、サブスクライバーは製品の API を呼び出すことができません。送信済み - サブスクリプション要求は開発者によって行われましたが、まだ承認または拒否されていません。* 拒否されました。サブスクリプション要求は管理者によって拒否されました。* 取り消されました。サブスクリプションは開発者または管理者によって取り消されました。 * 期限切れ – サブスクリプションは有効期限に達し、非アクティブ化されました。 'active'
'cancelled'
'expired'
'rejected'
'submitted'
'suspended'

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

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

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

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

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

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

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

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

リソースの形式

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

{
  "type": "Microsoft.ApiManagement/service/subscriptions",
  "apiVersion": "2023-09-01-preview",
  "name": "string",
  "properties": {
    "allowTracing": "bool",
    "displayName": "string",
    "ownerId": "string",
    "primaryKey": "string",
    "scope": "string",
    "secondaryKey": "string",
    "state": "string"
  }
}

プロパティ値

service/subscriptions

名前 形容 価値
種類 リソースの種類 'Microsoft.ApiManagement/service/subscriptions'
apiVersion リソース API のバージョン '2023-09-01-preview'
名前 リソース名

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

文字制限: 1 ~ 80

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

文字で始まり、英数字で終わる。
プロパティ サブスクリプション コントラクトのプロパティ。 SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

名前 形容 価値
allowTracing トレースを有効にできるかどうかを決定します bool
displayName サブスクリプション名。 string (必須)

制約：
最小長 = 1
最大長 = 100
ownerId /users/{userId} 形式でサブスクリプションを作成するユーザー (ユーザー ID パス) 糸
primaryKey プライマリ サブスクリプション キー。 要求時に指定しない場合は、キーが自動的に生成されます。 糸

制約：
最小長 = 1
最大長 = 256
スコープ /products/{productId} や /apis、/apis/{apiId} などのスコープ。 string (必須)
secondaryKey セカンダリ サブスクリプション キー。 要求時に指定しない場合は、キーが自動的に生成されます。 糸

制約：
最小長 = 1
最大長 = 256
状態 初期サブスクリプションの状態。 値が指定されていない場合、サブスクリプションは送信済み状態で作成されます。 可能な状態は *アクティブです。サブスクリプションがアクティブで、* 中断されています。サブスクリプションはブロックされ、サブスクライバーは製品の API を呼び出すことができません。送信済み - サブスクリプション要求は開発者によって行われましたが、まだ承認または拒否されていません。* 拒否されました。サブスクリプション要求は管理者によって拒否されました。* 取り消されました。サブスクリプションは開発者または管理者によって取り消されました。 * 期限切れ – サブスクリプションは有効期限に達し、非アクティブ化されました。 'active'
'cancelled'
'expired'
'rejected'
'submitted'
'suspended'

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

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

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

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

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

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

  • リソース グループの

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

リソースの形式

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

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

名前 形容 価値
種類 リソースの種類 "Microsoft.ApiManagement/service/subscriptions@2023-09-01-preview"
名前 リソース名 string (必須)

文字制限: 1 ~ 80

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

文字で始まり、英数字で終わる。
parent_id このリソースの親であるリソースの ID。 種類のリソースの ID: サービス
プロパティ サブスクリプション コントラクトのプロパティ。 SubscriptionCreateParameterPropertiesOrSubscriptionC...

SubscriptionCreateParameterPropertiesOrSubscriptionC...

名前 形容 価値
allowTracing トレースを有効にできるかどうかを決定します bool
displayName サブスクリプション名。 string (必須)

制約：
最小長 = 1
最大長 = 100
ownerId /users/{userId} 形式でサブスクリプションを作成するユーザー (ユーザー ID パス) 糸
primaryKey プライマリ サブスクリプション キー。 要求時に指定しない場合は、キーが自動的に生成されます。 糸

制約：
最小長 = 1
最大長 = 256
スコープ /products/{productId} や /apis、/apis/{apiId} などのスコープ。 string (必須)
secondaryKey セカンダリ サブスクリプション キー。 要求時に指定しない場合は、キーが自動的に生成されます。 糸

制約：
最小長 = 1
最大長 = 256
状態 初期サブスクリプションの状態。 値が指定されていない場合、サブスクリプションは送信済み状態で作成されます。 可能な状態は *アクティブです。サブスクリプションがアクティブで、* 中断されています。サブスクリプションはブロックされ、サブスクライバーは製品の API を呼び出すことができません。送信済み - サブスクリプション要求は開発者によって行われましたが、まだ承認または拒否されていません。* 拒否されました。サブスクリプション要求は管理者によって拒否されました。* 取り消されました。サブスクリプションは開発者または管理者によって取り消されました。 * 期限切れ – サブスクリプションは有効期限に達し、非アクティブ化されました。 "active"
"cancelled"
"expired"
"rejected"
"submitted"
"suspended"