ApiRelease interface
ApiRelease を表すインターフェイス。
メソッド
| create |
API の新しいリリースを作成します。 |
| delete(string, string, string, string, string, Api |
API で指定されたリリースを削除します。 |
| get(string, string, string, string, Api |
API リリースの詳細を返します。 |
| get |
API リリースの etag を返します。 |
| list |
API のすべてのリリースを一覧表示します。 API リリースは、API リビジョンを最新にしたときに作成されます。 リリースは、以前のリビジョンにロールバックするためにも使用されます。 結果はページングされ、$top および $skip パラメーターによって制限することができます。 |
| update(string, string, string, string, string, Api |
識別子で指定された API のリリースの詳細を更新します。 |
メソッドの詳細
createOrUpdate(string, string, string, string, ApiReleaseContract, ApiReleaseCreateOrUpdateOptionalParams)
API の新しいリリースを作成します。
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, parameters: ApiReleaseContract, options?: ApiReleaseCreateOrUpdateOptionalParams): Promise<ApiReleaseCreateOrUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- releaseId
-
string
API 内のリリース識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- parameters
- ApiReleaseContract
パラメーターを作成します。
options パラメーター。
戻り値
Promise<ApiReleaseCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiReleaseDeleteOptionalParams)
API で指定されたリリースを削除します。
function delete(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, ifMatch: string, options?: ApiReleaseDeleteOptionalParams): Promise<void>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- releaseId
-
string
API 内のリリース識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- options
- ApiReleaseDeleteOptionalParams
options パラメーター。
戻り値
Promise<void>
get(string, string, string, string, ApiReleaseGetOptionalParams)
API リリースの詳細を返します。
function get(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetOptionalParams): Promise<ApiReleaseGetResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- releaseId
-
string
API 内のリリース識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- options
- ApiReleaseGetOptionalParams
options パラメーター。
戻り値
Promise<ApiReleaseGetResponse>
getEntityTag(string, string, string, string, ApiReleaseGetEntityTagOptionalParams)
API リリースの etag を返します。
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetEntityTagOptionalParams): Promise<ApiReleaseGetEntityTagHeaders>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- releaseId
-
string
API 内のリリース識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
Promise<ApiReleaseGetEntityTagHeaders>
listByService(string, string, string, ApiReleaseListByServiceOptionalParams)
API のすべてのリリースを一覧表示します。 API リリースは、API リビジョンを最新にしたときに作成されます。 リリースは、以前のリビジョンにロールバックするためにも使用されます。 結果はページングされ、$top および $skip パラメーターによって制限することができます。
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiReleaseListByServiceOptionalParams): PagedAsyncIterableIterator<ApiReleaseContract, ApiReleaseContract[], PageSettings>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
options パラメーター。
戻り値
update(string, string, string, string, string, ApiReleaseContract, ApiReleaseUpdateOptionalParams)
識別子で指定された API のリリースの詳細を更新します。
function update(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, ifMatch: string, parameters: ApiReleaseContract, options?: ApiReleaseUpdateOptionalParams): Promise<ApiReleaseUpdateResponse>パラメーター
- resourceGroupName
-
string
リソース グループの名前。 名前の大文字と小文字は区別されます。
- serviceName
-
string
API Management サービスの名前。
- apiId
-
string
API 識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- releaseId
-
string
API 内のリリース識別子。 現在のAPI Management サービス インスタンスで一意である必要があります。
- ifMatch
-
string
エンティティの ETag。 ETag は、GET 要求のヘッダー応答からの現在のエンティティ状態と一致する必要があります。または、無条件更新の場合は * にする必要があります。
- parameters
- ApiReleaseContract
API リリースの更新パラメーター。
- options
- ApiReleaseUpdateOptionalParams
options パラメーター。
戻り値
Promise<ApiReleaseUpdateResponse>