ProductApi interface
ProductApi を表すインターフェイス。
メソッド
| check |
識別子で指定された API エンティティが Product エンティティに関連付けられていることを確認します。 |
| create |
指定された製品に API を追加します。 |
| delete(string, string, string, string, Product |
指定された製品から指定された API を削除します。 |
| list |
製品に関連付けられている API のコレクションを一覧表示します。 |
メソッドの詳細
checkEntityExists(string, string, string, string, ProductApiCheckEntityExistsOptionalParams)
識別子で指定された API エンティティが Product エンティティに関連付けられていることを確認します。
function checkEntityExists(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCheckEntityExistsOptionalParams): Promise<ProductApiCheckEntityExistsResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- productId
-
string
製品識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
options パラメーター。
戻り値
Promise<ProductApiCheckEntityExistsResponse>
createOrUpdate(string, string, string, string, ProductApiCreateOrUpdateOptionalParams)
指定された製品に API を追加します。
function createOrUpdate(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiCreateOrUpdateOptionalParams): Promise<ApiContract>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- productId
-
string
製品識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
options パラメーター。
戻り値
Promise<ApiContract>
delete(string, string, string, string, ProductApiDeleteOptionalParams)
指定された製品から指定された API を削除します。
function delete(resourceGroupName: string, serviceName: string, productId: string, apiId: string, options?: ProductApiDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- productId
-
string
製品識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- options
- ProductApiDeleteOptionalParams
options パラメーター。
戻り値
Promise<void>
listByProduct(string, string, string, ProductApiListByProductOptionalParams)
製品に関連付けられている API のコレクションを一覧表示します。
function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: ProductApiListByProductOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- productId
-
string
製品識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。