WorkspaceGroup interface

Csomag:

@azure/arm-apimanagement

A munkaterületcsoportot képviselő felület.

Metódusok

createOrUpdate(string, string, string, string, GroupCreateParameters, WorkspaceGroupCreateOrUpdateOptionalParams)	Csoportot hoz létre vagy frissít.
delete(string, string, string, string, string, WorkspaceGroupDeleteOptionalParams)	Törli a munkaterület adott csoportját egy API Management szolgáltatáspéldányban.
get(string, string, string, string, WorkspaceGroupGetOptionalParams)	Lekéri az azonosító által megadott csoport adatait.
getEntityTag(string, string, string, string, WorkspaceGroupGetEntityTagOptionalParams)	Lekéri az azonosító által megadott csoport entitásállapotának (Etag) verzióját.
listByService(string, string, string, WorkspaceGroupListByServiceOptionalParams)	Egy szolgáltatáspéldány munkaterületén definiált csoportok gyűjteményét sorolja fel.
update(string, string, string, string, string, GroupUpdateParameters, WorkspaceGroupUpdateOptionalParams)	Frissíti az azonosító által megadott csoport adatait.

Metódus adatai

createOrUpdate(string, string, string, string, GroupCreateParameters, WorkspaceGroupCreateOrUpdateOptionalParams)

Csoportot hoz létre vagy frissít.

function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, parameters: GroupCreateParameters, options?: WorkspaceGroupCreateOrUpdateOptionalParams): Promise<WorkspaceGroupCreateOrUpdateResponse>

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.

groupId

string

Csoportazonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

parameters

GroupCreateParameters

Paraméterek létrehozása.

options

WorkspaceGroupCreateOrUpdateOptionalParams

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

Válaszok

Promise<WorkspaceGroupCreateOrUpdateResponse>

delete(string, string, string, string, string, WorkspaceGroupDeleteOptionalParams)

Törli a munkaterület adott csoportját egy API Management szolgáltatáspéldányban.

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

groupId

string

Csoportazonosító. 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

WorkspaceGroupDeleteOptionalParams

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

Válaszok

Promise<void>

get(string, string, string, string, WorkspaceGroupGetOptionalParams)

Lekéri az azonosító által megadott csoport adatait.

function get(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, options?: WorkspaceGroupGetOptionalParams): Promise<WorkspaceGroupGetResponse>

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.

groupId

string

Csoportazonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

options

WorkspaceGroupGetOptionalParams

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

Válaszok

Promise<WorkspaceGroupGetResponse>

getEntityTag(string, string, string, string, WorkspaceGroupGetEntityTagOptionalParams)

Lekéri az azonosító által megadott csoport entitásállapotának (Etag) verzióját.

function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, options?: WorkspaceGroupGetEntityTagOptionalParams): Promise<WorkspaceGroupGetEntityTagHeaders>

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.

groupId

string

Csoportazonosító. Az aktuális API Management szolgáltatáspéldányban egyedinek kell lennie.

options

WorkspaceGroupGetEntityTagOptionalParams

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

Válaszok

Promise<WorkspaceGroupGetEntityTagHeaders>

listByService(string, string, string, WorkspaceGroupListByServiceOptionalParams)

Egy szolgáltatáspéldány munkaterületén definiált csoportok gyűjteményét sorolja fel.

function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceGroupListByServiceOptionalParams): PagedAsyncIterableIterator<GroupContract, GroupContract[], 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.

workspaceId

string

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

options

WorkspaceGroupListByServiceOptionalParams

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

Válaszok

PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>

update(string, string, string, string, string, GroupUpdateParameters, WorkspaceGroupUpdateOptionalParams)

Frissíti az azonosító által megadott csoport adatait.

function update(resourceGroupName: string, serviceName: string, workspaceId: string, groupId: string, ifMatch: string, parameters: GroupUpdateParameters, options?: WorkspaceGroupUpdateOptionalParams): Promise<WorkspaceGroupUpdateResponse>

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.

groupId

string

Csoportazonosító. 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

GroupUpdateParameters

Paraméterek frissítése.

options

WorkspaceGroupUpdateOptionalParams

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

Válaszok

Promise<WorkspaceGroupUpdateResponse>