WorkspaceApiRelease interface

Pakiet:

@azure/arm-apimanagement

Interfejs reprezentujący element WorkspaceApiRelease.

Metody

createOrUpdate(string, string, string, string, string, ApiReleaseContract, WorkspaceApiReleaseCreateOrUpdateOptionalParams)	Tworzy nową wersję dla interfejsu API.
delete(string, string, string, string, string, string, WorkspaceApiReleaseDeleteOptionalParams)	Usuwa określoną wersję w interfejsie API.
get(string, string, string, string, string, WorkspaceApiReleaseGetOptionalParams)	Zwraca szczegóły wydania interfejsu API.
getEntityTag(string, string, string, string, string, WorkspaceApiReleaseGetEntityTagOptionalParams)	Zwraca element etag wydania interfejsu API.
listByService(string, string, string, string, WorkspaceApiReleaseListByServiceOptionalParams)	Wyświetla listę wszystkich wydań interfejsu API. Wydanie interfejsu API jest tworzone podczas tworzenia bieżącej poprawki interfejsu API. Wersje są również używane do wycofywania poprzednich poprawek. Wyniki zostaną stronicowane i mogą być ograniczone przez parametry $top i $skip.
update(string, string, string, string, string, string, ApiReleaseContract, WorkspaceApiReleaseUpdateOptionalParams)	Aktualizuje szczegóły wydania interfejsu API określonego przez jego identyfikator.

Szczegóły metody

createOrUpdate(string, string, string, string, string, ApiReleaseContract, WorkspaceApiReleaseCreateOrUpdateOptionalParams)

Tworzy nową wersję dla interfejsu API.

function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, releaseId: string, parameters: ApiReleaseContract, options?: WorkspaceApiReleaseCreateOrUpdateOptionalParams): Promise<WorkspaceApiReleaseCreateOrUpdateResponse>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

workspaceId

string

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

apiId

string

Identyfikator 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

WorkspaceApiReleaseCreateOrUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<WorkspaceApiReleaseCreateOrUpdateResponse>

delete(string, string, string, string, string, string, WorkspaceApiReleaseDeleteOptionalParams)

Usuwa określoną wersję w interfejsie API.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

workspaceId

string

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

apiId

string

Identyfikator 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

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

options

WorkspaceApiReleaseDeleteOptionalParams

Parametry opcji.

Zwraca

Promise<void>

get(string, string, string, string, string, WorkspaceApiReleaseGetOptionalParams)

Zwraca szczegóły wydania interfejsu API.

function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, releaseId: string, options?: WorkspaceApiReleaseGetOptionalParams): Promise<WorkspaceApiReleaseGetResponse>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

workspaceId

string

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

apiId

string

Identyfikator 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

WorkspaceApiReleaseGetOptionalParams

Parametry opcji.

Zwraca

Promise<WorkspaceApiReleaseGetResponse>

getEntityTag(string, string, string, string, string, WorkspaceApiReleaseGetEntityTagOptionalParams)

Zwraca element etag wydania interfejsu API.

function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, releaseId: string, options?: WorkspaceApiReleaseGetEntityTagOptionalParams): Promise<WorkspaceApiReleaseGetEntityTagHeaders>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

workspaceId

string

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

apiId

string

Identyfikator 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

WorkspaceApiReleaseGetEntityTagOptionalParams

Parametry opcji.

Zwraca

Promise<WorkspaceApiReleaseGetEntityTagHeaders>

listByService(string, string, string, string, WorkspaceApiReleaseListByServiceOptionalParams)

Wyświetla listę wszystkich wydań interfejsu API. Wydanie interfejsu API jest tworzone podczas tworzenia bieżącej poprawki interfejsu API. Wersje są również używane do wycofywania poprzednich poprawek. Wyniki zostaną stronicowane i mogą być ograniczone przez parametry $top i $skip.

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

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

workspaceId

string

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

apiId

string

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

options

WorkspaceApiReleaseListByServiceOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<ApiReleaseContract, ApiReleaseContract[], PageSettings>

update(string, string, string, string, string, string, ApiReleaseContract, WorkspaceApiReleaseUpdateOptionalParams)

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

function update(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, releaseId: string, ifMatch: string, parameters: ApiReleaseContract, options?: WorkspaceApiReleaseUpdateOptionalParams): Promise<WorkspaceApiReleaseUpdateResponse>

Parametry

resourceGroupName

string

Nazwa grupy zasobów. Nazwa jest niewrażliwa na wielkość liter.

serviceName

string

Nazwa usługi API Management.

workspaceId

string

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

apiId

string

Identyfikator 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

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

parameters

ApiReleaseContract

Parametry aktualizacji wydania interfejsu API.

options

WorkspaceApiReleaseUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<WorkspaceApiReleaseUpdateResponse>