Group interface

Pacchetto:

@azure/arm-apimanagement

Interfaccia che rappresenta un gruppo.

Metodi

createOrUpdate(string, string, string, GroupCreateParameters, GroupCreateOrUpdateOptionalParams)	Crea o aggiorna 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 dal relativo identificatore.
getEntityTag(string, string, string, GroupGetEntityTagOptionalParams)	Ottiene la versione dello stato dell'entità (Etag) del gruppo specificato dal relativo 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)	Aggiorna i dettagli del gruppo specificato dal relativo identificatore.

Dettagli metodo

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

Crea o aggiorna un gruppo.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

groupId

string

Identificatore di 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. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

groupId

string

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

ifMatch

string

ETag dell'entità. ETag deve corrispondere allo stato corrente dell'entità dalla risposta dell'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 dal relativo identificatore.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

groupId

string

Identificatore di 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 dal relativo identificatore.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

groupId

string

Identificatore di 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. Il nome non fa 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)

Aggiorna i dettagli del gruppo specificato dal relativo 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. Il nome non fa distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

groupId

string

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

ifMatch

string

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

parameters

GroupUpdateParameters

Aggiornare i parametri.

options

GroupUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<GroupUpdateResponse>