Gateway interface
Interface que representa um Gateway.
Métodos
Detalhes de Método
createOrUpdate(string, string, string, GatewayContract, GatewayCreateOrUpdateOptionalParams)
Cria ou atualiza um Gateway para ser usado na instância de Gerenciamento 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 diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- gatewayId
-
string
Identificador de entidade do gateway. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Não deve ter valor 'gerenciado'
- parameters
- GatewayContract
Detalhes do gateway.
Os parâmetros de opções.
Devoluções
Promise<GatewayCreateOrUpdateResponse>
delete(string, string, string, string, GatewayDeleteOptionalParams)
Exclui 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 diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- gatewayId
-
string
Identificador de entidade do gateway. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Não deve ter valor 'gerenciado'
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado atual da entidade a partir da resposta do cabeçalho da solicitação 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 Compartilhado 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 diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- gatewayId
-
string
Identificador de entidade do gateway. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Não deve ter valor 'gerenciado'
- parameters
- GatewayTokenRequestContract
Propriedades do contrato de solicitação 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 especificado por seu 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 diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- gatewayId
-
string
Identificador de entidade do gateway. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Não deve ter valor 'gerenciado'
- options
- GatewayGetOptionalParams
Os parâmetros de opções.
Devoluções
Promise<GatewayGetResponse>
getEntityTag(string, string, string, GatewayGetEntityTagOptionalParams)
Obtém a versão do estado da entidade (Etag) do Gateway especificado por seu 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 diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- gatewayId
-
string
Identificador de entidade do gateway. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Não deve ter valor 'gerenciado'
Os parâmetros de opções.
Devoluções
Promise<GatewayGetEntityTagHeaders>
listByService(string, string, GatewayListByServiceOptionalParams)
Lista uma coleção de gateways registrados com 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 diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
Os parâmetros de opções.
Devoluções
listKeys(string, string, string, GatewayListKeysOptionalParams)
Recupera 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 diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- gatewayId
-
string
Identificador de entidade do gateway. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Não deve ter valor 'gerenciado'
- options
- GatewayListKeysOptionalParams
Os parâmetros de opções.
Devoluções
Promise<GatewayListKeysResponse>
regenerateKey(string, string, string, GatewayKeyRegenerationRequestContract, GatewayRegenerateKeyOptionalParams)
Regenera a chave de gateway especificada invalidando quaisquer tokens criados com ela.
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 diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- gatewayId
-
string
Identificador de entidade do gateway. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Não deve ter valor 'gerenciado'
- parameters
- GatewayKeyRegenerationRequestContract
Propriedades do contrato de solicitação de regeneração de chave de gateway.
Os parâmetros de opções.
Devoluções
Promise<void>
update(string, string, string, string, GatewayContract, GatewayUpdateOptionalParams)
Atualiza os detalhes do gateway especificado por seu 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 diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- gatewayId
-
string
Identificador de entidade do gateway. Deve ser exclusivo na instância de serviço de Gerenciamento de API atual. Não deve ter valor 'gerenciado'
- ifMatch
-
string
ETag da Entidade. O ETag deve corresponder ao estado atual da entidade a partir da resposta do cabeçalho da solicitação 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>