Microsoft.ApiManagement サービス/workspaces/subscriptions

  • [アーティクル]

Bicep リソース定義

service/workspaces/subscriptions リソースの種類は、次を対象とする操作でデプロイできます。

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

リソース形式

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

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

プロパティ値

service/workspaces/subscriptions

名前 説明 値
name リソース名

Bicep で子リソースの名前と型を設定する方法を参照してください。		 string (必須)
parent Bicep では、子リソースの親リソースを指定できます。 このプロパティを追加する必要があるのは、子リソースが親リソースの外部で宣言されている場合のみです。

詳細については、「 親リソースの外部にある子リソース」を参照してください。		 種類のリソースのシンボル名: ワークスペース
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'

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

service/workspaces/subscriptions リソースの種類は、次を対象とする操作でデプロイできます。

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

リソース形式

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

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

プロパティ値

service/workspaces/subscriptions

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

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

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

service/workspaces/subscriptions リソースの種類は、次を対象とする操作でデプロイできます。

  • リソース グループ

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

リソース形式

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

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

名前 説明 値
type リソースの種類 "Microsoft.ApiManagement/service/workspaces/subscriptions@2023-03-01-preview"
name リソース名 string (必須)
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"
"中断"