WorkspaceApiOperation interface
Interfaccia che rappresenta un oggetto WorkspaceApiOperation.
Metodi
Dettagli metodo
createOrUpdate(string, string, string, string, string, OperationContract, WorkspaceApiOperationCreateOrUpdateOptionalParams)
Crea una nuova operazione nell'API o ne aggiorna una esistente.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, parameters: OperationContract, options?: WorkspaceApiOperationCreateOrUpdateOptionalParams): Promise<WorkspaceApiOperationCreateOrUpdateResponse>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.
- operationId
-
string
Identificatore dell'operazione all'interno di un'API. Deve essere univoco nell'istanza corrente del servizio Gestione API.
- parameters
- OperationContract
Creare parametri.
Parametri delle opzioni.
Restituisce
delete(string, string, string, string, string, string, WorkspaceApiOperationDeleteOptionalParams)
Elimina l'operazione specificata nell'API.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, ifMatch: string, options?: WorkspaceApiOperationDeleteOptionalParams): 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.
- operationId
-
string
Identificatore dell'operazione all'interno di un'API. 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.
Parametri delle opzioni.
Restituisce
Promise<void>
get(string, string, string, string, string, WorkspaceApiOperationGetOptionalParams)
Ottiene i dettagli dell'operazione API specificata dal relativo identificatore.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, options?: WorkspaceApiOperationGetOptionalParams): Promise<WorkspaceApiOperationGetResponse>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.
- operationId
-
string
Identificatore dell'operazione all'interno di un'API. Deve essere univoco nell'istanza corrente del servizio Gestione API.
Parametri delle opzioni.
Restituisce
Promise<WorkspaceApiOperationGetResponse>
getEntityTag(string, string, string, string, string, WorkspaceApiOperationGetEntityTagOptionalParams)
Ottiene la versione dello stato dell'entità (Etag) dell'operazione API specificata dal relativo identificatore.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, options?: WorkspaceApiOperationGetEntityTagOptionalParams): Promise<WorkspaceApiOperationGetEntityTagHeaders>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.
- operationId
-
string
Identificatore dell'operazione all'interno di un'API. Deve essere univoco nell'istanza corrente del servizio Gestione API.
Parametri delle opzioni.
Restituisce
listByApi(string, string, string, string, WorkspaceApiOperationListByApiOptionalParams)
Elenca una raccolta di operazioni per l'API specificata.
function listByApi(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiOperationListByApiOptionalParams): PagedAsyncIterableIterator<OperationContract, OperationContract[], 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.
- 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.
Parametri delle opzioni.
Restituisce
update(string, string, string, string, string, string, OperationUpdateContract, WorkspaceApiOperationUpdateOptionalParams)
Aggiorna i dettagli dell'operazione nell'API specificata dal relativo identificatore.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, operationId: string, ifMatch: string, parameters: OperationUpdateContract, options?: WorkspaceApiOperationUpdateOptionalParams): Promise<WorkspaceApiOperationUpdateResponse>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.
- operationId
-
string
Identificatore dell'operazione all'interno di un'API. 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
- OperationUpdateContract
Parametri di aggiornamento dell'operazione API.
Parametri delle opzioni.
Restituisce
Promise<WorkspaceApiOperationUpdateResponse>