ProductGroup interface
ProductGroup を表すインターフェイス。
メソッド
| check |
識別子で指定された Group エンティティが Product エンティティに関連付けられていることを確認します。 |
| create |
指定された開発者グループと指定された製品の間の関連付けを追加します。 |
| delete(string, string, string, string, Product |
指定されたグループと製品の間の関連付けを削除します。 |
| list |
指定された製品に関連付けられている開発者グループのコレクションを一覧表示します。 |
メソッドの詳細
checkEntityExists(string, string, string, string, ProductGroupCheckEntityExistsOptionalParams)
識別子で指定された Group エンティティが Product エンティティに関連付けられていることを確認します。
function checkEntityExists(resourceGroupName: string, serviceName: string, productId: string, groupId: string, options?: ProductGroupCheckEntityExistsOptionalParams): Promise<ProductGroupCheckEntityExistsResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- productId
-
string
製品識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- groupId
-
string
グループ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
createOrUpdate(string, string, string, string, ProductGroupCreateOrUpdateOptionalParams)
指定された開発者グループと指定された製品の間の関連付けを追加します。
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, groupId: string, options?: ProductGroupCreateOrUpdateOptionalParams): Promise<GroupContract>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- productId
-
string
製品識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- groupId
-
string
グループ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
Promise<GroupContract>
delete(string, string, string, string, ProductGroupDeleteOptionalParams)
指定されたグループと製品の間の関連付けを削除します。
function delete(resourceGroupName: string, serviceName: string, productId: string, groupId: string, options?: ProductGroupDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- productId
-
string
製品識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- groupId
-
string
グループ識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- ProductGroupDeleteOptionalParams
options パラメーター。
戻り値
Promise<void>
listByProduct(string, string, string, ProductGroupListByProductOptionalParams)
指定された製品に関連付けられている開発者グループのコレクションを一覧表示します。
function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: ProductGroupListByProductOptionalParams): PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- productId
-
string
製品識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。