AuthorizationServer interface
Interface que representa um AuthorizationServer.
Métodos
Detalhes de Método
createOrUpdate(string, string, string, AuthorizationServerContract, AuthorizationServerCreateOrUpdateOptionalParams)
Cria um novo servidor de autorização ou atualiza um servidor de autorização existente.
function createOrUpdate(resourceGroupName: string, serviceName: string, authsid: string, parameters: AuthorizationServerContract, options?: AuthorizationServerCreateOrUpdateOptionalParams): Promise<AuthorizationServerCreateOrUpdateResponse>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.
- authsid
-
string
Identificador do servidor de autorização.
- parameters
- AuthorizationServerContract
Criar ou atualizar parâmetros.
Os parâmetros de opções.
Devoluções
delete(string, string, string, string, AuthorizationServerDeleteOptionalParams)
Elimina uma instância específica do servidor de autorização.
function delete(resourceGroupName: string, serviceName: string, authsid: string, ifMatch: string, options?: AuthorizationServerDeleteOptionalParams): 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.
- authsid
-
string
Identificador do servidor de autorização.
- ifMatch
-
string
ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.
Os parâmetros de opções.
Devoluções
Promise<void>
get(string, string, string, AuthorizationServerGetOptionalParams)
Obtém os detalhes do servidor de autorização especificados pelo respetivo identificador.
function get(resourceGroupName: string, serviceName: string, authsid: string, options?: AuthorizationServerGetOptionalParams): Promise<AuthorizationServerGetResponse>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.
- authsid
-
string
Identificador do servidor de autorização.
Os parâmetros de opções.
Devoluções
Promise<AuthorizationServerGetResponse>
getEntityTag(string, string, string, AuthorizationServerGetEntityTagOptionalParams)
Obtém a versão do estado da entidade (Etag) do authorizationServer especificado pelo respetivo identificador.
function getEntityTag(resourceGroupName: string, serviceName: string, authsid: string, options?: AuthorizationServerGetEntityTagOptionalParams): Promise<AuthorizationServerGetEntityTagHeaders>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.
- authsid
-
string
Identificador do servidor de autorização.
Os parâmetros de opções.
Devoluções
listByService(string, string, AuthorizationServerListByServiceOptionalParams)
Lista uma coleção de servidores de autorização definidos numa instância de serviço.
function listByService(resourceGroupName: string, serviceName: string, options?: AuthorizationServerListByServiceOptionalParams): PagedAsyncIterableIterator<AuthorizationServerContract, AuthorizationServerContract[], 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
listSecrets(string, string, string, AuthorizationServerListSecretsOptionalParams)
Obtém os detalhes do segredo do cliente do servidor de autorização.
function listSecrets(resourceGroupName: string, serviceName: string, authsid: string, options?: AuthorizationServerListSecretsOptionalParams): Promise<AuthorizationServerListSecretsResponse>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.
- authsid
-
string
Identificador do servidor de autorização.
Os parâmetros de opções.
Devoluções
update(string, string, string, string, AuthorizationServerUpdateContract, AuthorizationServerUpdateOptionalParams)
Atualizações os detalhes do servidor de autorização especificados pelo respetivo identificador.
function update(resourceGroupName: string, serviceName: string, authsid: string, ifMatch: string, parameters: AuthorizationServerUpdateContract, options?: AuthorizationServerUpdateOptionalParams): Promise<AuthorizationServerUpdateResponse>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.
- authsid
-
string
Identificador do servidor de autorização.
- ifMatch
-
string
ETag da Entidade. A ETag deve corresponder ao estado da entidade atual da resposta de cabeçalho do pedido GET ou deve ser * para atualização incondicional.
- parameters
- AuthorizationServerUpdateContract
Definições do Servidor OAuth2 Atualizar parâmetros.
Os parâmetros de opções.
Devoluções
Promise<AuthorizationServerUpdateResponse>