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 diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- authsid
-
string
Identificador do servidor de autorização.
- parameters
- AuthorizationServerContract
Crie ou atualize parâmetros.
Os parâmetros de opções.
Devoluções
delete(string, string, string, string, AuthorizationServerDeleteOptionalParams)
Exclui 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 diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- authsid
-
string
Identificador do servidor de autorização.
- 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.
Os parâmetros de opções.
Devoluções
Promise<void>
get(string, string, string, AuthorizationServerGetOptionalParams)
Obtém os detalhes do servidor de autorização especificado por seu 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 diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento 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 por seu 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 diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento 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 em uma 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 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
listSecrets(string, string, string, AuthorizationServerListSecretsOptionalParams)
Obtém os detalhes secretos 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 diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento 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 os detalhes do servidor de autorização especificado por seu 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 diferencia maiúsculas de minúsculas.
- serviceName
-
string
O nome do serviço de Gerenciamento de API.
- authsid
-
string
Identificador do servidor de autorização.
- 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
- AuthorizationServerUpdateContract
Configurações do OAuth2 Server Parâmetros de atualização.
Os parâmetros de opções.
Devoluções
Promise<AuthorizationServerUpdateResponse>