ApiTagDescription interface
Interfaz que representa una ApiTagDescription.
Métodos
| create |
Crea o actualiza la descripción de la etiqueta en el ámbito de la API. |
| delete(string, string, string, string, string, Api |
Elimina la descripción de la etiqueta de la API. |
| get(string, string, string, string, Api |
Obtención de la descripción de etiquetas en el ámbito de la API |
| get |
Obtiene la versión de estado de entidad de la etiqueta especificada por su identificador. |
| list |
Enumera todas las descripciones de etiquetas en el ámbito de la API. Modelo similar a swagger: tagDescription se define en el nivel de API, pero la etiqueta se puede asignar a las operaciones. |
Detalles del método
createOrUpdate(string, string, string, string, TagDescriptionCreateParameters, ApiTagDescriptionCreateOrUpdateOptionalParams)
Crea o actualiza la descripción de la etiqueta en el ámbito de la API.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, parameters: TagDescriptionCreateParameters, options?: ApiTagDescriptionCreateOrUpdateOptionalParams): Promise<ApiTagDescriptionCreateOrUpdateResponse>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre 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 de servicio API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.
- tagDescriptionId
-
string
Identificador de descripción de etiqueta. Se usa al crear tagDescription para la asociación de API/Tag. En función de la API y los nombres de etiqueta.
- parameters
- TagDescriptionCreateParameters
Crear parámetros.
Parámetros de opciones.
Devoluciones
delete(string, string, string, string, string, ApiTagDescriptionDeleteOptionalParams)
Elimina la descripción de la etiqueta de la API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, ifMatch: string, options?: ApiTagDescriptionDeleteOptionalParams): Promise<void>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre 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 de servicio API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.
- tagDescriptionId
-
string
Identificador de descripción de etiqueta. Se usa al crear tagDescription para la asociación de API/Tag. En función de la API y los nombres de etiqueta.
- 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.
Parámetros de opciones.
Devoluciones
Promise<void>
get(string, string, string, string, ApiTagDescriptionGetOptionalParams)
Obtención de la descripción de etiquetas en el ámbito de la API
function get(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetOptionalParams): Promise<ApiTagDescriptionGetResponse>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre 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 de servicio API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.
- tagDescriptionId
-
string
Identificador de descripción de etiqueta. Se usa al crear tagDescription para la asociación de API/Tag. En función de la API y los nombres de etiqueta.
Parámetros de opciones.
Devoluciones
Promise<ApiTagDescriptionGetResponse>
getEntityTag(string, string, string, string, ApiTagDescriptionGetEntityTagOptionalParams)
Obtiene la versión de estado de entidad de la etiqueta especificada por su identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, tagDescriptionId: string, options?: ApiTagDescriptionGetEntityTagOptionalParams): Promise<ApiTagDescriptionGetEntityTagHeaders>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre 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 de servicio API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.
- tagDescriptionId
-
string
Identificador de descripción de etiqueta. Se usa al crear tagDescription para la asociación de API/Tag. En función de la API y los nombres de etiqueta.
Parámetros de opciones.
Devoluciones
Promise<ApiTagDescriptionGetEntityTagHeaders>
listByService(string, string, string, ApiTagDescriptionListByServiceOptionalParams)
Enumera todas las descripciones de etiquetas en el ámbito de la API. Modelo similar a swagger: tagDescription se define en el nivel de API, pero la etiqueta se puede asignar a las operaciones.
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiTagDescriptionListByServiceOptionalParams): PagedAsyncIterableIterator<TagDescriptionContract, TagDescriptionContract[], PageSettings>Parámetros
- resourceGroupName
-
string
Nombre del grupo de recursos. El nombre 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 de servicio API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.
Parámetros de opciones.