AuthorizationServer | @azure/arm-apimanagement

Interface representing a AuthorizationServer.

Hierarchy

AuthorizationServer

Implemented by

AuthorizationServerImpl

Index

Methods

createOrUpdate

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

- Defined in operationsInterfaces/authorizationServer.ts:75
Creates new authorization server or updates an existing authorization server.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- authsid: string
  
  Identifier of the authorization server.
- parameters: AuthorizationServerContract
  
  Create or update parameters.
- Optional options: AuthorizationServerCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<AuthorizationServerCreateOrUpdateResponse>

delete

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

- Defined in operationsInterfaces/authorizationServer.ts:109
Deletes specific authorization server instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: AuthorizationServerDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

- Defined in operationsInterfaces/authorizationServer.ts:61
Gets the details of the authorization server specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- authsid: string
  
  Identifier of the authorization server.
- Optional options: AuthorizationServerGetOptionalParams
  
  The options parameters.
Returns Promise<AuthorizationServerGetResponse>

getEntityTag

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

- Defined in operationsInterfaces/authorizationServer.ts:48
Gets the entity state (Etag) version of the authorizationServer specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- authsid: string
  
  Identifier of the authorization server.
- Optional options: AuthorizationServerGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<AuthorizationServerGetEntityTagResponse>

listByService

listByService(resourceGroupName: string, serviceName: string, options?: AuthorizationServerListByServiceOptionalParams): PagedAsyncIterableIterator<AuthorizationServerContract>

- Defined in operationsInterfaces/authorizationServer.ts:36
Lists a collection of authorization servers defined within a service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: AuthorizationServerListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<AuthorizationServerContract>

listSecrets

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

- Defined in operationsInterfaces/authorizationServer.ts:123
Gets the client secret details of the authorization server.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- authsid: string
  
  Identifier of the authorization server.
- Optional options: AuthorizationServerListSecretsOptionalParams
  
  The options parameters.
Returns Promise<AuthorizationServerListSecretsResponse>

update

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

- Defined in operationsInterfaces/authorizationServer.ts:92
Updates the details of the authorization server specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: AuthorizationServerUpdateOptionalParams
  
  The options parameters.
Returns Promise<AuthorizationServerUpdateResponse>

Hierarchy

Implemented by

Index

Methods

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

authsid: string

parameters: AuthorizationServerContract

Optional options: AuthorizationServerCreateOrUpdateOptionalParams

Returns Promise<AuthorizationServerCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

authsid: string

ifMatch: string

Optional options: AuthorizationServerDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

authsid: string

Optional options: AuthorizationServerGetOptionalParams

Returns Promise<AuthorizationServerGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

authsid: string

Optional options: AuthorizationServerGetEntityTagOptionalParams

Returns Promise<AuthorizationServerGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

Optional options: AuthorizationServerListByServiceOptionalParams

Returns PagedAsyncIterableIterator<AuthorizationServerContract>

listSecrets

Parameters

resourceGroupName: string

serviceName: string

authsid: string

Optional options: AuthorizationServerListSecretsOptionalParams

Returns Promise<AuthorizationServerListSecretsResponse>

update

Parameters

resourceGroupName: string

serviceName: string

authsid: string

ifMatch: string

parameters: AuthorizationServerUpdateContract

Optional options: AuthorizationServerUpdateOptionalParams

Returns Promise<AuthorizationServerUpdateResponse>