Api interface
Interfaz que representa una API.
Métodos
| begin |
Crea una nueva o actualiza la API existente especificada de la instancia del servicio API Management |
| begin |
Crea una nueva o actualiza la API existente especificada de la instancia del servicio API Management |
| delete(string, string, string, string, Api |
Elimina la API especificada de la instancia del servicio API Management. |
| get(string, string, string, Api |
Obtiene los detalles de la API especificada por su identificador. |
| get |
Obtiene la versión de estado de entidad (Etag) de la API especificada por su identificador. |
| list |
Enumera todas las API de la instancia del servicio API Management |
| list |
Enumera una colección de API asociadas a etiquetas. |
| update(string, string, string, string, Api |
Novedades la API especificada de la instancia de servicio de API Management. |
Detalles del método
beginCreateOrUpdate(string, string, string, ApiCreateOrUpdateParameter, ApiCreateOrUpdateOptionalParams)
Crea una nueva o actualiza la API existente especificada de la instancia del servicio API Management
function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: ApiCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiCreateOrUpdateResponse>, ApiCreateOrUpdateResponse>>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 de API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.
- parameters
- ApiCreateOrUpdateParameter
Crear o actualizar parámetros.
- options
- ApiCreateOrUpdateOptionalParams
Parámetros de opciones.
Devoluciones
Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiCreateOrUpdateResponse>, ApiCreateOrUpdateResponse>>
beginCreateOrUpdateAndWait(string, string, string, ApiCreateOrUpdateParameter, ApiCreateOrUpdateOptionalParams)
Crea una nueva o actualiza la API existente especificada de la instancia del servicio API Management
function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: ApiCreateOrUpdateOptionalParams): Promise<ApiCreateOrUpdateResponse>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 de API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.
- parameters
- ApiCreateOrUpdateParameter
Crear o actualizar parámetros.
- options
- ApiCreateOrUpdateOptionalParams
Parámetros de opciones.
Devoluciones
Promise<ApiCreateOrUpdateResponse>
delete(string, string, string, string, ApiDeleteOptionalParams)
Elimina la API especificada de la instancia del servicio API Management.
function delete(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, options?: ApiDeleteOptionalParams): 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 de API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.
- ifMatch
-
string
ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta de encabezado de la solicitud GET o debe ser * para la actualización incondicional.
- options
- ApiDeleteOptionalParams
Parámetros de opciones.
Devoluciones
Promise<void>
get(string, string, string, ApiGetOptionalParams)
Obtiene los detalles de la API especificada por su identificador.
function get(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiGetOptionalParams): Promise<ApiGetResponse>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 de API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.
- options
- ApiGetOptionalParams
Parámetros de opciones.
Devoluciones
Promise<ApiGetResponse>
getEntityTag(string, string, string, ApiGetEntityTagOptionalParams)
Obtiene la versión de estado de entidad (Etag) de la API especificada por su identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiGetEntityTagOptionalParams): Promise<ApiGetEntityTagHeaders>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 de API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.
- options
- ApiGetEntityTagOptionalParams
Parámetros de opciones.
Devoluciones
Promise<ApiGetEntityTagHeaders>
listByService(string, string, ApiListByServiceOptionalParams)
Enumera todas las API de la instancia del servicio API Management
function listByService(resourceGroupName: string, serviceName: string, options?: ApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], 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.
- options
- ApiListByServiceOptionalParams
Parámetros de opciones.
Devoluciones
listByTags(string, string, ApiListByTagsOptionalParams)
Enumera una colección de API asociadas a etiquetas.
function listByTags(resourceGroupName: string, serviceName: string, options?: ApiListByTagsOptionalParams): PagedAsyncIterableIterator<TagResourceContract, TagResourceContract[], 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.
- options
- ApiListByTagsOptionalParams
Parámetros de opciones.
Devoluciones
update(string, string, string, string, ApiUpdateContract, ApiUpdateOptionalParams)
Novedades la API especificada de la instancia de servicio de API Management.
function update(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, parameters: ApiUpdateContract, options?: ApiUpdateOptionalParams): Promise<ApiUpdateResponse>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 de API Management actual. La revisión no actual tiene ;rev=n como sufijo donde n es el número de revisión.
- ifMatch
-
string
ETag de la entidad. ETag debe coincidir con el estado de entidad actual de la respuesta de encabezado de la solicitud GET o debe ser * para la actualización incondicional.
- parameters
- ApiUpdateContract
Parámetros del contrato de actualización de API.
- options
- ApiUpdateOptionalParams
Parámetros de opciones.
Devoluciones
Promise<ApiUpdateResponse>