Api interface

Pacchetto:

@azure/arm-apimanagement

Interfaccia che rappresenta un'API.

Metodi

beginCreateOrUpdate(string, string, string, ApiCreateOrUpdateParameter, ApiCreateOrUpdateOptionalParams)	Crea un'API specificata nuova o aggiornata esistente dell'istanza del servizio Gestione API.
beginCreateOrUpdateAndWait(string, string, string, ApiCreateOrUpdateParameter, ApiCreateOrUpdateOptionalParams)	Crea un'API specificata nuova o aggiornata esistente dell'istanza del servizio Gestione API.
beginDelete(string, string, string, string, ApiDeleteOptionalParams)	Elimina l'API specificata dell'istanza del servizio Gestione API.
beginDeleteAndWait(string, string, string, string, ApiDeleteOptionalParams)	Elimina l'API specificata dell'istanza del servizio Gestione API.
get(string, string, string, ApiGetOptionalParams)	Ottiene i dettagli dell'API specificata dal relativo identificatore.
getEntityTag(string, string, string, ApiGetEntityTagOptionalParams)	Ottiene la versione dello stato dell'entità (Etag) dell'API specificata dal relativo identificatore.
listByService(string, string, ApiListByServiceOptionalParams)	Elenca tutte le API dell'istanza del servizio Gestione API.
listByTags(string, string, ApiListByTagsOptionalParams)	Elenca una raccolta di API associate ai tag.
update(string, string, string, string, ApiUpdateContract, ApiUpdateOptionalParams)	Aggiorna l'API specificata dell'istanza del servizio Gestione API.

Dettagli metodo

beginCreateOrUpdate(string, string, string, ApiCreateOrUpdateParameter, ApiCreateOrUpdateOptionalParams)

Crea un'API specificata nuova o aggiornata esistente dell'istanza del servizio Gestione API.

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: ApiCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiCreateOrUpdateResponse>, ApiCreateOrUpdateResponse>>

Parametri

resourceGroupName

string

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

serviceName

string

Nome 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

ApiCreateOrUpdateOptionalParams

Parametri delle opzioni.

Restituisce

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

beginCreateOrUpdateAndWait(string, string, string, ApiCreateOrUpdateParameter, ApiCreateOrUpdateOptionalParams)

Crea un'API specificata nuova o aggiornata esistente dell'istanza del servizio Gestione API.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: ApiCreateOrUpdateOptionalParams): Promise<ApiCreateOrUpdateResponse>

Parametri

resourceGroupName

string

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

serviceName

string

Nome 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

ApiCreateOrUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiCreateOrUpdateResponse>

beginDelete(string, string, string, string, ApiDeleteOptionalParams)

Elimina l'API specificata dell'istanza del servizio Gestione API.

function beginDelete(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, options?: ApiDeleteOptionalParams): Promise<SimplePollerLike<OperationState<ApiDeleteHeaders>, ApiDeleteHeaders>>

Parametri

resourceGroupName

string

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

serviceName

string

Nome 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

ApiDeleteOptionalParams

Parametri delle opzioni.

Restituisce

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

beginDeleteAndWait(string, string, string, string, ApiDeleteOptionalParams)

Elimina l'API specificata dell'istanza del servizio Gestione API.

function beginDeleteAndWait(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, options?: ApiDeleteOptionalParams): Promise<ApiDeleteHeaders>

Parametri

resourceGroupName

string

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

serviceName

string

Nome 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

ApiDeleteOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiDeleteHeaders>

get(string, string, string, ApiGetOptionalParams)

Ottiene i dettagli dell'API specificata dal relativo identificatore.

function get(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiGetOptionalParams): Promise<ApiGetResponse>

Parametri

resourceGroupName

string

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

serviceName

string

Nome 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

ApiGetOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiGetResponse>

getEntityTag(string, string, string, ApiGetEntityTagOptionalParams)

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

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiGetEntityTagOptionalParams): Promise<ApiGetEntityTagHeaders>

Parametri

resourceGroupName

string

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

serviceName

string

Nome 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

ApiGetEntityTagOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiGetEntityTagHeaders>

listByService(string, string, ApiListByServiceOptionalParams)

Elenca tutte le API dell'istanza del servizio Gestione API.

function listByService(resourceGroupName: string, serviceName: string, options?: ApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], 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

ApiListByServiceOptionalParams

Parametri delle opzioni.

Restituisce

PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>

listByTags(string, string, ApiListByTagsOptionalParams)

Elenca una raccolta di API associate ai tag.

function listByTags(resourceGroupName: string, serviceName: string, options?: ApiListByTagsOptionalParams): PagedAsyncIterableIterator<TagResourceContract, TagResourceContract[], 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

ApiListByTagsOptionalParams

Parametri delle opzioni.

Restituisce

PagedAsyncIterableIterator<TagResourceContract, TagResourceContract[], PageSettings>

update(string, string, string, string, ApiUpdateContract, ApiUpdateOptionalParams)

Aggiorna l'API specificata dell'istanza del servizio Gestione API.

function update(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, parameters: ApiUpdateContract, options?: ApiUpdateOptionalParams): Promise<ApiUpdateResponse>

Parametri

resourceGroupName

string

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

serviceName

string

Nome 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

ApiUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<ApiUpdateResponse>