SubscriptionCreateParameters interface

パッケージ:

@azure/arm-apimanagement

サブスクリプションの作成の詳細。

プロパティ

allowTracing	トレースを有効にできるかどうかを判断します
displayName	サブスクリプションの名前。
ownerId	サブスクリプションが /users/{userId} の形式で作成されているユーザー (ユーザー ID パス)
primaryKey	プライマリ サブスクリプション キー。 要求キー中に指定しない場合は、自動的に生成されます。
scope	/products/{productId} や /apis または /apis/{apiId} などのスコープ。
secondaryKey	セカンダリ サブスクリプション キー。 要求キー中に指定しない場合は、自動的に生成されます。
state	初期サブスクリプションの状態。 値が指定されていない場合は、送信済み状態でサブスクリプションが作成されます。 可能な状態は * アクティブです。 サブスクリプションがアクティブで、 * 中断 – サブスクリプションがブロックされ、サブスクライバーは製品の API を呼び出すことができません。送信済み - サブスクリプション要求は開発者によって行われましたが、まだ承認または拒否されていません。* 拒否されました。 サブスクリプション要求は管理者によって拒否されました。* 取り消されました。サブスクリプションは開発者または管理者によってキャンセルされました。 * 有効期限切れ – サブスクリプションが有効期限に達し、非アクティブ化されました。

プロパティの詳細

allowTracing

トレースを有効にできるかどうかを判断します

allowTracing?: boolean

プロパティ値

boolean

displayName

サブスクリプションの名前。

displayName?: string

プロパティ値

string

ownerId

サブスクリプションが /users/{userId} の形式で作成されているユーザー (ユーザー ID パス)

ownerId?: string

プロパティ値

string

primaryKey

プライマリ サブスクリプション キー。 要求キー中に指定しない場合は、自動的に生成されます。

primaryKey?: string

プロパティ値

string

scope

/products/{productId} や /apis または /apis/{apiId} などのスコープ。

scope?: string

プロパティ値

string

secondaryKey

セカンダリ サブスクリプション キー。 要求キー中に指定しない場合は、自動的に生成されます。

secondaryKey?: string

プロパティ値

string

state

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

state?: SubscriptionState

プロパティ値

SubscriptionState