Sdílet prostřednictvím

Group interface

  • Reference
Balíček:
@azure/arm-apimanagement

Rozhraní představující skupinu.

Metody

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

Vytvoří nebo Aktualizace skupinu.
delete(string, string, string, string, GroupDeleteOptionalParams)

Odstraní konkrétní skupinu instance služby Gestione API.
get(string, string, string, GroupGetOptionalParams)

Získá podrobnosti skupiny určené jeho identifikátor.
getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)

Získá stav entity (Etag) verze skupiny určené jeho identifikátorem.
listByService(string, string, GroupListByServiceOptionalParams)

Vypíše kolekci skupin definovaných v rámci instance služby.
update(string, string, string, string, GroupUpdateParameters, GroupUpdateOptionalParams)

Aktualizace podrobnosti o skupině určené jejím identifikátorem.

Podrobnosti metody

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

Vytvoří nebo Aktualizace skupinu.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

groupId

string

Identifikátor skupiny. V aktuální instanci služby Gestione API musí být jedinečná.

parameters
GroupCreateParameters

Vytvořte parametry.

options
GroupCreateOrUpdateOptionalParams

Parametry možností

Návraty

Promise<GroupCreateOrUpdateResponse>

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

Odstraní konkrétní skupinu instance služby Gestione API.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

groupId

string

Identifikátor skupiny. V aktuální instanci služby Gestione API musí být jedinečná.

ifMatch

string

Značka ETag entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET nebo by měla být * pro bezpodmínečnou aktualizaci.

options
GroupDeleteOptionalParams

Parametry možností

Návraty

Promise<void>

get(string, string, string, GroupGetOptionalParams)

Získá podrobnosti skupiny určené jeho identifikátor.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

groupId

string

Identifikátor skupiny. V aktuální instanci služby Gestione API musí být jedinečná.

options
GroupGetOptionalParams

Parametry možností

Návraty

Promise<GroupGetResponse>

getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)

Získá stav entity (Etag) verze skupiny určené jeho identifikátorem.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

groupId

string

Identifikátor skupiny. V aktuální instanci služby Gestione API musí být jedinečná.

options
GroupGetEntityTagOptionalParams

Parametry možností

Návraty

Promise<GroupGetEntityTagHeaders>

listByService(string, string, GroupListByServiceOptionalParams)

Vypíše kolekci skupin definovaných v rámci instance služby.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

options
GroupListByServiceOptionalParams

Parametry možností

Návraty

PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>

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

Aktualizace podrobnosti o skupině určené jejím identifikátorem.

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

Parametry

resourceGroupName

string

Název skupiny prostředků. V názvu se rozlišují malá a velká písmena.

serviceName

string

Název služby Gestione API.

groupId

string

Identifikátor skupiny. V aktuální instanci služby Gestione API musí být jedinečná.

ifMatch

string

Značka ETag entity. Značka ETag by měla odpovídat aktuálnímu stavu entity z odpovědi hlavičky požadavku GET nebo by měla být * pro bezpodmínečnou aktualizaci.

parameters
GroupUpdateParameters

Aktualizujte parametry.

options
GroupUpdateOptionalParams

Parametry možností

Návraty

Promise<GroupUpdateResponse>