Group interface
グループを表すインターフェイス。
メソッド
| create |
グループを作成または更新します。 |
| delete(string, string, string, string, Group |
API Management サービス インスタンスの特定のグループを削除します。 |
| get(string, string, string, Group |
識別子で指定されたグループの詳細を取得します。 |
| get |
識別子で指定されたグループのエンティティ状態 (Etag) バージョンを取得します。 |
| list |
サービス インスタンス内で定義されているグループのコレクションを一覧表示します。 |
| update(string, string, string, string, Group |
識別子で指定されたグループの詳細を更新します。 |
メソッドの詳細
createOrUpdate(string, string, string, GroupCreateParameters, GroupCreateOrUpdateOptionalParams)
グループを作成または更新します。
function createOrUpdate(resourceGroupName: string, serviceName: string, groupId: string, parameters: GroupCreateParameters, options?: GroupCreateOrUpdateOptionalParams): Promise<GroupCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- groupId
-
string
グループ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- parameters
- GroupCreateParameters
パラメーターを作成します。
options パラメーター。
戻り値
Promise<GroupCreateOrUpdateResponse>
delete(string, string, string, string, GroupDeleteOptionalParams)
API Management サービス インスタンスの特定のグループを削除します。
function delete(resourceGroupName: string, serviceName: string, groupId: string, ifMatch: string, options?: GroupDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- groupId
-
string
グループ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- options
- GroupDeleteOptionalParams
options パラメーター。
戻り値
Promise<void>
get(string, string, string, GroupGetOptionalParams)
識別子で指定されたグループの詳細を取得します。
function get(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupGetOptionalParams): Promise<GroupGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- groupId
-
string
グループ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- GroupGetOptionalParams
options パラメーター。
戻り値
Promise<GroupGetResponse>
getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)
識別子で指定されたグループのエンティティ状態 (Etag) バージョンを取得します。
function getEntityTag(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupGetEntityTagOptionalParams): Promise<GroupGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- groupId
-
string
グループ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- GroupGetEntityTagOptionalParams
options パラメーター。
戻り値
Promise<GroupGetEntityTagHeaders>
listByService(string, string, GroupListByServiceOptionalParams)
サービス インスタンス内で定義されているグループのコレクションを一覧表示します。
function listByService(resourceGroupName: string, serviceName: string, options?: GroupListByServiceOptionalParams): PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- options
- GroupListByServiceOptionalParams
options パラメーター。
戻り値
update(string, string, string, string, GroupUpdateParameters, GroupUpdateOptionalParams)
識別子で指定されたグループの詳細を更新します。
function update(resourceGroupName: string, serviceName: string, groupId: string, ifMatch: string, parameters: GroupUpdateParameters, options?: GroupUpdateOptionalParams): Promise<GroupUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- groupId
-
string
グループ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- parameters
- GroupUpdateParameters
パラメーターを更新します。
- options
- GroupUpdateOptionalParams
options パラメーター。
戻り値
Promise<GroupUpdateResponse>