Authorization interface
Interface representing a Authorization.
Methods
| confirm |
Confirm valid consent code to suppress Authorizations anti-phishing page. |
| create |
Creates or updates authorization. |
| delete(string, string, string, string, string, Authorization |
Deletes specific Authorization from the Authorization provider. |
| get(string, string, string, string, Authorization |
Gets the details of the authorization specified by its identifier. |
| list |
Lists a collection of authorization providers defined within a authorization provider. |
Method Details
confirmConsentCode(string, string, string, string, AuthorizationConfirmConsentCodeRequestContract, AuthorizationConfirmConsentCodeOptionalParams)
Confirm valid consent code to suppress Authorizations anti-phishing page.
function confirmConsentCode(resourceGroupName: string, serviceName: string, authorizationProviderId: string, authorizationId: string, parameters: AuthorizationConfirmConsentCodeRequestContract, options?: AuthorizationConfirmConsentCodeOptionalParams): Promise<AuthorizationConfirmConsentCodeHeaders>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- authorizationProviderId
-
string
Identifier of the authorization provider.
- authorizationId
-
string
Identifier of the authorization.
Create parameters.
The options parameters.
Returns
createOrUpdate(string, string, string, string, AuthorizationContract, AuthorizationCreateOrUpdateOptionalParams)
Creates or updates authorization.
function createOrUpdate(resourceGroupName: string, serviceName: string, authorizationProviderId: string, authorizationId: string, parameters: AuthorizationContract, options?: AuthorizationCreateOrUpdateOptionalParams): Promise<AuthorizationCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- authorizationProviderId
-
string
Identifier of the authorization provider.
- authorizationId
-
string
Identifier of the authorization.
- parameters
- AuthorizationContract
Create parameters.
The options parameters.
Returns
Promise<AuthorizationCreateOrUpdateResponse>
delete(string, string, string, string, string, AuthorizationDeleteOptionalParams)
Deletes specific Authorization from the Authorization provider.
function delete(resourceGroupName: string, serviceName: string, authorizationProviderId: string, authorizationId: string, ifMatch: string, options?: AuthorizationDeleteOptionalParams): 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.
- authorizationProviderId
-
string
Identifier of the authorization provider.
- authorizationId
-
string
Identifier of the authorization.
- 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.
The options parameters.
Returns
Promise<void>
get(string, string, string, string, AuthorizationGetOptionalParams)
Gets the details of the authorization specified by its identifier.
function get(resourceGroupName: string, serviceName: string, authorizationProviderId: string, authorizationId: string, options?: AuthorizationGetOptionalParams): Promise<AuthorizationGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- authorizationProviderId
-
string
Identifier of the authorization provider.
- authorizationId
-
string
Identifier of the authorization.
- options
- AuthorizationGetOptionalParams
The options parameters.
Returns
Promise<AuthorizationGetResponse>
listByAuthorizationProvider(string, string, string, AuthorizationListByAuthorizationProviderOptionalParams)
Lists a collection of authorization providers defined within a authorization provider.
function listByAuthorizationProvider(resourceGroupName: string, serviceName: string, authorizationProviderId: string, options?: AuthorizationListByAuthorizationProviderOptionalParams): PagedAsyncIterableIterator<AuthorizationContract, AuthorizationContract[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of the API Management service.
- authorizationProviderId
-
string
Identifier of the authorization provider.
The options parameters.