Gateway interface
Interface que representa um Gateway.
Métodos
Detalhes de Método
createOrUpdate(string, string, string, GatewayContract, GatewayCreateOrUpdateOptionalParams)
Cria ou atualiza um Gateway a ser utilizado na instância de Gestão de API.
function createOrUpdate(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayContract, options?: GatewayCreateOrUpdateOptionalParams): Promise<GatewayCreateOrUpdateResponse>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 de gateway. Tem de ser exclusivo na instância de serviço de Gestão de API atual. Não é possível ter o valor "gerido"
- parameters
- GatewayContract
Detalhes do gateway.
Os parâmetros de opções.
Devoluções
Promise<GatewayCreateOrUpdateResponse>
delete(string, string, string, string, GatewayDeleteOptionalParams)
Elimina o Gateway específico.
function delete(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, options?: GatewayDeleteOptionalParams): 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 de gateway. Tem de ser exclusivo na instância de serviço de Gestão de API atual. Não é possível ter o valor "gerido"
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.
- options
- GatewayDeleteOptionalParams
Os parâmetros de opções.
Devoluções
Promise<void>
generateToken(string, string, string, GatewayTokenRequestContract, GatewayGenerateTokenOptionalParams)
Obtém o Token de Autorização de Acesso Partilhado para o gateway.
function generateToken(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayTokenRequestContract, options?: GatewayGenerateTokenOptionalParams): Promise<GatewayTokenContract>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 de gateway. Tem de ser exclusivo na instância de serviço de Gestão de API atual. Não é possível ter o valor "gerido"
- parameters
- GatewayTokenRequestContract
Propriedades do contrato do pedido de token de gateway.
Os parâmetros de opções.
Devoluções
Promise<GatewayTokenContract>
get(string, string, string, GatewayGetOptionalParams)
Obtém os detalhes do Gateway especificados pelo identificador.
function get(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetOptionalParams): Promise<GatewayGetResponse>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 de gateway. Tem de ser exclusivo na instância de serviço de Gestão de API atual. Não é possível ter o valor "gerido"
- options
- GatewayGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<GatewayGetResponse>
getEntityTag(string, string, string, GatewayGetEntityTagOptionalParams)
Obtém a versão de estado da entidade (Etag) do Gateway especificada pelo identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayGetEntityTagOptionalParams): Promise<GatewayGetEntityTagHeaders>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 de gateway. Tem de ser exclusivo na instância de serviço de Gestão de API atual. Não é possível ter o valor "gerido"
Os parâmetros de opções.
Devoluções
Promise<GatewayGetEntityTagHeaders>
listByService(string, string, GatewayListByServiceOptionalParams)
Lista uma coleção de gateways registados na instância de serviço.
function listByService(resourceGroupName: string, serviceName: string, options?: GatewayListByServiceOptionalParams): PagedAsyncIterableIterator<GatewayContract, GatewayContract[], 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.
Os parâmetros de opções.
Devoluções
listKeys(string, string, string, GatewayListKeysOptionalParams)
Obtém chaves de gateway.
function listKeys(resourceGroupName: string, serviceName: string, gatewayId: string, options?: GatewayListKeysOptionalParams): Promise<GatewayListKeysResponse>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 de gateway. Tem de ser exclusivo na instância de serviço de Gestão de API atual. Não é possível ter o valor "gerido"
- options
- GatewayListKeysOptionalParams
Os parâmetros de opções.
Devoluções
Promise<GatewayListKeysResponse>
regenerateKey(string, string, string, GatewayKeyRegenerationRequestContract, GatewayRegenerateKeyOptionalParams)
Regenera a chave de gateway especificada que invalida os tokens criados com a mesma.
function regenerateKey(resourceGroupName: string, serviceName: string, gatewayId: string, parameters: GatewayKeyRegenerationRequestContract, options?: GatewayRegenerateKeyOptionalParams): 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 de gateway. Tem de ser exclusivo na instância de serviço de Gestão de API atual. Não é possível ter o valor "gerido"
- parameters
- GatewayKeyRegenerationRequestContract
Propriedades do contrato do pedido de regeneração de chaves de gateway.
Os parâmetros de opções.
Devoluções
Promise<void>
update(string, string, string, string, GatewayContract, GatewayUpdateOptionalParams)
Atualizações os detalhes do gateway especificado pelo identificador.
function update(resourceGroupName: string, serviceName: string, gatewayId: string, ifMatch: string, parameters: GatewayContract, options?: GatewayUpdateOptionalParams): Promise<GatewayUpdateResponse>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 de gateway. Tem de ser exclusivo na instância de serviço de Gestão de API atual. Não é possível ter o valor "gerido"
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.
- parameters
- GatewayContract
Detalhes do gateway.
- options
- GatewayUpdateOptionalParams
Os parâmetros de opções.
Devoluções
Promise<GatewayUpdateResponse>