Api interface
Api を表すインターフェイス。
メソッド
| begin |
API Management サービス インスタンスの新しい API を作成するか、既存の指定された API を更新します。 |
| begin |
API Management サービス インスタンスの新しい API を作成するか、既存の指定された API を更新します。 |
| delete(string, string, string, string, Api |
API Management サービス インスタンスの指定された API を削除します。 |
| get(string, string, string, Api |
識別子で指定された API の詳細を取得します。 |
| get |
識別子で指定された API のエンティティ状態 (Etag) バージョンを取得します。 |
| list |
API Management サービス インスタンスのすべての API を一覧表示します。 |
| list |
タグに関連付けられている API のコレクションを一覧表示します。 |
| update(string, string, string, string, Api |
API Management サービス インスタンスの指定した API を更新します。 |
メソッドの詳細
beginCreateOrUpdate(string, string, string, ApiCreateOrUpdateParameter, ApiCreateOrUpdateOptionalParams)
API Management サービス インスタンスの新しい API を作成するか、既存の指定された API を更新します。
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: ApiCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiCreateOrUpdateResponse>, ApiCreateOrUpdateResponse>>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- parameters
- ApiCreateOrUpdateParameter
パラメーターを作成または更新します。
- options
- ApiCreateOrUpdateOptionalParams
options パラメーター。
戻り値
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiCreateOrUpdateResponse>, ApiCreateOrUpdateResponse>>
beginCreateOrUpdateAndWait(string, string, string, ApiCreateOrUpdateParameter, ApiCreateOrUpdateOptionalParams)
API Management サービス インスタンスの新しい API を作成するか、既存の指定された API を更新します。
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: ApiCreateOrUpdateOptionalParams): Promise<ApiCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- parameters
- ApiCreateOrUpdateParameter
パラメーターを作成または更新します。
- options
- ApiCreateOrUpdateOptionalParams
options パラメーター。
戻り値
Promise<ApiCreateOrUpdateResponse>
delete(string, string, string, string, ApiDeleteOptionalParams)
API Management サービス インスタンスの指定された API を削除します。
function delete(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, options?: ApiDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- options
- ApiDeleteOptionalParams
options パラメーター。
戻り値
Promise<void>
get(string, string, string, ApiGetOptionalParams)
識別子で指定された API の詳細を取得します。
function get(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiGetOptionalParams): Promise<ApiGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- options
- ApiGetOptionalParams
options パラメーター。
戻り値
Promise<ApiGetResponse>
getEntityTag(string, string, string, ApiGetEntityTagOptionalParams)
識別子で指定された API のエンティティ状態 (Etag) バージョンを取得します。
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiGetEntityTagOptionalParams): Promise<ApiGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- options
- ApiGetEntityTagOptionalParams
options パラメーター。
戻り値
Promise<ApiGetEntityTagHeaders>
listByService(string, string, ApiListByServiceOptionalParams)
API Management サービス インスタンスのすべての API を一覧表示します。
function listByService(resourceGroupName: string, serviceName: string, options?: ApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- options
- ApiListByServiceOptionalParams
options パラメーター。
戻り値
listByTags(string, string, ApiListByTagsOptionalParams)
タグに関連付けられている API のコレクションを一覧表示します。
function listByTags(resourceGroupName: string, serviceName: string, options?: ApiListByTagsOptionalParams): PagedAsyncIterableIterator<TagResourceContract, TagResourceContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- options
- ApiListByTagsOptionalParams
options パラメーター。
戻り値
update(string, string, string, string, ApiUpdateContract, ApiUpdateOptionalParams)
API Management サービス インスタンスの指定した API を更新します。
function update(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, parameters: ApiUpdateContract, options?: ApiUpdateOptionalParams): Promise<ApiUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API リビジョン識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。 現在のリビジョン以外のリビジョンには、サフィックスとして ;rev=n があり、n はリビジョン番号です。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- parameters
- ApiUpdateContract
API Update Contract パラメーター。
- options
- ApiUpdateOptionalParams
options パラメーター。
戻り値
Promise<ApiUpdateResponse>