Workspace interface

Pakiet:

@azure/arm-apimanagement

Interfejs reprezentujący obszar roboczy.

Metody

createOrUpdate(string, string, string, WorkspaceContract, WorkspaceCreateOrUpdateOptionalParams)	Tworzy nowy obszar roboczy lub aktualizuje istniejący.
delete(string, string, string, string, WorkspaceDeleteOptionalParams)	Usuwa określony obszar roboczy.
get(string, string, string, WorkspaceGetOptionalParams)	Pobiera szczegóły obszaru roboczego określonego przez jego identyfikator.
getEntityTag(string, string, string, WorkspaceGetEntityTagOptionalParams)	Pobiera wersję stanu jednostki (Etag) obszaru roboczego określonego przez jego identyfikator.
listByService(string, string, WorkspaceListByServiceOptionalParams)	Wyświetla listę wszystkich obszarów roboczych wystąpienia usługi API Management.
update(string, string, string, string, WorkspaceContract, WorkspaceUpdateOptionalParams)	Aktualizuje szczegóły obszaru roboczego określonego przez jego identyfikator.

Szczegóły metody

createOrUpdate(string, string, string, WorkspaceContract, WorkspaceCreateOrUpdateOptionalParams)

Tworzy nowy obszar roboczy lub aktualizuje istniejący.

function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, parameters: WorkspaceContract, options?: WorkspaceCreateOrUpdateOptionalParams): Promise<WorkspaceCreateOrUpdateResponse>

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.

parameters

WorkspaceContract

Utwórz parametry.

options

WorkspaceCreateOrUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<WorkspaceCreateOrUpdateResponse>

delete(string, string, string, string, WorkspaceDeleteOptionalParams)

Usuwa określony obszar roboczy.

function delete(resourceGroupName: string, serviceName: string, workspaceId: string, ifMatch: string, options?: WorkspaceDeleteOptionalParams): 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.

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

WorkspaceDeleteOptionalParams

Parametry opcji.

Zwraca

Promise<void>

get(string, string, string, WorkspaceGetOptionalParams)

Pobiera szczegóły obszaru roboczego określonego przez jego identyfikator.

function get(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceGetOptionalParams): Promise<WorkspaceGetResponse>

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.

options

WorkspaceGetOptionalParams

Parametry opcji.

Zwraca

Promise<WorkspaceGetResponse>

getEntityTag(string, string, string, WorkspaceGetEntityTagOptionalParams)

Pobiera wersję stanu jednostki (Etag) obszaru roboczego określonego przez jego identyfikator.

function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceGetEntityTagOptionalParams): Promise<WorkspaceGetEntityTagHeaders>

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.

options

WorkspaceGetEntityTagOptionalParams

Parametry opcji.

Zwraca

Promise<WorkspaceGetEntityTagHeaders>

listByService(string, string, WorkspaceListByServiceOptionalParams)

Wyświetla listę wszystkich obszarów roboczych wystąpienia usługi API Management.

function listByService(resourceGroupName: string, serviceName: string, options?: WorkspaceListByServiceOptionalParams): PagedAsyncIterableIterator<WorkspaceContract, WorkspaceContract[], PageSettings>

Parametry

resourceGroupName

string

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

serviceName

string

Nazwa usługi API Management.

options

WorkspaceListByServiceOptionalParams

Parametry opcji.

Zwraca

PagedAsyncIterableIterator<WorkspaceContract, WorkspaceContract[], PageSettings>

update(string, string, string, string, WorkspaceContract, WorkspaceUpdateOptionalParams)

Aktualizuje szczegóły obszaru roboczego określonego przez jego identyfikator.

function update(resourceGroupName: string, serviceName: string, workspaceId: string, ifMatch: string, parameters: WorkspaceContract, options?: WorkspaceUpdateOptionalParams): Promise<WorkspaceUpdateResponse>

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.

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

WorkspaceContract

Parametry aktualizacji przestrzeni roboczej.

options

WorkspaceUpdateOptionalParams

Parametry opcji.

Zwraca

Promise<WorkspaceUpdateResponse>