GatewayApi interface
Interface que representa um GatewayApi.
Métodos
| create |
Adiciona uma API ao Gateway especificado. |
| delete(string, string, string, string, Gateway |
Exclui a API especificada do gateway especificado. |
| get |
Verifica se a entidade de API especificada pelo identificador está associada à entidade Gateway. |
| list |
Lista uma coleção das APIs associadas a um gateway. |
Detalhes do método
createOrUpdate(string, string, string, string, GatewayApiCreateOrUpdateOptionalParams)
Adiciona uma API ao Gateway especificado.
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiCreateOrUpdateOptionalParams): Promise<ApiContract>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- gatewayId
-
string
Identificador de entidade de gateway. Deve ser exclusivo na instância de serviço Gerenciamento de API atual. Não deve ter o valor 'gerenciado'
- apiId
-
string
Identificador da API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
Os parâmetros de opções.
Retornos
Promise<ApiContract>
delete(string, string, string, string, GatewayApiDeleteOptionalParams)
Exclui a API especificada do gateway especificado.
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiDeleteOptionalParams): Promise<void>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- gatewayId
-
string
Identificador de entidade de gateway. Deve ser exclusivo na instância de serviço Gerenciamento de API atual. Não deve ter o valor 'gerenciado'
- apiId
-
string
Identificador da API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
- options
- GatewayApiDeleteOptionalParams
Os parâmetros de opções.
Retornos
Promise<void>
getEntityTag(string, string, string, string, GatewayApiGetEntityTagOptionalParams)
Verifica se a entidade de API especificada pelo identificador está associada à entidade Gateway.
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, apiId: string, options?: GatewayApiGetEntityTagOptionalParams): Promise<GatewayApiGetEntityTagHeaders>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- gatewayId
-
string
Identificador de entidade de gateway. Deve ser exclusivo na instância de serviço Gerenciamento de API atual. Não deve ter o valor 'gerenciado'
- apiId
-
string
Identificador da API. Deve ser exclusivo na instância de serviço Gerenciamento de API atual.
Os parâmetros de opções.
Retornos
Promise<GatewayApiGetEntityTagHeaders>
listByService(string, string, string, GatewayApiListByServiceOptionalParams)
Lista uma coleção das APIs associadas a um gateway.
function listByService(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>Parâmetros
- resourceGroupName
-
string
O nome do grupo de recursos. O nome diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço Gerenciamento de API.
- gatewayId
-
string
Identificador de entidade de gateway. Deve ser exclusivo na instância de serviço Gerenciamento de API atual. Não deve ter o valor 'gerenciado'
Os parâmetros de opções.