AuthorizationServer interface

Package:

@azure/arm-apimanagement

Interface representing a AuthorizationServer.

Methods

createOrUpdate(string, string, string, AuthorizationServerContract, AuthorizationServerCreateOrUpdateOptionalParams)	Creates new authorization server or updates an existing authorization server.
delete(string, string, string, string, AuthorizationServerDeleteOptionalParams)	Deletes specific authorization server instance.
get(string, string, string, AuthorizationServerGetOptionalParams)	Gets the details of the authorization server specified by its identifier.
getEntityTag(string, string, string, AuthorizationServerGetEntityTagOptionalParams)	Gets the entity state (Etag) version of the authorizationServer specified by its identifier.
listByService(string, string, AuthorizationServerListByServiceOptionalParams)	Lists a collection of authorization servers defined within a service instance.
listSecrets(string, string, string, AuthorizationServerListSecretsOptionalParams)	Gets the client secret details of the authorization server.
update(string, string, string, string, AuthorizationServerUpdateContract, AuthorizationServerUpdateOptionalParams)	Updates the details of the authorization server specified by its identifier.

Method Details

createOrUpdate(string, string, string, AuthorizationServerContract, AuthorizationServerCreateOrUpdateOptionalParams)

Creates new authorization server or updates an existing authorization server.

function createOrUpdate(resourceGroupName: string, serviceName: string, authsid: string, parameters: AuthorizationServerContract, options?: AuthorizationServerCreateOrUpdateOptionalParams): Promise<AuthorizationServerCreateOrUpdateResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

authsid

string

Identifier of the authorization server.

parameters

AuthorizationServerContract

Create or update parameters.

options

AuthorizationServerCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<AuthorizationServerCreateOrUpdateResponse>

delete(string, string, string, string, AuthorizationServerDeleteOptionalParams)

Deletes specific authorization server instance.

function delete(resourceGroupName: string, serviceName: string, authsid: string, ifMatch: string, options?: AuthorizationServerDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

authsid

string

Identifier of the authorization server.

ifMatch

string

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

options

AuthorizationServerDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, AuthorizationServerGetOptionalParams)

Gets the details of the authorization server specified by its identifier.

function get(resourceGroupName: string, serviceName: string, authsid: string, options?: AuthorizationServerGetOptionalParams): Promise<AuthorizationServerGetResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

authsid

string

Identifier of the authorization server.

options

AuthorizationServerGetOptionalParams

The options parameters.

Returns

Promise<AuthorizationServerGetResponse>

getEntityTag(string, string, string, AuthorizationServerGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the authorizationServer specified by its identifier.

function getEntityTag(resourceGroupName: string, serviceName: string, authsid: string, options?: AuthorizationServerGetEntityTagOptionalParams): Promise<AuthorizationServerGetEntityTagHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

authsid

string

Identifier of the authorization server.

options

AuthorizationServerGetEntityTagOptionalParams

The options parameters.

Returns

Promise<AuthorizationServerGetEntityTagHeaders>

listByService(string, string, AuthorizationServerListByServiceOptionalParams)

Lists a collection of authorization servers defined within a service instance.

function listByService(resourceGroupName: string, serviceName: string, options?: AuthorizationServerListByServiceOptionalParams): PagedAsyncIterableIterator<AuthorizationServerContract, AuthorizationServerContract[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

options

AuthorizationServerListByServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<AuthorizationServerContract, AuthorizationServerContract[], PageSettings>

listSecrets(string, string, string, AuthorizationServerListSecretsOptionalParams)

Gets the client secret details of the authorization server.

function listSecrets(resourceGroupName: string, serviceName: string, authsid: string, options?: AuthorizationServerListSecretsOptionalParams): Promise<AuthorizationServerListSecretsResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

authsid

string

Identifier of the authorization server.

options

AuthorizationServerListSecretsOptionalParams

The options parameters.

Returns

Promise<AuthorizationServerListSecretsResponse>

update(string, string, string, string, AuthorizationServerUpdateContract, AuthorizationServerUpdateOptionalParams)

Updates the details of the authorization server specified by its identifier.

function update(resourceGroupName: string, serviceName: string, authsid: string, ifMatch: string, parameters: AuthorizationServerUpdateContract, options?: AuthorizationServerUpdateOptionalParams): Promise<AuthorizationServerUpdateResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

authsid

string

Identifier of the authorization server.

ifMatch

string

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

parameters

AuthorizationServerUpdateContract

OAuth2 Server settings Update parameters.

options

AuthorizationServerUpdateOptionalParams

The options parameters.

Returns

Promise<AuthorizationServerUpdateResponse>