Workspace interface

Csomag:

@azure/arm-apimanagement

Munkaterületet képviselő felület.

Metódusok

createOrUpdate(string, string, string, WorkspaceContract, WorkspaceCreateOrUpdateOptionalParams)	Új munkaterületet hoz létre, vagy frissít egy meglévőt.
delete(string, string, string, string, WorkspaceDeleteOptionalParams)	Törli a megadott munkaterületet.
get(string, string, string, WorkspaceGetOptionalParams)	Lekéri az azonosító által megadott munkaterület adatait.
getEntityTag(string, string, string, WorkspaceGetEntityTagOptionalParams)	Lekéri a munkaterület entitásállapotának (Etag) verzióját, amelyet az azonosítója határoz meg.
listByService(string, string, WorkspaceListByServiceOptionalParams)	Az API Management szolgáltatáspéldány összes munkaterületét listázza.
update(string, string, string, string, WorkspaceContract, WorkspaceUpdateOptionalParams)	Frissíti az azonosító által megadott munkaterület adatait.

Metódus adatai

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

Új munkaterületet hoz létre, vagy frissít egy meglévőt.

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

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

workspaceId

string

Munkaterület azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

parameters

WorkspaceContract

Paraméterek létrehozása.

options

WorkspaceCreateOrUpdateOptionalParams

A beállítások paraméterei.

Válaszok

Promise<WorkspaceCreateOrUpdateResponse>

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

Törli a megadott munkaterületet.

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

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

workspaceId

string

Munkaterület azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

ifMatch

string

Az entitás ETagje. Az ETag-nek meg kell egyeznie a GET-kérés fejlécválaszából származó aktuális entitásállapotmal, vagy * kell lennie a feltétel nélküli frissítéshez.

options

WorkspaceDeleteOptionalParams

A beállítások paraméterei.

Válaszok

Promise<void>

get(string, string, string, WorkspaceGetOptionalParams)

Lekéri az azonosító által megadott munkaterület adatait.

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

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

workspaceId

string

Munkaterület azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

options

WorkspaceGetOptionalParams

A beállítások paraméterei.

Válaszok

Promise<WorkspaceGetResponse>

getEntityTag(string, string, string, WorkspaceGetEntityTagOptionalParams)

Lekéri a munkaterület entitásállapotának (Etag) verzióját, amelyet az azonosítója határoz meg.

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

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

workspaceId

string

Munkaterület azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

options

WorkspaceGetEntityTagOptionalParams

A beállítások paraméterei.

Válaszok

Promise<WorkspaceGetEntityTagHeaders>

listByService(string, string, WorkspaceListByServiceOptionalParams)

Az API Management szolgáltatáspéldány összes munkaterületét listázza.

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

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

options

WorkspaceListByServiceOptionalParams

A beállítások paraméterei.

Válaszok

PagedAsyncIterableIterator<WorkspaceContract, WorkspaceContract[], PageSettings>

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

Frissíti az azonosító által megadott munkaterület adatait.

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

Paraméterek

resourceGroupName

string

Az erőforráscsoport neve. A név nem megkülönbözteti a kis- és nagybetűket.

serviceName

string

Az API Management szolgáltatás neve.

workspaceId

string

Munkaterület azonosítója. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

ifMatch

string

Az entitás ETagje. Az ETag-nek meg kell egyeznie a GET-kérés fejlécválaszából származó aktuális entitásállapotmal, vagy * kell lennie a feltétel nélküli frissítéshez.

parameters

WorkspaceContract

Munkaterület frissítési paraméterei.

options

WorkspaceUpdateOptionalParams

A beállítások paraméterei.

Válaszok

Promise<WorkspaceUpdateResponse>