@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 10.6 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* External OAuth authorization server settings.
*
* Uses Azure REST API version 2022-09-01-preview. In version 2.x of the Azure Native provider, it used API version 2022-08-01.
*
* Other available API versions: 2021-04-01-preview, 2021-08-01, 2021-12-01-preview, 2022-04-01-preview, 2022-08-01, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native apimanagement [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class AuthorizationServer extends pulumi.CustomResource {
/**
* Get an existing AuthorizationServer resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): AuthorizationServer;
/**
* Returns true if the given object is an instance of AuthorizationServer. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is AuthorizationServer;
/**
* OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
*/
readonly authorizationEndpoint: pulumi.Output<string>;
/**
* HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
*/
readonly authorizationMethods: pulumi.Output<string[] | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Specifies the mechanism by which access token is passed to the API.
*/
readonly bearerTokenSendingMethods: pulumi.Output<string[] | undefined>;
/**
* Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.
*/
readonly clientAuthenticationMethod: pulumi.Output<string[] | undefined>;
/**
* Client or app id registered with this authorization server.
*/
readonly clientId: pulumi.Output<string>;
/**
* Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
*/
readonly clientRegistrationEndpoint: pulumi.Output<string>;
/**
* Client or app secret registered with this authorization server. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
*/
readonly clientSecret: pulumi.Output<string | undefined>;
/**
* Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.
*/
readonly defaultScope: pulumi.Output<string | undefined>;
/**
* Description of the authorization server. Can contain HTML formatting tags.
*/
readonly description: pulumi.Output<string | undefined>;
/**
* User-friendly authorization server name.
*/
readonly displayName: pulumi.Output<string>;
/**
* Form of an authorization grant, which the client uses to request the access token.
*/
readonly grantTypes: pulumi.Output<string[]>;
/**
* The name of the resource
*/
readonly name: pulumi.Output<string>;
/**
* Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
*/
readonly resourceOwnerPassword: pulumi.Output<string | undefined>;
/**
* Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
*/
readonly resourceOwnerUsername: pulumi.Output<string | undefined>;
/**
* If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
*/
readonly supportState: pulumi.Output<boolean | undefined>;
/**
* Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}.
*/
readonly tokenBodyParameters: pulumi.Output<outputs.apimanagement.TokenBodyParameterContractResponse[] | undefined>;
/**
* OAuth token endpoint. Contains absolute URI to entity being referenced.
*/
readonly tokenEndpoint: pulumi.Output<string | undefined>;
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: pulumi.Output<string>;
/**
* If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided.
*/
readonly useInApiDocumentation: pulumi.Output<boolean | undefined>;
/**
* If true, the authorization server may be used in the developer portal test console. True by default if no value is provided.
*/
readonly useInTestConsole: pulumi.Output<boolean | undefined>;
/**
* Create a AuthorizationServer resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: AuthorizationServerArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a AuthorizationServer resource.
*/
export interface AuthorizationServerArgs {
/**
* OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
*/
authorizationEndpoint: pulumi.Input<string>;
/**
* HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
*/
authorizationMethods?: pulumi.Input<pulumi.Input<enums.apimanagement.AuthorizationMethod>[]>;
/**
* Identifier of the authorization server.
*/
authsid?: pulumi.Input<string>;
/**
* Specifies the mechanism by which access token is passed to the API.
*/
bearerTokenSendingMethods?: pulumi.Input<pulumi.Input<string | enums.apimanagement.BearerTokenSendingMethod>[]>;
/**
* Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format.
*/
clientAuthenticationMethod?: pulumi.Input<pulumi.Input<string | enums.apimanagement.ClientAuthenticationMethod>[]>;
/**
* Client or app id registered with this authorization server.
*/
clientId: pulumi.Input<string>;
/**
* Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
*/
clientRegistrationEndpoint: pulumi.Input<string>;
/**
* Client or app secret registered with this authorization server. This property will not be filled on 'GET' operations! Use '/listSecrets' POST request to get the value.
*/
clientSecret?: pulumi.Input<string>;
/**
* Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values.
*/
defaultScope?: pulumi.Input<string>;
/**
* Description of the authorization server. Can contain HTML formatting tags.
*/
description?: pulumi.Input<string>;
/**
* User-friendly authorization server name.
*/
displayName: pulumi.Input<string>;
/**
* Form of an authorization grant, which the client uses to request the access token.
*/
grantTypes: pulumi.Input<pulumi.Input<string | enums.apimanagement.GrantType>[]>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
*/
resourceOwnerPassword?: pulumi.Input<string>;
/**
* Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
*/
resourceOwnerUsername?: pulumi.Input<string>;
/**
* The name of the API Management service.
*/
serviceName: pulumi.Input<string>;
/**
* If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
*/
supportState?: pulumi.Input<boolean>;
/**
* Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}.
*/
tokenBodyParameters?: pulumi.Input<pulumi.Input<inputs.apimanagement.TokenBodyParameterContractArgs>[]>;
/**
* OAuth token endpoint. Contains absolute URI to entity being referenced.
*/
tokenEndpoint?: pulumi.Input<string>;
/**
* If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided.
*/
useInApiDocumentation?: pulumi.Input<boolean>;
/**
* If true, the authorization server may be used in the developer portal test console. True by default if no value is provided.
*/
useInTestConsole?: pulumi.Input<boolean>;
}