Tag interface

Paquete:

@azure/arm-apimanagement

Interfaz que representa una etiqueta.

Métodos

assignToApi(string, string, string, string, TagAssignToApiOptionalParams)	Asigne la etiqueta a la API.
assignToOperation(string, string, string, string, string, TagAssignToOperationOptionalParams)	Asigne la etiqueta a la operación.
assignToProduct(string, string, string, string, TagAssignToProductOptionalParams)	Asigne la etiqueta al producto.
createOrUpdate(string, string, string, TagCreateUpdateParameters, TagCreateOrUpdateOptionalParams)	Crea una etiqueta.
delete(string, string, string, string, TagDeleteOptionalParams)	Elimina una etiqueta específica de la instancia del servicio API Management.
detachFromApi(string, string, string, string, TagDetachFromApiOptionalParams)	Desasocie la etiqueta de la API.
detachFromOperation(string, string, string, string, string, TagDetachFromOperationOptionalParams)	Desasocie la etiqueta de la operación.
detachFromProduct(string, string, string, string, TagDetachFromProductOptionalParams)	Desasocie la etiqueta del producto.
get(string, string, string, TagGetOptionalParams)	Obtiene los detalles de la etiqueta especificada por su identificador.
getByApi(string, string, string, string, TagGetByApiOptionalParams)	Obtenga la etiqueta asociada a la API.
getByOperation(string, string, string, string, string, TagGetByOperationOptionalParams)	Obtenga la etiqueta asociada a la operación.
getByProduct(string, string, string, string, TagGetByProductOptionalParams)	Obtenga la etiqueta asociada al producto.
getEntityState(string, string, string, TagGetEntityStateOptionalParams)	Obtiene la versión de estado de entidad de la etiqueta especificada por su identificador.
getEntityStateByApi(string, string, string, string, TagGetEntityStateByApiOptionalParams)	Obtiene la versión de estado de entidad de la etiqueta especificada por su identificador.
getEntityStateByOperation(string, string, string, string, string, TagGetEntityStateByOperationOptionalParams)	Obtiene la versión de estado de entidad de la etiqueta especificada por su identificador.
getEntityStateByProduct(string, string, string, string, TagGetEntityStateByProductOptionalParams)	Obtiene la versión de estado de entidad de la etiqueta especificada por su identificador.
listByApi(string, string, string, TagListByApiOptionalParams)	Enumera todas las etiquetas asociadas a la API.
listByOperation(string, string, string, string, TagListByOperationOptionalParams)	Enumera todas las etiquetas asociadas a la operación.
listByProduct(string, string, string, TagListByProductOptionalParams)	Enumera todas las etiquetas asociadas al producto.
listByService(string, string, TagListByServiceOptionalParams)	Enumera una colección de etiquetas definidas dentro de una instancia de servicio.
update(string, string, string, string, TagCreateUpdateParameters, TagUpdateOptionalParams)	Actualiza los detalles de la etiqueta especificada por su identificador.

Detalles del método

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

Asigne la etiqueta a la API.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de revisión de API. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

tagId

string

Identificador de etiqueta. Debe ser único en la instancia actual del servicio API Management.

options

TagAssignToApiOptionalParams

Parámetros de opciones.

Devoluciones

Promise<TagAssignToApiResponse>

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

Asigne la etiqueta a la operación.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de revisión de API. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

operationId

string

Identificador de operación dentro de una API. Debe ser único en la instancia actual del servicio API Management.

tagId

string

Identificador de etiqueta. Debe ser único en la instancia actual del servicio API Management.

options

TagAssignToOperationOptionalParams

Parámetros de opciones.

Devoluciones

Promise<TagContract>

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

Asigne la etiqueta al producto.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

productId

string

Identificador del producto. Debe ser único en la instancia actual del servicio API Management.

tagId

string

Identificador de etiqueta. Debe ser único en la instancia actual del servicio API Management.

options

TagAssignToProductOptionalParams

Parámetros de opciones.

Devoluciones

Promise<TagContract>

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

Crea una etiqueta.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

tagId

string

Identificador de etiqueta. Debe ser único en la instancia actual del servicio API Management.

parameters

TagCreateUpdateParameters

Cree parámetros.

options

TagCreateOrUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<TagCreateOrUpdateResponse>

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

Elimina una etiqueta específica de la instancia del servicio API Management.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

tagId

string

Identificador de etiqueta. Debe ser único en la instancia actual del servicio API Management.

ifMatch

string

ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta del encabezado de la solicitud GET o debe ser * para la actualización incondicional.

options

TagDeleteOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

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

Desasocie la etiqueta de la API.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de revisión de API. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

tagId

string

Identificador de etiqueta. Debe ser único en la instancia actual del servicio API Management.

options

TagDetachFromApiOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

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

Desasocie la etiqueta de la operación.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de revisión de API. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

operationId

string

Identificador de operación dentro de una API. Debe ser único en la instancia actual del servicio API Management.

tagId

string

Identificador de etiqueta. Debe ser único en la instancia actual del servicio API Management.

options

TagDetachFromOperationOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

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

Desasocie la etiqueta del producto.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

productId

string

Identificador del producto. Debe ser único en la instancia actual del servicio API Management.

tagId

string

Identificador de etiqueta. Debe ser único en la instancia actual del servicio API Management.

options

TagDetachFromProductOptionalParams

Parámetros de opciones.

Devoluciones

Promise<void>

get(string, string, string, TagGetOptionalParams)

Obtiene los detalles de la etiqueta especificada por su identificador.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

tagId

string

Identificador de etiqueta. Debe ser único en la instancia actual del servicio API Management.

options

TagGetOptionalParams

Parámetros de opciones.

Devoluciones

Promise<TagGetResponse>

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

Obtenga la etiqueta asociada a la API.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de revisión de API. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

tagId

string

Identificador de etiqueta. Debe ser único en la instancia actual del servicio API Management.

options

TagGetByApiOptionalParams

Parámetros de opciones.

Devoluciones

Promise<TagGetByApiResponse>

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

Obtenga la etiqueta asociada a la operación.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de revisión de API. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

operationId

string

Identificador de operación dentro de una API. Debe ser único en la instancia actual del servicio API Management.

tagId

string

Identificador de etiqueta. Debe ser único en la instancia actual del servicio API Management.

options

TagGetByOperationOptionalParams

Parámetros de opciones.

Devoluciones

Promise<TagGetByOperationResponse>

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

Obtenga la etiqueta asociada al producto.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

productId

string

Identificador del producto. Debe ser único en la instancia actual del servicio API Management.

tagId

string

Identificador de etiqueta. Debe ser único en la instancia actual del servicio API Management.

options

TagGetByProductOptionalParams

Parámetros de opciones.

Devoluciones

Promise<TagGetByProductResponse>

getEntityState(string, string, string, TagGetEntityStateOptionalParams)

Obtiene la versión de estado de entidad de la etiqueta especificada por su identificador.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

tagId

string

Identificador de etiqueta. Debe ser único en la instancia actual del servicio API Management.

options

TagGetEntityStateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<TagGetEntityStateHeaders>

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

Obtiene la versión de estado de entidad de la etiqueta especificada por su identificador.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de revisión de API. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

tagId

string

Identificador de etiqueta. Debe ser único en la instancia actual del servicio API Management.

options

TagGetEntityStateByApiOptionalParams

Parámetros de opciones.

Devoluciones

Promise<TagGetEntityStateByApiHeaders>

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

Obtiene la versión de estado de entidad de la etiqueta especificada por su identificador.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de revisión de API. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

operationId

string

Identificador de operación dentro de una API. Debe ser único en la instancia actual del servicio API Management.

tagId

string

Identificador de etiqueta. Debe ser único en la instancia actual del servicio API Management.

options

TagGetEntityStateByOperationOptionalParams

Parámetros de opciones.

Devoluciones

Promise<TagGetEntityStateByOperationHeaders>

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

Obtiene la versión de estado de entidad de la etiqueta especificada por su identificador.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

productId

string

Identificador del producto. Debe ser único en la instancia actual del servicio API Management.

tagId

string

Identificador de etiqueta. Debe ser único en la instancia actual del servicio API Management.

options

TagGetEntityStateByProductOptionalParams

Parámetros de opciones.

Devoluciones

Promise<TagGetEntityStateByProductHeaders>

listByApi(string, string, string, TagListByApiOptionalParams)

Enumera todas las etiquetas asociadas a la API.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de revisión de API. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

options

TagListByApiOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

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

Enumera todas las etiquetas asociadas a la operación.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

apiId

string

Identificador de revisión de API. Debe ser único en la instancia actual del servicio API Management. La revisión no actual tiene ; rev=n como sufijo donde n es el número de revisión.

operationId

string

Identificador de operación dentro de una API. Debe ser único en la instancia actual del servicio API Management.

options

TagListByOperationOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

listByProduct(string, string, string, TagListByProductOptionalParams)

Enumera todas las etiquetas asociadas al producto.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

productId

string

Identificador del producto. Debe ser único en la instancia actual del servicio API Management.

options

TagListByProductOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

listByService(string, string, TagListByServiceOptionalParams)

Enumera una colección de etiquetas definidas dentro de una instancia de servicio.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

options

TagListByServiceOptionalParams

Parámetros de opciones.

Devoluciones

PagedAsyncIterableIterator<TagContract, TagContract[], PageSettings>

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

Actualiza los detalles de la etiqueta especificada por su identificador.

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

Parámetros

resourceGroupName

string

Nombre del grupo de recursos. El nombre no distingue mayúsculas de minúsculas.

serviceName

string

Nombre del servicio API Management.

tagId

string

Identificador de etiqueta. Debe ser único en la instancia actual del servicio API Management.

ifMatch

string

ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta del encabezado de la solicitud GET o debe ser * para la actualización incondicional.

parameters

TagCreateUpdateParameters

Actualice los parámetros.

options

TagUpdateOptionalParams

Parámetros de opciones.

Devoluciones

Promise<TagUpdateResponse>