Workspace interface

Pacchetto:

@azure/arm-apimanagement

Interfaccia che rappresenta un'area di lavoro.

Metodi

createOrUpdate(string, string, string, WorkspaceContract, WorkspaceCreateOrUpdateOptionalParams)	Crea una nuova area di lavoro o ne aggiorna una esistente.
delete(string, string, string, string, WorkspaceDeleteOptionalParams)	Elimina l'area di lavoro specificata.
get(string, string, string, WorkspaceGetOptionalParams)	Ottiene i dettagli dell'area di lavoro specificata dal relativo identificatore.
getEntityTag(string, string, string, WorkspaceGetEntityTagOptionalParams)	Ottiene la versione dello stato dell'entità (Etag) dell'area di lavoro specificata dal relativo identificatore.
listByService(string, string, WorkspaceListByServiceOptionalParams)	Elenca tutte le aree di lavoro dell'istanza del servizio Gestione API.
update(string, string, string, string, WorkspaceContract, WorkspaceUpdateOptionalParams)	Aggiorna i dettagli dell'area di lavoro specificata dal relativo identificatore.

Dettagli metodo

createOrUpdate(string, string, string, WorkspaceContract, WorkspaceCreateOrUpdateOptionalParams)

Crea una nuova area di lavoro o ne aggiorna una esistente.

function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, parameters: WorkspaceContract, options?: WorkspaceCreateOrUpdateOptionalParams): Promise<WorkspaceCreateOrUpdateResponse>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

workspaceId

string

Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio Gestione API.

parameters

WorkspaceContract

Creare parametri.

options

WorkspaceCreateOrUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<WorkspaceCreateOrUpdateResponse>

delete(string, string, string, string, WorkspaceDeleteOptionalParams)

Elimina l'area di lavoro specificata.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

workspaceId

string

Identificatore dell'area di lavoro. 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

WorkspaceDeleteOptionalParams

Parametri delle opzioni.

Restituisce

Promise<void>

get(string, string, string, WorkspaceGetOptionalParams)

Ottiene i dettagli dell'area di lavoro specificata dal relativo identificatore.

function get(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceGetOptionalParams): Promise<WorkspaceGetResponse>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

workspaceId

string

Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio Gestione API.

options

WorkspaceGetOptionalParams

Parametri delle opzioni.

Restituisce

Promise<WorkspaceGetResponse>

getEntityTag(string, string, string, WorkspaceGetEntityTagOptionalParams)

Ottiene la versione dello stato dell'entità (Etag) dell'area di lavoro specificata dal relativo identificatore.

function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceGetEntityTagOptionalParams): Promise<WorkspaceGetEntityTagHeaders>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

workspaceId

string

Identificatore dell'area di lavoro. Deve essere univoco nell'istanza corrente del servizio Gestione API.

options

WorkspaceGetEntityTagOptionalParams

Parametri delle opzioni.

Restituisce

Promise<WorkspaceGetEntityTagHeaders>

listByService(string, string, WorkspaceListByServiceOptionalParams)

Elenca tutte le aree di lavoro dell'istanza del servizio Gestione API.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

options

WorkspaceListByServiceOptionalParams

Parametri delle opzioni.

Restituisce

PagedAsyncIterableIterator<WorkspaceContract, WorkspaceContract[], PageSettings>

update(string, string, string, string, WorkspaceContract, WorkspaceUpdateOptionalParams)

Aggiorna i dettagli dell'area di lavoro specificata dal relativo identificatore.

function update(resourceGroupName: string, serviceName: string, workspaceId: string, ifMatch: string, parameters: WorkspaceContract, options?: WorkspaceUpdateOptionalParams): Promise<WorkspaceUpdateResponse>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Il nome è insensibile alle maiuscole e minuscole.

serviceName

string

Nome del servizio Gestione API.

workspaceId

string

Identificatore dell'area di lavoro. 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

WorkspaceContract

Parametri di aggiornamento dell'area di lavoro.

options

WorkspaceUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<WorkspaceUpdateResponse>