GatewayApi interface
Interface que representa um GatewayApi.
Métodos
| create |
Adiciona uma API ao Gateway especificado. |
| delete(string, string, string, string, Gateway |
Elimina 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 de 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 não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- gatewayId
-
string
Identificador de entidade do gateway. Tem de ser exclusivo na instância de serviço do Gestão de API atual. Não pode ter o valor "gerido"
- apiId
-
string
Identificador de API. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
Os parâmetros de opções.
Devoluções
Promise<ApiContract>
delete(string, string, string, string, GatewayApiDeleteOptionalParams)
Elimina 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 não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- gatewayId
-
string
Identificador de entidade do gateway. Tem de ser exclusivo na instância de serviço do Gestão de API atual. Não pode ter o valor "gerido"
- apiId
-
string
Identificador de API. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
- options
- GatewayApiDeleteOptionalParams
Os parâmetros de opções.
Devoluções
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 não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- gatewayId
-
string
Identificador de entidade do gateway. Tem de ser exclusivo na instância de serviço do Gestão de API atual. Não pode ter o valor "gerido"
- apiId
-
string
Identificador de API. Tem de ser exclusivo na instância de serviço do Gestão de API atual.
Os parâmetros de opções.
Devoluções
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 não é sensível a maiúsculas e minúsculas.
- serviceName
-
string
O nome do serviço Gestão de API.
- gatewayId
-
string
Identificador de entidade do gateway. Tem de ser exclusivo na instância de serviço do Gestão de API atual. Não pode ter o valor "gerido"
Os parâmetros de opções.