Group interface

Csomag:

@azure/arm-apimanagement

Egy csoportot jelképező felület.

Metódusok

createOrUpdate(string, string, string, GroupCreateParameters, GroupCreateOrUpdateOptionalParams)	Csoportot hoz létre vagy frissít.
delete(string, string, string, string, GroupDeleteOptionalParams)	Törli az API Management szolgáltatáspéldány adott csoportját.
get(string, string, string, GroupGetOptionalParams)	Lekéri az azonosító által megadott csoport adatait.
getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)	Lekéri az azonosító által megadott csoport entitásállapotának (Etag) verzióját.
listByService(string, string, GroupListByServiceOptionalParams)	Egy szolgáltatáspéldányon belül definiált csoportok gyűjteményét sorolja fel.
update(string, string, string, string, GroupUpdateParameters, GroupUpdateOptionalParams)	Frissíti az azonosító által megadott csoport adatait.

Metódus adatai

createOrUpdate(string, string, string, GroupCreateParameters, GroupCreateOrUpdateOptionalParams)

Csoportot hoz létre vagy frissít.

function createOrUpdate(resourceGroupName: string, serviceName: string, groupId: string, parameters: GroupCreateParameters, options?: GroupCreateOrUpdateOptionalParams): Promise<GroupCreateOrUpdateResponse>

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.

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

GroupCreateOrUpdateOptionalParams

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

Válaszok

Promise<GroupCreateOrUpdateResponse>

delete(string, string, string, string, GroupDeleteOptionalParams)

Törli az API Management szolgáltatáspéldány adott csoportját.

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

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

GroupDeleteOptionalParams

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

Válaszok

Promise<void>

get(string, string, string, GroupGetOptionalParams)

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

function get(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupGetOptionalParams): Promise<GroupGetResponse>

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.

groupId

string

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

options

GroupGetOptionalParams

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

Válaszok

Promise<GroupGetResponse>

getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, groupId: string, options?: GroupGetEntityTagOptionalParams): Promise<GroupGetEntityTagHeaders>

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.

groupId

string

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

options

GroupGetEntityTagOptionalParams

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

Válaszok

Promise<GroupGetEntityTagHeaders>

listByService(string, string, GroupListByServiceOptionalParams)

Egy szolgáltatáspéldányon belül definiált csoportok gyűjteményét sorolja fel.

function listByService(resourceGroupName: string, serviceName: string, options?: GroupListByServiceOptionalParams): 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.

options

GroupListByServiceOptionalParams

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

Válaszok

PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>

update(string, string, string, string, GroupUpdateParameters, GroupUpdateOptionalParams)

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

function update(resourceGroupName: string, serviceName: string, groupId: string, ifMatch: string, parameters: GroupUpdateParameters, options?: GroupUpdateOptionalParams): Promise<GroupUpdateResponse>

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.

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

GroupUpdateOptionalParams

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

Válaszok

Promise<GroupUpdateResponse>