ApiVersionSet interface
ApiVersionSet を表すインターフェイス。
メソッド
| create |
API バージョン セットを作成または更新します。 |
| delete(string, string, string, string, Api |
特定の API バージョン セットを削除します。 |
| get(string, string, string, Api |
識別子で指定された API バージョン セットの詳細を取得します。 |
| get |
識別子で指定された API バージョン セットのエンティティ状態 (Etag) バージョンを取得します。 |
| list |
指定されたサービス インスタンスにおける API バージョン セットのコレクションを一覧表示します。 |
| update(string, string, string, string, Api |
識別子で指定された Api VersionSet の詳細を更新します。 |
メソッドの詳細
createOrUpdate(string, string, string, ApiVersionSetContract, ApiVersionSetCreateOrUpdateOptionalParams)
API バージョン セットを作成または更新します。
function createOrUpdate(resourceGroupName: string, serviceName: string, versionSetId: string, parameters: ApiVersionSetContract, options?: ApiVersionSetCreateOrUpdateOptionalParams): Promise<ApiVersionSetCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- versionSetId
-
string
API バージョン セット識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- parameters
- ApiVersionSetContract
パラメーターを作成または更新します。
options パラメーター。
戻り値
Promise<ApiVersionSetCreateOrUpdateResponse>
delete(string, string, string, string, ApiVersionSetDeleteOptionalParams)
特定の API バージョン セットを削除します。
function delete(resourceGroupName: string, serviceName: string, versionSetId: string, ifMatch: string, options?: ApiVersionSetDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- versionSetId
-
string
API バージョン セット識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
options パラメーター。
戻り値
Promise<void>
get(string, string, string, ApiVersionSetGetOptionalParams)
識別子で指定された API バージョン セットの詳細を取得します。
function get(resourceGroupName: string, serviceName: string, versionSetId: string, options?: ApiVersionSetGetOptionalParams): Promise<ApiVersionSetGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- versionSetId
-
string
API バージョン セット識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- ApiVersionSetGetOptionalParams
options パラメーター。
戻り値
Promise<ApiVersionSetGetResponse>
getEntityTag(string, string, string, ApiVersionSetGetEntityTagOptionalParams)
識別子で指定された API バージョン セットのエンティティ状態 (Etag) バージョンを取得します。
function getEntityTag(resourceGroupName: string, serviceName: string, versionSetId: string, options?: ApiVersionSetGetEntityTagOptionalParams): Promise<ApiVersionSetGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- versionSetId
-
string
API バージョン セット識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
Promise<ApiVersionSetGetEntityTagHeaders>
listByService(string, string, ApiVersionSetListByServiceOptionalParams)
指定されたサービス インスタンスにおける API バージョン セットのコレクションを一覧表示します。
function listByService(resourceGroupName: string, serviceName: string, options?: ApiVersionSetListByServiceOptionalParams): PagedAsyncIterableIterator<ApiVersionSetContract, ApiVersionSetContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
options パラメーター。
戻り値
update(string, string, string, string, ApiVersionSetUpdateParameters, ApiVersionSetUpdateOptionalParams)
識別子で指定された Api VersionSet の詳細を更新します。
function update(resourceGroupName: string, serviceName: string, versionSetId: string, ifMatch: string, parameters: ApiVersionSetUpdateParameters, options?: ApiVersionSetUpdateOptionalParams): Promise<ApiVersionSetUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- versionSetId
-
string
API バージョン セット識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- parameters
- ApiVersionSetUpdateParameters
パラメーターを更新します。
options パラメーター。
戻り値
Promise<ApiVersionSetUpdateResponse>