ApiRelease interface

Pakiet:

@azure/arm-apimanagement

Interfejs reprezentujący wersję interfejsu APIRelease.

Metody

createOrUpdate(string, string, string, string, ApiReleaseContract, ApiReleaseCreateOrUpdateOptionalParams)	Tworzy nową wersję interfejsu API.
delete(string, string, string, string, string, ApiReleaseDeleteOptionalParams)	Usuwa określoną wersję w interfejsie API.
get(string, string, string, string, ApiReleaseGetOptionalParams)	Zwraca szczegóły wydania interfejsu API.
getEntityTag(string, string, string, string, ApiReleaseGetEntityTagOptionalParams)	Zwraca element etag wydania interfejsu API.
listByService(string, string, string, ApiReleaseListByServiceOptionalParams)	Wyświetla listę wszystkich wersji interfejsu API. Wersja interfejsu API jest tworzona podczas tworzenia bieżącej wersji interfejsu API. Wydania są również używane do wycofywania do poprzednich poprawek. Wyniki będą stronicowane i mogą być ograniczone przez parametry $top i $skip.
update(string, string, string, string, string, ApiReleaseContract, ApiReleaseUpdateOptionalParams)	Aktualizacje szczegóły wydania interfejsu API określonego przez jego identyfikator.

Szczegóły metody

createOrUpdate(string, string, string, string, ApiReleaseContract, ApiReleaseCreateOrUpdateOptionalParams)

Tworzy nową wersję interfejsu API.

function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, parameters: ApiReleaseContract, options?: ApiReleaseCreateOrUpdateOptionalParams): Promise<ApiReleaseCreateOrUpdateResponse>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

apiId

string

Identyfikator interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

releaseId

string

Identyfikator wydania w interfejsie API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

parameters

ApiReleaseContract

Utwórz parametry.

options

ApiReleaseCreateOrUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<ApiReleaseCreateOrUpdateResponse>

delete(string, string, string, string, string, ApiReleaseDeleteOptionalParams)

Usuwa określoną wersję w interfejsie API.

function delete(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, ifMatch: string, options?: ApiReleaseDeleteOptionalParams): Promise<void>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

apiId

string

Identyfikator interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

releaseId

string

Identyfikator wydania w interfejsie API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

ifMatch

string

ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * w przypadku aktualizacji bezwarunkowej.

options

ApiReleaseDeleteOptionalParams

Parametry opcji.

Zwraca

Promise<void>

get(string, string, string, string, ApiReleaseGetOptionalParams)

Zwraca szczegóły wydania interfejsu API.

function get(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetOptionalParams): Promise<ApiReleaseGetResponse>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

apiId

string

Identyfikator interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

releaseId

string

Identyfikator wydania w interfejsie API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

options

ApiReleaseGetOptionalParams

Parametry opcji.

Zwraca

Promise<ApiReleaseGetResponse>

getEntityTag(string, string, string, string, ApiReleaseGetEntityTagOptionalParams)

Zwraca element etag wydania interfejsu API.

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetEntityTagOptionalParams): Promise<ApiReleaseGetEntityTagHeaders>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

apiId

string

Identyfikator interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

releaseId

string

Identyfikator wydania w interfejsie API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

options

ApiReleaseGetEntityTagOptionalParams

Parametry opcji.

Zwraca

Promise<ApiReleaseGetEntityTagHeaders>

listByService(string, string, string, ApiReleaseListByServiceOptionalParams)

Wyświetla listę wszystkich wersji interfejsu API. Wersja interfejsu API jest tworzona podczas tworzenia bieżącej wersji interfejsu API. Wydania są również używane do wycofywania do poprzednich poprawek. Wyniki będą stronicowane i mogą być ograniczone przez parametry $top i $skip.

function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiReleaseListByServiceOptionalParams): PagedAsyncIterableIterator<ApiReleaseContract, ApiReleaseContract[], PageSettings>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

apiId

string

Identyfikator interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

options

ApiReleaseListByServiceOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<ApiReleaseContract, ApiReleaseContract[], PageSettings>

update(string, string, string, string, string, ApiReleaseContract, ApiReleaseUpdateOptionalParams)

Aktualizacje szczegóły wydania interfejsu API określonego przez jego identyfikator.

function update(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, ifMatch: string, parameters: ApiReleaseContract, options?: ApiReleaseUpdateOptionalParams): Promise<ApiReleaseUpdateResponse>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. W nazwie jest uwzględniana wielkość liter.

serviceName

string

Nazwa usługi API Management.

apiId

string

Identyfikator interfejsu API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

releaseId

string

Identyfikator wydania w interfejsie API. Musi być unikatowa w bieżącym wystąpieniu usługi API Management.

ifMatch

string

ETag jednostki. Element ETag powinien być zgodny z bieżącym stanem jednostki z odpowiedzi nagłówka żądania GET lub powinien być * w przypadku aktualizacji bezwarunkowej.

parameters

ApiReleaseContract

Parametry aktualizacji wydania interfejsu API.

options

ApiReleaseUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<ApiReleaseUpdateResponse>