Condividi tramite

Group interface

  • Riferimento
Pacchetto:
@azure/arm-apimanagement

Interfaccia che rappresenta un gruppo.

Metodi

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

Crea o Aggiornamenti un gruppo.
delete(string, string, string, string, GroupDeleteOptionalParams)

Elimina un gruppo specifico dell'istanza del servizio Gestione API.
get(string, string, string, GroupGetOptionalParams)

Ottiene i dettagli del gruppo specificato dall'identificatore.
getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)

Ottiene la versione dello stato dell'entità (Etag) del gruppo specificato dall'identificatore.
listByService(string, string, GroupListByServiceOptionalParams)

Elenca una raccolta di gruppi definiti all'interno di un'istanza del servizio.
update(string, string, string, string, GroupUpdateParameters, GroupUpdateOptionalParams)

Aggiornamenti i dettagli del gruppo specificati dall'identificatore.

Dettagli metodo

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

Crea o Aggiornamenti un gruppo.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

groupId

string

Identificatore del gruppo. Deve essere univoco nell'istanza corrente del servizio Gestione API.

parameters
GroupCreateParameters

Creare parametri.

options
GroupCreateOrUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<GroupCreateOrUpdateResponse>

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

Elimina un gruppo specifico dell'istanza del servizio Gestione API.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

groupId

string

Identificatore del gruppo. Deve essere univoco nell'istanza corrente del servizio Gestione API.

ifMatch

string

ETag dell'entità. ETag deve corrispondere allo stato dell'entità corrente dalla risposta di intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.

options
GroupDeleteOptionalParams

Parametri delle opzioni.

Restituisce

Promise<void>

get(string, string, string, GroupGetOptionalParams)

Ottiene i dettagli del gruppo specificato dall'identificatore.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

groupId

string

Identificatore del gruppo. Deve essere univoco nell'istanza corrente del servizio Gestione API.

options
GroupGetOptionalParams

Parametri delle opzioni.

Restituisce

Promise<GroupGetResponse>

getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)

Ottiene la versione dello stato dell'entità (Etag) del gruppo specificato dall'identificatore.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

groupId

string

Identificatore del gruppo. Deve essere univoco nell'istanza corrente del servizio Gestione API.

options
GroupGetEntityTagOptionalParams

Parametri delle opzioni.

Restituisce

Promise<GroupGetEntityTagHeaders>

listByService(string, string, GroupListByServiceOptionalParams)

Elenca una raccolta di gruppi definiti all'interno di un'istanza del servizio.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

options
GroupListByServiceOptionalParams

Parametri delle opzioni.

Restituisce

PagedAsyncIterableIterator<GroupContract, GroupContract[], PageSettings>

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

Aggiornamenti i dettagli del gruppo specificati dall'identificatore.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

groupId

string

Identificatore del gruppo. Deve essere univoco nell'istanza corrente del servizio Gestione API.

ifMatch

string

ETag dell'entità. ETag deve corrispondere allo stato dell'entità corrente dalla risposta di intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.

parameters
GroupUpdateParameters

Aggiornare i parametri.

options
GroupUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<GroupUpdateResponse>