Subscription interface
サブスクリプションを表すインターフェイス。
メソッド
メソッドの詳細
createOrUpdate(string, string, string, SubscriptionCreateParameters, SubscriptionCreateOrUpdateOptionalParams)
指定された製品に対する指定されたユーザーのサブスクリプションを作成または更新します。
function createOrUpdate(resourceGroupName: string, serviceName: string, sid: string, parameters: SubscriptionCreateParameters, options?: SubscriptionCreateOrUpdateOptionalParams): Promise<SubscriptionCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- sid
-
string
サブスクリプション エンティティ識別子。 エンティティは、API Management内のユーザーと製品の間の関連付けを表します。
- parameters
- SubscriptionCreateParameters
パラメーターを作成します。
options パラメーター。
戻り値
Promise<SubscriptionCreateOrUpdateResponse>
delete(string, string, string, string, SubscriptionDeleteOptionalParams)
指定されたサブスクリプションを削除します。
function delete(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, options?: SubscriptionDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- sid
-
string
サブスクリプション エンティティ識別子。 エンティティは、API Management内のユーザーと製品の間の関連付けを表します。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- options
- SubscriptionDeleteOptionalParams
options パラメーター。
戻り値
Promise<void>
get(string, string, string, SubscriptionGetOptionalParams)
指定した Subscription エンティティを取得します。
function get(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetOptionalParams): Promise<SubscriptionGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- sid
-
string
サブスクリプション エンティティ識別子。 エンティティは、API Management内のユーザーと製品の間の関連付けを表します。
- options
- SubscriptionGetOptionalParams
options パラメーター。
戻り値
Promise<SubscriptionGetResponse>
getEntityTag(string, string, string, SubscriptionGetEntityTagOptionalParams)
識別子で指定された apimanagement サブスクリプションのエンティティ状態 (Etag) バージョンを取得します。
function getEntityTag(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionGetEntityTagOptionalParams): Promise<SubscriptionGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- sid
-
string
サブスクリプション エンティティ識別子。 エンティティは、API Management内のユーザーと製品の間の関連付けを表します。
options パラメーター。
戻り値
Promise<SubscriptionGetEntityTagHeaders>
list(string, string, SubscriptionListOptionalParams)
API Management サービス インスタンスのすべてのサブスクリプションを一覧表示します。
function list(resourceGroupName: string, serviceName: string, options?: SubscriptionListOptionalParams): PagedAsyncIterableIterator<SubscriptionContract, SubscriptionContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- options
- SubscriptionListOptionalParams
options パラメーター。
戻り値
listSecrets(string, string, string, SubscriptionListSecretsOptionalParams)
指定されたサブスクリプション キーを取得します。
function listSecrets(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionListSecretsOptionalParams): Promise<SubscriptionListSecretsResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- sid
-
string
サブスクリプション エンティティ識別子。 エンティティは、API Management内のユーザーと製品の間の関連付けを表します。
options パラメーター。
戻り値
Promise<SubscriptionListSecretsResponse>
regeneratePrimaryKey(string, string, string, SubscriptionRegeneratePrimaryKeyOptionalParams)
API Management サービス インスタンスの既存のサブスクリプションの主キーを再生成します。
function regeneratePrimaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegeneratePrimaryKeyOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- sid
-
string
サブスクリプション エンティティ識別子。 エンティティは、API Management内のユーザーと製品の間の関連付けを表します。
options パラメーター。
戻り値
Promise<void>
regenerateSecondaryKey(string, string, string, SubscriptionRegenerateSecondaryKeyOptionalParams)
API Management サービス インスタンスの既存のサブスクリプションのセカンダリ キーを再生成します。
function regenerateSecondaryKey(resourceGroupName: string, serviceName: string, sid: string, options?: SubscriptionRegenerateSecondaryKeyOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- sid
-
string
サブスクリプション エンティティ識別子。 エンティティは、API Management内のユーザーと製品の間の関連付けを表します。
options パラメーター。
戻り値
Promise<void>
update(string, string, string, string, SubscriptionUpdateParameters, SubscriptionUpdateOptionalParams)
識別子で指定されたサブスクリプションの詳細を更新します。
function update(resourceGroupName: string, serviceName: string, sid: string, ifMatch: string, parameters: SubscriptionUpdateParameters, options?: SubscriptionUpdateOptionalParams): Promise<SubscriptionUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- sid
-
string
サブスクリプション エンティティ識別子。 エンティティは、API Management内のユーザーと製品の間の関連付けを表します。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- parameters
- SubscriptionUpdateParameters
パラメーターを更新します。
- options
- SubscriptionUpdateOptionalParams
options パラメーター。
戻り値
Promise<SubscriptionUpdateResponse>