Apis interface
Api を表すインターフェイス。
メソッド
| create |
新しい API を作成するか、既存の API を更新します。 |
| delete(string, string, string, string, Apis |
指定した API を削除します。 |
| get(string, string, string, string, Apis |
API の詳細を返します。 |
| head(string, string, string, string, Apis |
指定した API が存在するかどうかを確認します。 |
| list(string, string, string, Apis |
API のコレクションを返します。 |
メソッドの詳細
createOrUpdate(string, string, string, string, Api, ApisCreateOrUpdateOptionalParams)
新しい API を作成するか、既存の API を更新します。
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, resource: Api, options?: ApisCreateOrUpdateOptionalParams): Promise<ApisCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
Azure API Center サービスの名前。
- workspaceName
-
string
ワークスペースの名前。
- apiName
-
string
API の名前。
- resource
- Api
リソース作成パラメーター。
- options
- ApisCreateOrUpdateOptionalParams
options パラメーター。
戻り値
Promise<ApisCreateOrUpdateResponse>
delete(string, string, string, string, ApisDeleteOptionalParams)
指定した API を削除します。
function delete(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, options?: ApisDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
Azure API Center サービスの名前。
- workspaceName
-
string
ワークスペースの名前。
- apiName
-
string
API の名前。
- options
- ApisDeleteOptionalParams
options パラメーター。
戻り値
Promise<void>
get(string, string, string, string, ApisGetOptionalParams)
API の詳細を返します。
function get(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, options?: ApisGetOptionalParams): Promise<ApisGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
Azure API Center サービスの名前。
- workspaceName
-
string
ワークスペースの名前。
- apiName
-
string
API の名前。
- options
- ApisGetOptionalParams
options パラメーター。
戻り値
Promise<ApisGetResponse>
head(string, string, string, string, ApisHeadOptionalParams)
指定した API が存在するかどうかを確認します。
function head(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, options?: ApisHeadOptionalParams): Promise<ApisHeadResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
Azure API Center サービスの名前。
- workspaceName
-
string
ワークスペースの名前。
- apiName
-
string
API の名前。
- options
- ApisHeadOptionalParams
options パラメーター。
戻り値
Promise<ApisHeadResponse>
list(string, string, string, ApisListOptionalParams)
API のコレクションを返します。
function list(resourceGroupName: string, serviceName: string, workspaceName: string, options?: ApisListOptionalParams): PagedAsyncIterableIterator<Api, Api[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
Azure API Center サービスの名前。
- workspaceName
-
string
ワークスペースの名前。
- options
- ApisListOptionalParams
options パラメーター。