Product interface
Product を表すインターフェイス。
メソッド
| create |
製品を作成または更新します。 |
| delete(string, string, string, string, Product |
製品を削除します。 |
| get(string, string, string, Product |
識別子で指定された製品の詳細を取得します。 |
| get |
識別子で指定された製品のエンティティ状態 (Etag) バージョンを取得します。 |
| list |
指定されたサービス インスタンスにおける製品のコレクションを一覧表示します。 |
| list |
タグに関連付けられている製品のコレクションを一覧表示します。 |
| update(string, string, string, string, Product |
既存の製品の詳細を更新します。 |
メソッドの詳細
createOrUpdate(string, string, string, ProductContract, ProductCreateOrUpdateOptionalParams)
製品を作成または更新します。
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, parameters: ProductContract, options?: ProductCreateOrUpdateOptionalParams): Promise<ProductCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- productId
-
string
製品識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- parameters
- ProductContract
パラメーターを作成または更新します。
options パラメーター。
戻り値
Promise<ProductCreateOrUpdateResponse>
delete(string, string, string, string, ProductDeleteOptionalParams)
製品を削除します。
function delete(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, options?: ProductDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- productId
-
string
製品識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- options
- ProductDeleteOptionalParams
options パラメーター。
戻り値
Promise<void>
get(string, string, string, ProductGetOptionalParams)
識別子で指定された製品の詳細を取得します。
function get(resourceGroupName: string, serviceName: string, productId: string, options?: ProductGetOptionalParams): Promise<ProductGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- productId
-
string
製品識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- ProductGetOptionalParams
options パラメーター。
戻り値
Promise<ProductGetResponse>
getEntityTag(string, string, string, ProductGetEntityTagOptionalParams)
識別子で指定された製品のエンティティ状態 (Etag) バージョンを取得します。
function getEntityTag(resourceGroupName: string, serviceName: string, productId: string, options?: ProductGetEntityTagOptionalParams): Promise<ProductGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- productId
-
string
製品識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
Promise<ProductGetEntityTagHeaders>
listByService(string, string, ProductListByServiceOptionalParams)
指定されたサービス インスタンスにおける製品のコレクションを一覧表示します。
function listByService(resourceGroupName: string, serviceName: string, options?: ProductListByServiceOptionalParams): PagedAsyncIterableIterator<ProductContract, ProductContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
options パラメーター。
戻り値
listByTags(string, string, ProductListByTagsOptionalParams)
タグに関連付けられている製品のコレクションを一覧表示します。
function listByTags(resourceGroupName: string, serviceName: string, options?: ProductListByTagsOptionalParams): PagedAsyncIterableIterator<TagResourceContract, TagResourceContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- options
- ProductListByTagsOptionalParams
options パラメーター。
戻り値
update(string, string, string, string, ProductUpdateParameters, ProductUpdateOptionalParams)
既存の製品の詳細を更新します。
function update(resourceGroupName: string, serviceName: string, productId: string, ifMatch: string, parameters: ProductUpdateParameters, options?: ProductUpdateOptionalParams): Promise<ProductUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- productId
-
string
製品識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- parameters
- ProductUpdateParameters
パラメーターを更新します。
- options
- ProductUpdateOptionalParams
options パラメーター。
戻り値
Promise<ProductUpdateResponse>