WorkspaceApiRelease interface
Interfaccia che rappresenta un oggetto WorkspaceApiRelease.
Metodi
Dettagli metodo
createOrUpdate(string, string, string, string, string, ApiReleaseContract, WorkspaceApiReleaseCreateOrUpdateOptionalParams)
Crea una nuova versione per l'API.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, releaseId: string, parameters: ApiReleaseContract, options?: WorkspaceApiReleaseCreateOrUpdateOptionalParams): Promise<WorkspaceApiReleaseCreateOrUpdateResponse>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 API. Deve essere univoco nell'istanza corrente del servizio Gestione API.
- releaseId
-
string
Identificatore di versione all'interno di un'API. Deve essere univoco nell'istanza corrente del servizio Gestione API.
- parameters
- ApiReleaseContract
Creare parametri.
Parametri delle opzioni.
Restituisce
delete(string, string, string, string, string, string, WorkspaceApiReleaseDeleteOptionalParams)
Elimina la versione specificata nell'API.
function delete(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, releaseId: string, ifMatch: string, options?: WorkspaceApiReleaseDeleteOptionalParams): 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 API. Deve essere univoco nell'istanza corrente del servizio Gestione API.
- releaseId
-
string
Identificatore di versione 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, WorkspaceApiReleaseGetOptionalParams)
Restituisce i dettagli di una versione dell'API.
function get(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, releaseId: string, options?: WorkspaceApiReleaseGetOptionalParams): Promise<WorkspaceApiReleaseGetResponse>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 API. Deve essere univoco nell'istanza corrente del servizio Gestione API.
- releaseId
-
string
Identificatore di versione all'interno di un'API. Deve essere univoco nell'istanza corrente del servizio Gestione API.
Parametri delle opzioni.
Restituisce
Promise<WorkspaceApiReleaseGetResponse>
getEntityTag(string, string, string, string, string, WorkspaceApiReleaseGetEntityTagOptionalParams)
Restituisce l'etag di una versione api.
function getEntityTag(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, releaseId: string, options?: WorkspaceApiReleaseGetEntityTagOptionalParams): Promise<WorkspaceApiReleaseGetEntityTagHeaders>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 API. Deve essere univoco nell'istanza corrente del servizio Gestione API.
- releaseId
-
string
Identificatore di versione all'interno di un'API. Deve essere univoco nell'istanza corrente del servizio Gestione API.
Parametri delle opzioni.
Restituisce
listByService(string, string, string, string, WorkspaceApiReleaseListByServiceOptionalParams)
Elenca tutte le versioni di un'API. Quando si rende corrente una revisione API, viene creata una versione API. Le versioni vengono usate anche per eseguire il rollback alle revisioni precedenti. I risultati verranno impaginati e possono essere limitati dai parametri $top e $skip.
function listByService(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, options?: WorkspaceApiReleaseListByServiceOptionalParams): PagedAsyncIterableIterator<ApiReleaseContract, ApiReleaseContract[], 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 API. Deve essere univoco nell'istanza corrente del servizio Gestione API.
Parametri delle opzioni.
Restituisce
update(string, string, string, string, string, string, ApiReleaseContract, WorkspaceApiReleaseUpdateOptionalParams)
Aggiorna i dettagli della versione dell'API specificata dal relativo identificatore.
function update(resourceGroupName: string, serviceName: string, workspaceId: string, apiId: string, releaseId: string, ifMatch: string, parameters: ApiReleaseContract, options?: WorkspaceApiReleaseUpdateOptionalParams): Promise<WorkspaceApiReleaseUpdateResponse>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 API. Deve essere univoco nell'istanza corrente del servizio Gestione API.
- releaseId
-
string
Identificatore di versione 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
- ApiReleaseContract
Parametri di Aggiornamento versione API.
Parametri delle opzioni.
Restituisce
Promise<WorkspaceApiReleaseUpdateResponse>