Tag interface

Pacchetto:

@azure/arm-apimanagement

Interfaccia che rappresenta un tag.

Metodi

assignToApi(string, string, string, string, TagAssignToApiOptionalParams)	Assegnare il tag all'API.
assignToOperation(string, string, string, string, string, TagAssignToOperationOptionalParams)	Assegnare il tag all'operazione.
assignToProduct(string, string, string, string, TagAssignToProductOptionalParams)	Assegnare il tag al prodotto.
createOrUpdate(string, string, string, TagCreateUpdateParameters, TagCreateOrUpdateOptionalParams)	Crea un tag.
delete(string, string, string, string, TagDeleteOptionalParams)	Elimina un tag specifico dell'istanza del servizio Gestione API.
detachFromApi(string, string, string, string, TagDetachFromApiOptionalParams)	Scollegare il tag dall'API.
detachFromOperation(string, string, string, string, string, TagDetachFromOperationOptionalParams)	Scollegare il tag dall'operazione.
detachFromProduct(string, string, string, string, TagDetachFromProductOptionalParams)	Scollegare il tag dal prodotto.
get(string, string, string, TagGetOptionalParams)	Ottiene i dettagli del tag specificato dal relativo identificatore.
getByApi(string, string, string, string, TagGetByApiOptionalParams)	Ottenere il tag associato all'API.
getByOperation(string, string, string, string, string, TagGetByOperationOptionalParams)	Ottiene il tag associato all'operazione.
getByProduct(string, string, string, string, TagGetByProductOptionalParams)	Ottiene il tag associato al prodotto.
getEntityState(string, string, string, TagGetEntityStateOptionalParams)	Ottiene la versione dello stato dell'entità del tag specificato dal relativo identificatore.
getEntityStateByApi(string, string, string, string, TagGetEntityStateByApiOptionalParams)	Ottiene la versione dello stato dell'entità del tag specificato dal relativo identificatore.
getEntityStateByOperation(string, string, string, string, string, TagGetEntityStateByOperationOptionalParams)	Ottiene la versione dello stato dell'entità del tag specificato dal relativo identificatore.
getEntityStateByProduct(string, string, string, string, TagGetEntityStateByProductOptionalParams)	Ottiene la versione dello stato dell'entità del tag specificato dal relativo identificatore.
listByApi(string, string, string, TagListByApiOptionalParams)	Elenca tutti i tag associati all'API.
listByOperation(string, string, string, string, TagListByOperationOptionalParams)	Elenca tutti i tag associati all'operazione.
listByProduct(string, string, string, TagListByProductOptionalParams)	Elenca tutti i tag associati al prodotto.
listByService(string, string, TagListByServiceOptionalParams)	Elenca una raccolta di tag definiti all'interno di un'istanza del servizio.
update(string, string, string, string, TagCreateUpdateParameters, TagUpdateOptionalParams)	Aggiornamenti i dettagli del tag specificato dal relativo identificatore.

Dettagli metodo

assignToApi(string, string, string, string, TagAssignToApiOptionalParams)

Assegnare il tag all'API.

function assignToApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagAssignToApiOptionalParams): Promise<TagAssignToApiResponse>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

apiId

string

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

tagId

string

Identificatore di tag. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

options

TagAssignToApiOptionalParams

Parametri delle opzioni.

Restituisce

Promise<TagAssignToApiResponse>

assignToOperation(string, string, string, string, string, TagAssignToOperationOptionalParams)

Assegnare il tag all'operazione.

function assignToOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagAssignToOperationOptionalParams): Promise<TagContract>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

apiId

string

Identificatore di revisione DELL'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API. La revisione non corrente include ;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 di Gestione API.

tagId

string

Identificatore di tag. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

options

TagAssignToOperationOptionalParams

Parametri delle opzioni.

Restituisce

Promise<TagContract>

assignToProduct(string, string, string, string, TagAssignToProductOptionalParams)

Assegnare il tag al prodotto.

function assignToProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagAssignToProductOptionalParams): Promise<TagContract>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

productId

string

Identificatore prodotto. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

tagId

string

Identificatore di tag. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

options

TagAssignToProductOptionalParams

Parametri delle opzioni.

Restituisce

Promise<TagContract>

createOrUpdate(string, string, string, TagCreateUpdateParameters, TagCreateOrUpdateOptionalParams)

Crea un tag.

function createOrUpdate(resourceGroupName: string, serviceName: string, tagId: string, parameters: TagCreateUpdateParameters, options?: TagCreateOrUpdateOptionalParams): Promise<TagCreateOrUpdateResponse>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

tagId

string

Identificatore di tag. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

parameters

TagCreateUpdateParameters

Creare parametri.

options

TagCreateOrUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<TagCreateOrUpdateResponse>

delete(string, string, string, string, TagDeleteOptionalParams)

Elimina un tag specifico dell'istanza del servizio Gestione API.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

tagId

string

Identificatore di tag. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

ifMatch

string

ETag dell'entità. ETag deve corrispondere allo stato corrente dell'entità dalla risposta di intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.

options

TagDeleteOptionalParams

Parametri delle opzioni.

Restituisce

Promise<void>

detachFromApi(string, string, string, string, TagDetachFromApiOptionalParams)

Scollegare il tag dall'API.

function detachFromApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagDetachFromApiOptionalParams): Promise<void>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

apiId

string

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

tagId

string

Identificatore di tag. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

options

TagDetachFromApiOptionalParams

Parametri delle opzioni.

Restituisce

Promise<void>

detachFromOperation(string, string, string, string, string, TagDetachFromOperationOptionalParams)

Scollegare il tag dall'operazione.

function detachFromOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagDetachFromOperationOptionalParams): Promise<void>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

apiId

string

Identificatore di revisione DELL'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API. La revisione non corrente include ;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 di Gestione API.

tagId

string

Identificatore di tag. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

options

TagDetachFromOperationOptionalParams

Parametri delle opzioni.

Restituisce

Promise<void>

detachFromProduct(string, string, string, string, TagDetachFromProductOptionalParams)

Scollegare il tag dal prodotto.

function detachFromProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagDetachFromProductOptionalParams): Promise<void>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

productId

string

Identificatore prodotto. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

tagId

string

Identificatore di tag. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

options

TagDetachFromProductOptionalParams

Parametri delle opzioni.

Restituisce

Promise<void>

get(string, string, string, TagGetOptionalParams)

Ottiene i dettagli del tag specificato dal relativo identificatore.

function get(resourceGroupName: string, serviceName: string, tagId: string, options?: TagGetOptionalParams): Promise<TagGetResponse>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

tagId

string

Identificatore di tag. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

options

TagGetOptionalParams

Parametri delle opzioni.

Restituisce

Promise<TagGetResponse>

getByApi(string, string, string, string, TagGetByApiOptionalParams)

Ottenere il tag associato all'API.

function getByApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagGetByApiOptionalParams): Promise<TagGetByApiResponse>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

apiId

string

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

tagId

string

Identificatore di tag. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

options

TagGetByApiOptionalParams

Parametri delle opzioni.

Restituisce

Promise<TagGetByApiResponse>

getByOperation(string, string, string, string, string, TagGetByOperationOptionalParams)

Ottiene il tag associato all'operazione.

function getByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagGetByOperationOptionalParams): Promise<TagGetByOperationResponse>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

apiId

string

Identificatore di revisione DELL'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API. La revisione non corrente include ;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 di Gestione API.

tagId

string

Identificatore di tag. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

options

TagGetByOperationOptionalParams

Parametri delle opzioni.

Restituisce

Promise<TagGetByOperationResponse>

getByProduct(string, string, string, string, TagGetByProductOptionalParams)

Ottiene il tag associato al prodotto.

function getByProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagGetByProductOptionalParams): Promise<TagGetByProductResponse>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

productId

string

Identificatore prodotto. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

tagId

string

Identificatore di tag. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

options

TagGetByProductOptionalParams

Parametri delle opzioni.

Restituisce

Promise<TagGetByProductResponse>

getEntityState(string, string, string, TagGetEntityStateOptionalParams)

Ottiene la versione dello stato dell'entità del tag specificato dal relativo identificatore.

function getEntityState(resourceGroupName: string, serviceName: string, tagId: string, options?: TagGetEntityStateOptionalParams): Promise<TagGetEntityStateHeaders>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

tagId

string

Identificatore di tag. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

options

TagGetEntityStateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<TagGetEntityStateHeaders>

getEntityStateByApi(string, string, string, string, TagGetEntityStateByApiOptionalParams)

Ottiene la versione dello stato dell'entità del tag specificato dal relativo identificatore.

function getEntityStateByApi(resourceGroupName: string, serviceName: string, apiId: string, tagId: string, options?: TagGetEntityStateByApiOptionalParams): Promise<TagGetEntityStateByApiHeaders>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

apiId

string

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

tagId

string

Identificatore di tag. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

options

TagGetEntityStateByApiOptionalParams

Parametri delle opzioni.

Restituisce

Promise<TagGetEntityStateByApiHeaders>

getEntityStateByOperation(string, string, string, string, string, TagGetEntityStateByOperationOptionalParams)

Ottiene la versione dello stato dell'entità del tag specificato dal relativo identificatore.

function getEntityStateByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, tagId: string, options?: TagGetEntityStateByOperationOptionalParams): Promise<TagGetEntityStateByOperationHeaders>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

apiId

string

Identificatore di revisione DELL'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API. La revisione non corrente include ;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 di Gestione API.

tagId

string

Identificatore di tag. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

options

TagGetEntityStateByOperationOptionalParams

Parametri delle opzioni.

Restituisce

Promise<TagGetEntityStateByOperationHeaders>

getEntityStateByProduct(string, string, string, string, TagGetEntityStateByProductOptionalParams)

Ottiene la versione dello stato dell'entità del tag specificato dal relativo identificatore.

function getEntityStateByProduct(resourceGroupName: string, serviceName: string, productId: string, tagId: string, options?: TagGetEntityStateByProductOptionalParams): Promise<TagGetEntityStateByProductHeaders>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

productId

string

Identificatore prodotto. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

tagId

string

Identificatore di tag. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

options

TagGetEntityStateByProductOptionalParams

Parametri delle opzioni.

Restituisce

Promise<TagGetEntityStateByProductHeaders>

listByApi(string, string, string, TagListByApiOptionalParams)

Elenca tutti i tag associati all'API.

function listByApi(resourceGroupName: string, serviceName: string, apiId: string, options?: TagListByApiOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

apiId

string

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

options

TagListByApiOptionalParams

Parametri delle opzioni.

Restituisce

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

listByOperation(string, string, string, string, TagListByOperationOptionalParams)

Elenca tutti i tag associati all'operazione.

function listByOperation(resourceGroupName: string, serviceName: string, apiId: string, operationId: string, options?: TagListByOperationOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

apiId

string

Identificatore di revisione DELL'API. Deve essere univoco nell'istanza corrente del servizio di Gestione API. La revisione non corrente include ;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 di Gestione API.

options

TagListByOperationOptionalParams

Parametri delle opzioni.

Restituisce

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

listByProduct(string, string, string, TagListByProductOptionalParams)

Elenca tutti i tag associati al prodotto.

function listByProduct(resourceGroupName: string, serviceName: string, productId: string, options?: TagListByProductOptionalParams): PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

productId

string

Identificatore prodotto. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

options

TagListByProductOptionalParams

Parametri delle opzioni.

Restituisce

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

listByService(string, string, TagListByServiceOptionalParams)

Elenca una raccolta di tag definiti all'interno di un'istanza del servizio.

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

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

options

TagListByServiceOptionalParams

Parametri delle opzioni.

Restituisce

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

update(string, string, string, string, TagCreateUpdateParameters, TagUpdateOptionalParams)

Aggiornamenti i dettagli del tag specificato dal relativo identificatore.

function update(resourceGroupName: string, serviceName: string, tagId: string, ifMatch: string, parameters: TagCreateUpdateParameters, options?: TagUpdateOptionalParams): Promise<TagUpdateResponse>

Parametri

resourceGroupName

string

Nome del gruppo di risorse. Per il nome non viene fatta distinzione tra maiuscole e minuscole.

serviceName

string

Nome del servizio di Gestione API.

tagId

string

Identificatore di tag. Deve essere univoco nell'istanza corrente del servizio di Gestione API.

ifMatch

string

ETag dell'entità. ETag deve corrispondere allo stato corrente dell'entità dalla risposta di intestazione della richiesta GET oppure deve essere * per l'aggiornamento incondizionato.

parameters

TagCreateUpdateParameters

Aggiornare i parametri.

options

TagUpdateOptionalParams

Parametri delle opzioni.

Restituisce

Promise<TagUpdateResponse>