WorkspaceApi interface

Pacchetto:

@azure/arm-apimanagement

Interfaccia che rappresenta un oggetto WorkspaceApi.

Metodi

beginCreateOrUpdate(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)	Crea un'API specificata nuova o aggiornata esistente dell'area di lavoro in un'istanza del servizio Gestione API.
beginCreateOrUpdateAndWait(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)	Crea un'API specificata nuova o aggiornata esistente dell'area di lavoro in un'istanza del servizio Gestione API.
delete(string, string, string, string, string, WorkspaceApiDeleteOptionalParams)	Elimina l'API specificata dell'area di lavoro in un'istanza del servizio Gestione API.
get(string, string, string, string, WorkspaceApiGetOptionalParams)	Ottiene i dettagli dell'API specificata dal relativo identificatore.
getEntityTag(string, string, string, string, WorkspaceApiGetEntityTagOptionalParams)	Ottiene la versione dello stato dell'entità (Etag) dell'API specificata dal relativo identificatore.
listByService(string, string, string, WorkspaceApiListByServiceOptionalParams)	Elenca tutte le API dell'area di lavoro in un'istanza del servizio Gestione API.
update(string, string, string, string, string, ApiUpdateContract, WorkspaceApiUpdateOptionalParams)	Aggiorna l'API specificata dell'area di lavoro in un'istanza del servizio Gestione API.

Dettagli metodo

beginCreateOrUpdate(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)

Crea un'API specificata nuova o aggiornata esistente dell'area di lavoro in un'istanza del servizio Gestione API.

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: WorkspaceApiCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<WorkspaceApiCreateOrUpdateResponse>, WorkspaceApiCreateOrUpdateResponse>>

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.

apiId

string

Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.

parameters

ApiCreateOrUpdateParameter

Creare o aggiornare i parametri.

options

WorkspaceApiCreateOrUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<@azure/core-lro.SimplePollerLike<OperationState<WorkspaceApiCreateOrUpdateResponse>, WorkspaceApiCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait(string, string, string, string, ApiCreateOrUpdateParameter, WorkspaceApiCreateOrUpdateOptionalParams)

Crea un'API specificata nuova o aggiornata esistente dell'area di lavoro in un'istanza del servizio Gestione API.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: WorkspaceApiCreateOrUpdateOptionalParams): Promise<WorkspaceApiCreateOrUpdateResponse>

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.

apiId

string

Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.

parameters

ApiCreateOrUpdateParameter

Creare o aggiornare i parametri.

options

WorkspaceApiCreateOrUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<WorkspaceApiCreateOrUpdateResponse>

delete(string, string, string, string, string, WorkspaceApiDeleteOptionalParams)

Elimina l'API specificata dell'area di lavoro in un'istanza del servizio Gestione API.

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

apiId

string

Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.

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

WorkspaceApiDeleteOptionalParams

Parametri delle opzioni.

Restituisce

Promise<void>

get(string, string, string, string, WorkspaceApiGetOptionalParams)

Ottiene i dettagli dell'API specificata dal relativo identificatore.

function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiGetOptionalParams): Promise<WorkspaceApiGetResponse>

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.

apiId

string

Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.

options

WorkspaceApiGetOptionalParams

Parametri delle opzioni.

Restituisce

Promise<WorkspaceApiGetResponse>

getEntityTag(string, string, string, string, WorkspaceApiGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiGetEntityTagOptionalParams): Promise<WorkspaceApiGetEntityTagHeaders>

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.

apiId

string

Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.

options

WorkspaceApiGetEntityTagOptionalParams

Parametri delle opzioni.

Restituisce

Promise<WorkspaceApiGetEntityTagHeaders>

listByService(string, string, string, WorkspaceApiListByServiceOptionalParams)

Elenca tutte le API dell'area di lavoro in un'istanza del servizio Gestione API.

function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, options?: WorkspaceApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>

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

WorkspaceApiListByServiceOptionalParams

Parametri delle opzioni.

Restituisce

PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>

update(string, string, string, string, string, ApiUpdateContract, WorkspaceApiUpdateOptionalParams)

Aggiorna l'API specificata dell'area di lavoro in un'istanza del servizio Gestione API.

function update(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, ifMatch: string, parameters: ApiUpdateContract, options?: WorkspaceApiUpdateOptionalParams): Promise<WorkspaceApiUpdateResponse>

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.

apiId

string

Identificatore di revisione API. Deve essere univoco nell'istanza corrente del servizio Gestione API. La revisione non corrente ha ; rev=n come suffisso dove n è il numero di revisione.

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

ApiUpdateContract

Parametri del contratto di aggiornamento API.

options

WorkspaceApiUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<WorkspaceApiUpdateResponse>