GatewayApi interface
Interfaz que representa un GatewayApi.
Métodos
| create |
Agrega una API a la puerta de enlace especificada. |
| delete(string, string, string, string, Gateway |
Elimina la API especificada de la puerta de enlace especificada. |
| get |
Comprueba que la entidad de API especificada por el identificador está asociada a la entidad Gateway. |
| list |
Enumera una colección de las API asociadas a una puerta de enlace. |
Detalles del método
createOrUpdate(string, string, string, string, GatewayApiCreateOrUpdateOptionalParams)
Agrega una API a la puerta de enlace especificada.
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiCreateOrUpdateOptionalParams): Promise<ApiContract>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.
- gatewayId
-
string
Identificador de entidad de puerta de enlace. Debe ser único en la instancia actual del servicio API Management. No debe tener el valor "administrado".
- apiId
-
string
Identificador de API. Debe ser único en la instancia actual del servicio API Management.
Parámetros de opciones.
Devoluciones
Promise<ApiContract>
delete(string, string, string, string, GatewayApiDeleteOptionalParams)
Elimina la API especificada de la puerta de enlace especificada.
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiDeleteOptionalParams): 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.
- gatewayId
-
string
Identificador de entidad de puerta de enlace. Debe ser único en la instancia actual del servicio API Management. No debe tener el valor "administrado".
- apiId
-
string
Identificador de API. Debe ser único en la instancia actual del servicio API Management.
- options
- GatewayApiDeleteOptionalParams
Parámetros de opciones.
Devoluciones
Promise<void>
getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)
Comprueba que la entidad de API especificada por el identificador está asociada a la entidad Gateway.
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiGetEntityTagOptionalParams): Promise<GatewayApiGetEntityTagHeaders>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.
- gatewayId
-
string
Identificador de entidad de puerta de enlace. Debe ser único en la instancia actual del servicio API Management. No debe tener el valor "administrado".
- apiId
-
string
Identificador de API. Debe ser único en la instancia actual del servicio API Management.
Parámetros de opciones.
Devoluciones
Promise<GatewayApiGetEntityTagHeaders>
listByService(string, string, string, GatewayApiListByServiceOptionalParams)
Enumera una colección de las API asociadas a una puerta de enlace.
function listByService(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], 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.
- gatewayId
-
string
Identificador de entidad de puerta de enlace. Debe ser único en la instancia actual del servicio API Management. No debe tener el valor "administrado".
Parámetros de opciones.