1. Packages
  2. Azure Classic
  3. API Docs
  4. apimanagement
  5. AuthorizationServer

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

azure.apimanagement.AuthorizationServer

Explore with Pulumi AI

azure logo

We recommend using Azure Native.

Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi

    Manages an Authorization Server within an API Management Service.

    Example Usage

    import * as pulumi from "@pulumi/pulumi";
    import * as azure from "@pulumi/azure";
    
    const example = azure.apimanagement.getService({
        name: "search-api",
        resourceGroupName: "search-service",
    });
    const exampleAuthorizationServer = new azure.apimanagement.AuthorizationServer("example", {
        name: "test-server",
        apiManagementName: example.then(example => example.name),
        resourceGroupName: example.then(example => example.resourceGroupName),
        displayName: "Test Server",
        authorizationEndpoint: "https://example.mydomain.com/client/authorize",
        clientId: "42424242-4242-4242-4242-424242424242",
        clientRegistrationEndpoint: "https://example.mydomain.com/client/register",
        grantTypes: ["authorizationCode"],
        authorizationMethods: ["GET"],
    });
    
    import pulumi
    import pulumi_azure as azure
    
    example = azure.apimanagement.get_service(name="search-api",
        resource_group_name="search-service")
    example_authorization_server = azure.apimanagement.AuthorizationServer("example",
        name="test-server",
        api_management_name=example.name,
        resource_group_name=example.resource_group_name,
        display_name="Test Server",
        authorization_endpoint="https://example.mydomain.com/client/authorize",
        client_id="42424242-4242-4242-4242-424242424242",
        client_registration_endpoint="https://example.mydomain.com/client/register",
        grant_types=["authorizationCode"],
        authorization_methods=["GET"])
    
    package main
    
    import (
    	"github.com/pulumi/pulumi-azure/sdk/v5/go/azure/apimanagement"
    	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
    )
    
    func main() {
    	pulumi.Run(func(ctx *pulumi.Context) error {
    		example, err := apimanagement.LookupService(ctx, &apimanagement.LookupServiceArgs{
    			Name:              "search-api",
    			ResourceGroupName: "search-service",
    		}, nil)
    		if err != nil {
    			return err
    		}
    		_, err = apimanagement.NewAuthorizationServer(ctx, "example", &apimanagement.AuthorizationServerArgs{
    			Name:                       pulumi.String("test-server"),
    			ApiManagementName:          pulumi.String(example.Name),
    			ResourceGroupName:          pulumi.String(example.ResourceGroupName),
    			DisplayName:                pulumi.String("Test Server"),
    			AuthorizationEndpoint:      pulumi.String("https://example.mydomain.com/client/authorize"),
    			ClientId:                   pulumi.String("42424242-4242-4242-4242-424242424242"),
    			ClientRegistrationEndpoint: pulumi.String("https://example.mydomain.com/client/register"),
    			GrantTypes: pulumi.StringArray{
    				pulumi.String("authorizationCode"),
    			},
    			AuthorizationMethods: pulumi.StringArray{
    				pulumi.String("GET"),
    			},
    		})
    		if err != nil {
    			return err
    		}
    		return nil
    	})
    }
    
    using System.Collections.Generic;
    using System.Linq;
    using Pulumi;
    using Azure = Pulumi.Azure;
    
    return await Deployment.RunAsync(() => 
    {
        var example = Azure.ApiManagement.GetService.Invoke(new()
        {
            Name = "search-api",
            ResourceGroupName = "search-service",
        });
    
        var exampleAuthorizationServer = new Azure.ApiManagement.AuthorizationServer("example", new()
        {
            Name = "test-server",
            ApiManagementName = example.Apply(getServiceResult => getServiceResult.Name),
            ResourceGroupName = example.Apply(getServiceResult => getServiceResult.ResourceGroupName),
            DisplayName = "Test Server",
            AuthorizationEndpoint = "https://example.mydomain.com/client/authorize",
            ClientId = "42424242-4242-4242-4242-424242424242",
            ClientRegistrationEndpoint = "https://example.mydomain.com/client/register",
            GrantTypes = new[]
            {
                "authorizationCode",
            },
            AuthorizationMethods = new[]
            {
                "GET",
            },
        });
    
    });
    
    package generated_program;
    
    import com.pulumi.Context;
    import com.pulumi.Pulumi;
    import com.pulumi.core.Output;
    import com.pulumi.azure.apimanagement.ApimanagementFunctions;
    import com.pulumi.azure.apimanagement.inputs.GetServiceArgs;
    import com.pulumi.azure.apimanagement.AuthorizationServer;
    import com.pulumi.azure.apimanagement.AuthorizationServerArgs;
    import java.util.List;
    import java.util.ArrayList;
    import java.util.Map;
    import java.io.File;
    import java.nio.file.Files;
    import java.nio.file.Paths;
    
    public class App {
        public static void main(String[] args) {
            Pulumi.run(App::stack);
        }
    
        public static void stack(Context ctx) {
            final var example = ApimanagementFunctions.getService(GetServiceArgs.builder()
                .name("search-api")
                .resourceGroupName("search-service")
                .build());
    
            var exampleAuthorizationServer = new AuthorizationServer("exampleAuthorizationServer", AuthorizationServerArgs.builder()
                .name("test-server")
                .apiManagementName(example.applyValue(getServiceResult -> getServiceResult.name()))
                .resourceGroupName(example.applyValue(getServiceResult -> getServiceResult.resourceGroupName()))
                .displayName("Test Server")
                .authorizationEndpoint("https://example.mydomain.com/client/authorize")
                .clientId("42424242-4242-4242-4242-424242424242")
                .clientRegistrationEndpoint("https://example.mydomain.com/client/register")
                .grantTypes("authorizationCode")
                .authorizationMethods("GET")
                .build());
    
        }
    }
    
    resources:
      exampleAuthorizationServer:
        type: azure:apimanagement:AuthorizationServer
        name: example
        properties:
          name: test-server
          apiManagementName: ${example.name}
          resourceGroupName: ${example.resourceGroupName}
          displayName: Test Server
          authorizationEndpoint: https://example.mydomain.com/client/authorize
          clientId: 42424242-4242-4242-4242-424242424242
          clientRegistrationEndpoint: https://example.mydomain.com/client/register
          grantTypes:
            - authorizationCode
          authorizationMethods:
            - GET
    variables:
      example:
        fn::invoke:
          Function: azure:apimanagement:getService
          Arguments:
            name: search-api
            resourceGroupName: search-service
    

    Create AuthorizationServer Resource

    Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.

    Constructor syntax

    new AuthorizationServer(name: string, args: AuthorizationServerArgs, opts?: CustomResourceOptions);
    @overload
    def AuthorizationServer(resource_name: str,
                            args: AuthorizationServerArgs,
                            opts: Optional[ResourceOptions] = None)
    
    @overload
    def AuthorizationServer(resource_name: str,
                            opts: Optional[ResourceOptions] = None,
                            api_management_name: Optional[str] = None,
                            authorization_endpoint: Optional[str] = None,
                            authorization_methods: Optional[Sequence[str]] = None,
                            resource_group_name: Optional[str] = None,
                            grant_types: Optional[Sequence[str]] = None,
                            client_id: Optional[str] = None,
                            client_registration_endpoint: Optional[str] = None,
                            display_name: Optional[str] = None,
                            default_scope: Optional[str] = None,
                            description: Optional[str] = None,
                            client_secret: Optional[str] = None,
                            client_authentication_methods: Optional[Sequence[str]] = None,
                            name: Optional[str] = None,
                            bearer_token_sending_methods: Optional[Sequence[str]] = None,
                            resource_owner_password: Optional[str] = None,
                            resource_owner_username: Optional[str] = None,
                            support_state: Optional[bool] = None,
                            token_body_parameters: Optional[Sequence[AuthorizationServerTokenBodyParameterArgs]] = None,
                            token_endpoint: Optional[str] = None)
    func NewAuthorizationServer(ctx *Context, name string, args AuthorizationServerArgs, opts ...ResourceOption) (*AuthorizationServer, error)
    public AuthorizationServer(string name, AuthorizationServerArgs args, CustomResourceOptions? opts = null)
    public AuthorizationServer(String name, AuthorizationServerArgs args)
    public AuthorizationServer(String name, AuthorizationServerArgs args, CustomResourceOptions options)
    
    type: azure:apimanagement:AuthorizationServer
    properties: # The arguments to resource properties.
    options: # Bag of options to control resource's behavior.
    
    

    Parameters

    name string
    The unique name of the resource.
    args AuthorizationServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    resource_name str
    The unique name of the resource.
    args AuthorizationServerArgs
    The arguments to resource properties.
    opts ResourceOptions
    Bag of options to control resource's behavior.
    ctx Context
    Context object for the current deployment.
    name string
    The unique name of the resource.
    args AuthorizationServerArgs
    The arguments to resource properties.
    opts ResourceOption
    Bag of options to control resource's behavior.
    name string
    The unique name of the resource.
    args AuthorizationServerArgs
    The arguments to resource properties.
    opts CustomResourceOptions
    Bag of options to control resource's behavior.
    name String
    The unique name of the resource.
    args AuthorizationServerArgs
    The arguments to resource properties.
    options CustomResourceOptions
    Bag of options to control resource's behavior.

    Example

    The following reference example uses placeholder values for all input properties.

    var authorizationServerResource = new Azure.ApiManagement.AuthorizationServer("authorizationServerResource", new()
    {
        ApiManagementName = "string",
        AuthorizationEndpoint = "string",
        AuthorizationMethods = new[]
        {
            "string",
        },
        ResourceGroupName = "string",
        GrantTypes = new[]
        {
            "string",
        },
        ClientId = "string",
        ClientRegistrationEndpoint = "string",
        DisplayName = "string",
        DefaultScope = "string",
        Description = "string",
        ClientSecret = "string",
        ClientAuthenticationMethods = new[]
        {
            "string",
        },
        Name = "string",
        BearerTokenSendingMethods = new[]
        {
            "string",
        },
        ResourceOwnerPassword = "string",
        ResourceOwnerUsername = "string",
        SupportState = false,
        TokenBodyParameters = new[]
        {
            new Azure.ApiManagement.Inputs.AuthorizationServerTokenBodyParameterArgs
            {
                Name = "string",
                Value = "string",
            },
        },
        TokenEndpoint = "string",
    });
    
    example, err := apimanagement.NewAuthorizationServer(ctx, "authorizationServerResource", &apimanagement.AuthorizationServerArgs{
    	ApiManagementName:     pulumi.String("string"),
    	AuthorizationEndpoint: pulumi.String("string"),
    	AuthorizationMethods: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ResourceGroupName: pulumi.String("string"),
    	GrantTypes: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ClientId:                   pulumi.String("string"),
    	ClientRegistrationEndpoint: pulumi.String("string"),
    	DisplayName:                pulumi.String("string"),
    	DefaultScope:               pulumi.String("string"),
    	Description:                pulumi.String("string"),
    	ClientSecret:               pulumi.String("string"),
    	ClientAuthenticationMethods: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	Name: pulumi.String("string"),
    	BearerTokenSendingMethods: pulumi.StringArray{
    		pulumi.String("string"),
    	},
    	ResourceOwnerPassword: pulumi.String("string"),
    	ResourceOwnerUsername: pulumi.String("string"),
    	SupportState:          pulumi.Bool(false),
    	TokenBodyParameters: apimanagement.AuthorizationServerTokenBodyParameterArray{
    		&apimanagement.AuthorizationServerTokenBodyParameterArgs{
    			Name:  pulumi.String("string"),
    			Value: pulumi.String("string"),
    		},
    	},
    	TokenEndpoint: pulumi.String("string"),
    })
    
    var authorizationServerResource = new AuthorizationServer("authorizationServerResource", AuthorizationServerArgs.builder()
        .apiManagementName("string")
        .authorizationEndpoint("string")
        .authorizationMethods("string")
        .resourceGroupName("string")
        .grantTypes("string")
        .clientId("string")
        .clientRegistrationEndpoint("string")
        .displayName("string")
        .defaultScope("string")
        .description("string")
        .clientSecret("string")
        .clientAuthenticationMethods("string")
        .name("string")
        .bearerTokenSendingMethods("string")
        .resourceOwnerPassword("string")
        .resourceOwnerUsername("string")
        .supportState(false)
        .tokenBodyParameters(AuthorizationServerTokenBodyParameterArgs.builder()
            .name("string")
            .value("string")
            .build())
        .tokenEndpoint("string")
        .build());
    
    authorization_server_resource = azure.apimanagement.AuthorizationServer("authorizationServerResource",
        api_management_name="string",
        authorization_endpoint="string",
        authorization_methods=["string"],
        resource_group_name="string",
        grant_types=["string"],
        client_id="string",
        client_registration_endpoint="string",
        display_name="string",
        default_scope="string",
        description="string",
        client_secret="string",
        client_authentication_methods=["string"],
        name="string",
        bearer_token_sending_methods=["string"],
        resource_owner_password="string",
        resource_owner_username="string",
        support_state=False,
        token_body_parameters=[azure.apimanagement.AuthorizationServerTokenBodyParameterArgs(
            name="string",
            value="string",
        )],
        token_endpoint="string")
    
    const authorizationServerResource = new azure.apimanagement.AuthorizationServer("authorizationServerResource", {
        apiManagementName: "string",
        authorizationEndpoint: "string",
        authorizationMethods: ["string"],
        resourceGroupName: "string",
        grantTypes: ["string"],
        clientId: "string",
        clientRegistrationEndpoint: "string",
        displayName: "string",
        defaultScope: "string",
        description: "string",
        clientSecret: "string",
        clientAuthenticationMethods: ["string"],
        name: "string",
        bearerTokenSendingMethods: ["string"],
        resourceOwnerPassword: "string",
        resourceOwnerUsername: "string",
        supportState: false,
        tokenBodyParameters: [{
            name: "string",
            value: "string",
        }],
        tokenEndpoint: "string",
    });
    
    type: azure:apimanagement:AuthorizationServer
    properties:
        apiManagementName: string
        authorizationEndpoint: string
        authorizationMethods:
            - string
        bearerTokenSendingMethods:
            - string
        clientAuthenticationMethods:
            - string
        clientId: string
        clientRegistrationEndpoint: string
        clientSecret: string
        defaultScope: string
        description: string
        displayName: string
        grantTypes:
            - string
        name: string
        resourceGroupName: string
        resourceOwnerPassword: string
        resourceOwnerUsername: string
        supportState: false
        tokenBodyParameters:
            - name: string
              value: string
        tokenEndpoint: string
    

    AuthorizationServer Resource Properties

    To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

    Inputs

    The AuthorizationServer resource accepts the following input properties:

    ApiManagementName string
    The name of the API Management Service in which this Authorization Server should be created. Changing this forces a new resource to be created.
    AuthorizationEndpoint string
    The OAUTH Authorization Endpoint.
    AuthorizationMethods List<string>

    The HTTP Verbs supported by the Authorization Endpoint. Possible values are DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT and TRACE.

    NOTE: GET must always be present.

    ClientId string
    The Client/App ID registered with this Authorization Server.
    ClientRegistrationEndpoint string
    The URI of page where Client/App Registration is performed for this Authorization Server.
    DisplayName string
    The user-friendly name of this Authorization Server.
    GrantTypes List<string>
    Form of Authorization Grants required when requesting an Access Token. Possible values are authorizationCode, clientCredentials, implicit and resourceOwnerPassword.
    ResourceGroupName string
    The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
    BearerTokenSendingMethods List<string>
    The mechanism by which Access Tokens are passed to the API. Possible values are authorizationHeader and query.
    ClientAuthenticationMethods List<string>
    The Authentication Methods supported by the Token endpoint of this Authorization Server.. Possible values are Basic and Body.
    ClientSecret string
    The Client/App Secret registered with this Authorization Server.
    DefaultScope string
    The Default Scope used when requesting an Access Token, specified as a string containing space-delimited values.
    Description string
    A description of the Authorization Server, which may contain HTML formatting tags.
    Name string
    The name of this Authorization Server. Changing this forces a new resource to be created.
    ResourceOwnerPassword string

    The password associated with the Resource Owner.

    NOTE: This can only be specified when grant_type includes resourceOwnerPassword.

    ResourceOwnerUsername string

    The username associated with the Resource Owner.

    NOTE: This can only be specified when grant_type includes resourceOwnerPassword.

    SupportState bool
    Does this Authorization Server support State? If this is set to true the client may use the state parameter to raise protocol security.
    TokenBodyParameters List<AuthorizationServerTokenBodyParameter>
    A token_body_parameter block as defined below.
    TokenEndpoint string
    The OAUTH Token Endpoint.
    ApiManagementName string
    The name of the API Management Service in which this Authorization Server should be created. Changing this forces a new resource to be created.
    AuthorizationEndpoint string
    The OAUTH Authorization Endpoint.
    AuthorizationMethods []string

    The HTTP Verbs supported by the Authorization Endpoint. Possible values are DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT and TRACE.

    NOTE: GET must always be present.

    ClientId string
    The Client/App ID registered with this Authorization Server.
    ClientRegistrationEndpoint string
    The URI of page where Client/App Registration is performed for this Authorization Server.
    DisplayName string
    The user-friendly name of this Authorization Server.
    GrantTypes []string
    Form of Authorization Grants required when requesting an Access Token. Possible values are authorizationCode, clientCredentials, implicit and resourceOwnerPassword.
    ResourceGroupName string
    The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
    BearerTokenSendingMethods []string
    The mechanism by which Access Tokens are passed to the API. Possible values are authorizationHeader and query.
    ClientAuthenticationMethods []string
    The Authentication Methods supported by the Token endpoint of this Authorization Server.. Possible values are Basic and Body.
    ClientSecret string
    The Client/App Secret registered with this Authorization Server.
    DefaultScope string
    The Default Scope used when requesting an Access Token, specified as a string containing space-delimited values.
    Description string
    A description of the Authorization Server, which may contain HTML formatting tags.
    Name string
    The name of this Authorization Server. Changing this forces a new resource to be created.
    ResourceOwnerPassword string

    The password associated with the Resource Owner.

    NOTE: This can only be specified when grant_type includes resourceOwnerPassword.

    ResourceOwnerUsername string

    The username associated with the Resource Owner.

    NOTE: This can only be specified when grant_type includes resourceOwnerPassword.

    SupportState bool
    Does this Authorization Server support State? If this is set to true the client may use the state parameter to raise protocol security.
    TokenBodyParameters []AuthorizationServerTokenBodyParameterArgs
    A token_body_parameter block as defined below.
    TokenEndpoint string
    The OAUTH Token Endpoint.
    apiManagementName String
    The name of the API Management Service in which this Authorization Server should be created. Changing this forces a new resource to be created.
    authorizationEndpoint String
    The OAUTH Authorization Endpoint.
    authorizationMethods List<String>

    The HTTP Verbs supported by the Authorization Endpoint. Possible values are DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT and TRACE.

    NOTE: GET must always be present.

    clientId String
    The Client/App ID registered with this Authorization Server.
    clientRegistrationEndpoint String
    The URI of page where Client/App Registration is performed for this Authorization Server.
    displayName String
    The user-friendly name of this Authorization Server.
    grantTypes List<String>
    Form of Authorization Grants required when requesting an Access Token. Possible values are authorizationCode, clientCredentials, implicit and resourceOwnerPassword.
    resourceGroupName String
    The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
    bearerTokenSendingMethods List<String>
    The mechanism by which Access Tokens are passed to the API. Possible values are authorizationHeader and query.
    clientAuthenticationMethods List<String>
    The Authentication Methods supported by the Token endpoint of this Authorization Server.. Possible values are Basic and Body.
    clientSecret String
    The Client/App Secret registered with this Authorization Server.
    defaultScope String
    The Default Scope used when requesting an Access Token, specified as a string containing space-delimited values.
    description String
    A description of the Authorization Server, which may contain HTML formatting tags.
    name String
    The name of this Authorization Server. Changing this forces a new resource to be created.
    resourceOwnerPassword String

    The password associated with the Resource Owner.

    NOTE: This can only be specified when grant_type includes resourceOwnerPassword.

    resourceOwnerUsername String

    The username associated with the Resource Owner.

    NOTE: This can only be specified when grant_type includes resourceOwnerPassword.

    supportState Boolean
    Does this Authorization Server support State? If this is set to true the client may use the state parameter to raise protocol security.
    tokenBodyParameters List<AuthorizationServerTokenBodyParameter>
    A token_body_parameter block as defined below.
    tokenEndpoint String
    The OAUTH Token Endpoint.
    apiManagementName string
    The name of the API Management Service in which this Authorization Server should be created. Changing this forces a new resource to be created.
    authorizationEndpoint string
    The OAUTH Authorization Endpoint.
    authorizationMethods string[]

    The HTTP Verbs supported by the Authorization Endpoint. Possible values are DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT and TRACE.

    NOTE: GET must always be present.

    clientId string
    The Client/App ID registered with this Authorization Server.
    clientRegistrationEndpoint string
    The URI of page where Client/App Registration is performed for this Authorization Server.
    displayName string
    The user-friendly name of this Authorization Server.
    grantTypes string[]
    Form of Authorization Grants required when requesting an Access Token. Possible values are authorizationCode, clientCredentials, implicit and resourceOwnerPassword.
    resourceGroupName string
    The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
    bearerTokenSendingMethods string[]
    The mechanism by which Access Tokens are passed to the API. Possible values are authorizationHeader and query.
    clientAuthenticationMethods string[]
    The Authentication Methods supported by the Token endpoint of this Authorization Server.. Possible values are Basic and Body.
    clientSecret string
    The Client/App Secret registered with this Authorization Server.
    defaultScope string
    The Default Scope used when requesting an Access Token, specified as a string containing space-delimited values.
    description string
    A description of the Authorization Server, which may contain HTML formatting tags.
    name string
    The name of this Authorization Server. Changing this forces a new resource to be created.
    resourceOwnerPassword string

    The password associated with the Resource Owner.

    NOTE: This can only be specified when grant_type includes resourceOwnerPassword.

    resourceOwnerUsername string

    The username associated with the Resource Owner.

    NOTE: This can only be specified when grant_type includes resourceOwnerPassword.

    supportState boolean
    Does this Authorization Server support State? If this is set to true the client may use the state parameter to raise protocol security.
    tokenBodyParameters AuthorizationServerTokenBodyParameter[]
    A token_body_parameter block as defined below.
    tokenEndpoint string
    The OAUTH Token Endpoint.
    api_management_name str
    The name of the API Management Service in which this Authorization Server should be created. Changing this forces a new resource to be created.
    authorization_endpoint str
    The OAUTH Authorization Endpoint.
    authorization_methods Sequence[str]

    The HTTP Verbs supported by the Authorization Endpoint. Possible values are DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT and TRACE.

    NOTE: GET must always be present.

    client_id str
    The Client/App ID registered with this Authorization Server.
    client_registration_endpoint str
    The URI of page where Client/App Registration is performed for this Authorization Server.
    display_name str
    The user-friendly name of this Authorization Server.
    grant_types Sequence[str]
    Form of Authorization Grants required when requesting an Access Token. Possible values are authorizationCode, clientCredentials, implicit and resourceOwnerPassword.
    resource_group_name str
    The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
    bearer_token_sending_methods Sequence[str]
    The mechanism by which Access Tokens are passed to the API. Possible values are authorizationHeader and query.
    client_authentication_methods Sequence[str]
    The Authentication Methods supported by the Token endpoint of this Authorization Server.. Possible values are Basic and Body.
    client_secret str
    The Client/App Secret registered with this Authorization Server.
    default_scope str
    The Default Scope used when requesting an Access Token, specified as a string containing space-delimited values.
    description str
    A description of the Authorization Server, which may contain HTML formatting tags.
    name str
    The name of this Authorization Server. Changing this forces a new resource to be created.
    resource_owner_password str

    The password associated with the Resource Owner.

    NOTE: This can only be specified when grant_type includes resourceOwnerPassword.

    resource_owner_username str

    The username associated with the Resource Owner.

    NOTE: This can only be specified when grant_type includes resourceOwnerPassword.

    support_state bool
    Does this Authorization Server support State? If this is set to true the client may use the state parameter to raise protocol security.
    token_body_parameters Sequence[AuthorizationServerTokenBodyParameterArgs]
    A token_body_parameter block as defined below.
    token_endpoint str
    The OAUTH Token Endpoint.
    apiManagementName String
    The name of the API Management Service in which this Authorization Server should be created. Changing this forces a new resource to be created.
    authorizationEndpoint String
    The OAUTH Authorization Endpoint.
    authorizationMethods List<String>

    The HTTP Verbs supported by the Authorization Endpoint. Possible values are DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT and TRACE.

    NOTE: GET must always be present.

    clientId String
    The Client/App ID registered with this Authorization Server.
    clientRegistrationEndpoint String
    The URI of page where Client/App Registration is performed for this Authorization Server.
    displayName String
    The user-friendly name of this Authorization Server.
    grantTypes List<String>
    Form of Authorization Grants required when requesting an Access Token. Possible values are authorizationCode, clientCredentials, implicit and resourceOwnerPassword.
    resourceGroupName String
    The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
    bearerTokenSendingMethods List<String>
    The mechanism by which Access Tokens are passed to the API. Possible values are authorizationHeader and query.
    clientAuthenticationMethods List<String>
    The Authentication Methods supported by the Token endpoint of this Authorization Server.. Possible values are Basic and Body.
    clientSecret String
    The Client/App Secret registered with this Authorization Server.
    defaultScope String
    The Default Scope used when requesting an Access Token, specified as a string containing space-delimited values.
    description String
    A description of the Authorization Server, which may contain HTML formatting tags.
    name String
    The name of this Authorization Server. Changing this forces a new resource to be created.
    resourceOwnerPassword String

    The password associated with the Resource Owner.

    NOTE: This can only be specified when grant_type includes resourceOwnerPassword.

    resourceOwnerUsername String

    The username associated with the Resource Owner.

    NOTE: This can only be specified when grant_type includes resourceOwnerPassword.

    supportState Boolean
    Does this Authorization Server support State? If this is set to true the client may use the state parameter to raise protocol security.
    tokenBodyParameters List<Property Map>
    A token_body_parameter block as defined below.
    tokenEndpoint String
    The OAUTH Token Endpoint.

    Outputs

    All input properties are implicitly available as output properties. Additionally, the AuthorizationServer resource produces the following output properties:

    Id string
    The provider-assigned unique ID for this managed resource.
    Id string
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.
    id string
    The provider-assigned unique ID for this managed resource.
    id str
    The provider-assigned unique ID for this managed resource.
    id String
    The provider-assigned unique ID for this managed resource.

    Look up Existing AuthorizationServer Resource

    Get an existing AuthorizationServer resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

    public static get(name: string, id: Input<ID>, state?: AuthorizationServerState, opts?: CustomResourceOptions): AuthorizationServer
    @staticmethod
    def get(resource_name: str,
            id: str,
            opts: Optional[ResourceOptions] = None,
            api_management_name: Optional[str] = None,
            authorization_endpoint: Optional[str] = None,
            authorization_methods: Optional[Sequence[str]] = None,
            bearer_token_sending_methods: Optional[Sequence[str]] = None,
            client_authentication_methods: Optional[Sequence[str]] = None,
            client_id: Optional[str] = None,
            client_registration_endpoint: Optional[str] = None,
            client_secret: Optional[str] = None,
            default_scope: Optional[str] = None,
            description: Optional[str] = None,
            display_name: Optional[str] = None,
            grant_types: Optional[Sequence[str]] = None,
            name: Optional[str] = None,
            resource_group_name: Optional[str] = None,
            resource_owner_password: Optional[str] = None,
            resource_owner_username: Optional[str] = None,
            support_state: Optional[bool] = None,
            token_body_parameters: Optional[Sequence[AuthorizationServerTokenBodyParameterArgs]] = None,
            token_endpoint: Optional[str] = None) -> AuthorizationServer
    func GetAuthorizationServer(ctx *Context, name string, id IDInput, state *AuthorizationServerState, opts ...ResourceOption) (*AuthorizationServer, error)
    public static AuthorizationServer Get(string name, Input<string> id, AuthorizationServerState? state, CustomResourceOptions? opts = null)
    public static AuthorizationServer get(String name, Output<String> id, AuthorizationServerState state, CustomResourceOptions options)
    Resource lookup is not supported in YAML
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    resource_name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    name
    The unique name of the resulting resource.
    id
    The unique provider ID of the resource to lookup.
    state
    Any extra arguments used during the lookup.
    opts
    A bag of options that control this resource's behavior.
    The following state arguments are supported:
    ApiManagementName string
    The name of the API Management Service in which this Authorization Server should be created. Changing this forces a new resource to be created.
    AuthorizationEndpoint string
    The OAUTH Authorization Endpoint.
    AuthorizationMethods List<string>

    The HTTP Verbs supported by the Authorization Endpoint. Possible values are DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT and TRACE.

    NOTE: GET must always be present.

    BearerTokenSendingMethods List<string>
    The mechanism by which Access Tokens are passed to the API. Possible values are authorizationHeader and query.
    ClientAuthenticationMethods List<string>
    The Authentication Methods supported by the Token endpoint of this Authorization Server.. Possible values are Basic and Body.
    ClientId string
    The Client/App ID registered with this Authorization Server.
    ClientRegistrationEndpoint string
    The URI of page where Client/App Registration is performed for this Authorization Server.
    ClientSecret string
    The Client/App Secret registered with this Authorization Server.
    DefaultScope string
    The Default Scope used when requesting an Access Token, specified as a string containing space-delimited values.
    Description string
    A description of the Authorization Server, which may contain HTML formatting tags.
    DisplayName string
    The user-friendly name of this Authorization Server.
    GrantTypes List<string>
    Form of Authorization Grants required when requesting an Access Token. Possible values are authorizationCode, clientCredentials, implicit and resourceOwnerPassword.
    Name string
    The name of this Authorization Server. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
    ResourceOwnerPassword string

    The password associated with the Resource Owner.

    NOTE: This can only be specified when grant_type includes resourceOwnerPassword.

    ResourceOwnerUsername string

    The username associated with the Resource Owner.

    NOTE: This can only be specified when grant_type includes resourceOwnerPassword.

    SupportState bool
    Does this Authorization Server support State? If this is set to true the client may use the state parameter to raise protocol security.
    TokenBodyParameters List<AuthorizationServerTokenBodyParameter>
    A token_body_parameter block as defined below.
    TokenEndpoint string
    The OAUTH Token Endpoint.
    ApiManagementName string
    The name of the API Management Service in which this Authorization Server should be created. Changing this forces a new resource to be created.
    AuthorizationEndpoint string
    The OAUTH Authorization Endpoint.
    AuthorizationMethods []string

    The HTTP Verbs supported by the Authorization Endpoint. Possible values are DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT and TRACE.

    NOTE: GET must always be present.

    BearerTokenSendingMethods []string
    The mechanism by which Access Tokens are passed to the API. Possible values are authorizationHeader and query.
    ClientAuthenticationMethods []string
    The Authentication Methods supported by the Token endpoint of this Authorization Server.. Possible values are Basic and Body.
    ClientId string
    The Client/App ID registered with this Authorization Server.
    ClientRegistrationEndpoint string
    The URI of page where Client/App Registration is performed for this Authorization Server.
    ClientSecret string
    The Client/App Secret registered with this Authorization Server.
    DefaultScope string
    The Default Scope used when requesting an Access Token, specified as a string containing space-delimited values.
    Description string
    A description of the Authorization Server, which may contain HTML formatting tags.
    DisplayName string
    The user-friendly name of this Authorization Server.
    GrantTypes []string
    Form of Authorization Grants required when requesting an Access Token. Possible values are authorizationCode, clientCredentials, implicit and resourceOwnerPassword.
    Name string
    The name of this Authorization Server. Changing this forces a new resource to be created.
    ResourceGroupName string
    The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
    ResourceOwnerPassword string

    The password associated with the Resource Owner.

    NOTE: This can only be specified when grant_type includes resourceOwnerPassword.

    ResourceOwnerUsername string

    The username associated with the Resource Owner.

    NOTE: This can only be specified when grant_type includes resourceOwnerPassword.

    SupportState bool
    Does this Authorization Server support State? If this is set to true the client may use the state parameter to raise protocol security.
    TokenBodyParameters []AuthorizationServerTokenBodyParameterArgs
    A token_body_parameter block as defined below.
    TokenEndpoint string
    The OAUTH Token Endpoint.
    apiManagementName String
    The name of the API Management Service in which this Authorization Server should be created. Changing this forces a new resource to be created.
    authorizationEndpoint String
    The OAUTH Authorization Endpoint.
    authorizationMethods List<String>

    The HTTP Verbs supported by the Authorization Endpoint. Possible values are DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT and TRACE.

    NOTE: GET must always be present.

    bearerTokenSendingMethods List<String>
    The mechanism by which Access Tokens are passed to the API. Possible values are authorizationHeader and query.
    clientAuthenticationMethods List<String>
    The Authentication Methods supported by the Token endpoint of this Authorization Server.. Possible values are Basic and Body.
    clientId String
    The Client/App ID registered with this Authorization Server.
    clientRegistrationEndpoint String
    The URI of page where Client/App Registration is performed for this Authorization Server.
    clientSecret String
    The Client/App Secret registered with this Authorization Server.
    defaultScope String
    The Default Scope used when requesting an Access Token, specified as a string containing space-delimited values.
    description String
    A description of the Authorization Server, which may contain HTML formatting tags.
    displayName String
    The user-friendly name of this Authorization Server.
    grantTypes List<String>
    Form of Authorization Grants required when requesting an Access Token. Possible values are authorizationCode, clientCredentials, implicit and resourceOwnerPassword.
    name String
    The name of this Authorization Server. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
    resourceOwnerPassword String

    The password associated with the Resource Owner.

    NOTE: This can only be specified when grant_type includes resourceOwnerPassword.

    resourceOwnerUsername String

    The username associated with the Resource Owner.

    NOTE: This can only be specified when grant_type includes resourceOwnerPassword.

    supportState Boolean
    Does this Authorization Server support State? If this is set to true the client may use the state parameter to raise protocol security.
    tokenBodyParameters List<AuthorizationServerTokenBodyParameter>
    A token_body_parameter block as defined below.
    tokenEndpoint String
    The OAUTH Token Endpoint.
    apiManagementName string
    The name of the API Management Service in which this Authorization Server should be created. Changing this forces a new resource to be created.
    authorizationEndpoint string
    The OAUTH Authorization Endpoint.
    authorizationMethods string[]

    The HTTP Verbs supported by the Authorization Endpoint. Possible values are DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT and TRACE.

    NOTE: GET must always be present.

    bearerTokenSendingMethods string[]
    The mechanism by which Access Tokens are passed to the API. Possible values are authorizationHeader and query.
    clientAuthenticationMethods string[]
    The Authentication Methods supported by the Token endpoint of this Authorization Server.. Possible values are Basic and Body.
    clientId string
    The Client/App ID registered with this Authorization Server.
    clientRegistrationEndpoint string
    The URI of page where Client/App Registration is performed for this Authorization Server.
    clientSecret string
    The Client/App Secret registered with this Authorization Server.
    defaultScope string
    The Default Scope used when requesting an Access Token, specified as a string containing space-delimited values.
    description string
    A description of the Authorization Server, which may contain HTML formatting tags.
    displayName string
    The user-friendly name of this Authorization Server.
    grantTypes string[]
    Form of Authorization Grants required when requesting an Access Token. Possible values are authorizationCode, clientCredentials, implicit and resourceOwnerPassword.
    name string
    The name of this Authorization Server. Changing this forces a new resource to be created.
    resourceGroupName string
    The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
    resourceOwnerPassword string

    The password associated with the Resource Owner.

    NOTE: This can only be specified when grant_type includes resourceOwnerPassword.

    resourceOwnerUsername string

    The username associated with the Resource Owner.

    NOTE: This can only be specified when grant_type includes resourceOwnerPassword.

    supportState boolean
    Does this Authorization Server support State? If this is set to true the client may use the state parameter to raise protocol security.
    tokenBodyParameters AuthorizationServerTokenBodyParameter[]
    A token_body_parameter block as defined below.
    tokenEndpoint string
    The OAUTH Token Endpoint.
    api_management_name str
    The name of the API Management Service in which this Authorization Server should be created. Changing this forces a new resource to be created.
    authorization_endpoint str
    The OAUTH Authorization Endpoint.
    authorization_methods Sequence[str]

    The HTTP Verbs supported by the Authorization Endpoint. Possible values are DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT and TRACE.

    NOTE: GET must always be present.

    bearer_token_sending_methods Sequence[str]
    The mechanism by which Access Tokens are passed to the API. Possible values are authorizationHeader and query.
    client_authentication_methods Sequence[str]
    The Authentication Methods supported by the Token endpoint of this Authorization Server.. Possible values are Basic and Body.
    client_id str
    The Client/App ID registered with this Authorization Server.
    client_registration_endpoint str
    The URI of page where Client/App Registration is performed for this Authorization Server.
    client_secret str
    The Client/App Secret registered with this Authorization Server.
    default_scope str
    The Default Scope used when requesting an Access Token, specified as a string containing space-delimited values.
    description str
    A description of the Authorization Server, which may contain HTML formatting tags.
    display_name str
    The user-friendly name of this Authorization Server.
    grant_types Sequence[str]
    Form of Authorization Grants required when requesting an Access Token. Possible values are authorizationCode, clientCredentials, implicit and resourceOwnerPassword.
    name str
    The name of this Authorization Server. Changing this forces a new resource to be created.
    resource_group_name str
    The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
    resource_owner_password str

    The password associated with the Resource Owner.

    NOTE: This can only be specified when grant_type includes resourceOwnerPassword.

    resource_owner_username str

    The username associated with the Resource Owner.

    NOTE: This can only be specified when grant_type includes resourceOwnerPassword.

    support_state bool
    Does this Authorization Server support State? If this is set to true the client may use the state parameter to raise protocol security.
    token_body_parameters Sequence[AuthorizationServerTokenBodyParameterArgs]
    A token_body_parameter block as defined below.
    token_endpoint str
    The OAUTH Token Endpoint.
    apiManagementName String
    The name of the API Management Service in which this Authorization Server should be created. Changing this forces a new resource to be created.
    authorizationEndpoint String
    The OAUTH Authorization Endpoint.
    authorizationMethods List<String>

    The HTTP Verbs supported by the Authorization Endpoint. Possible values are DELETE, GET, HEAD, OPTIONS, PATCH, POST, PUT and TRACE.

    NOTE: GET must always be present.

    bearerTokenSendingMethods List<String>
    The mechanism by which Access Tokens are passed to the API. Possible values are authorizationHeader and query.
    clientAuthenticationMethods List<String>
    The Authentication Methods supported by the Token endpoint of this Authorization Server.. Possible values are Basic and Body.
    clientId String
    The Client/App ID registered with this Authorization Server.
    clientRegistrationEndpoint String
    The URI of page where Client/App Registration is performed for this Authorization Server.
    clientSecret String
    The Client/App Secret registered with this Authorization Server.
    defaultScope String
    The Default Scope used when requesting an Access Token, specified as a string containing space-delimited values.
    description String
    A description of the Authorization Server, which may contain HTML formatting tags.
    displayName String
    The user-friendly name of this Authorization Server.
    grantTypes List<String>
    Form of Authorization Grants required when requesting an Access Token. Possible values are authorizationCode, clientCredentials, implicit and resourceOwnerPassword.
    name String
    The name of this Authorization Server. Changing this forces a new resource to be created.
    resourceGroupName String
    The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.
    resourceOwnerPassword String

    The password associated with the Resource Owner.

    NOTE: This can only be specified when grant_type includes resourceOwnerPassword.

    resourceOwnerUsername String

    The username associated with the Resource Owner.

    NOTE: This can only be specified when grant_type includes resourceOwnerPassword.

    supportState Boolean
    Does this Authorization Server support State? If this is set to true the client may use the state parameter to raise protocol security.
    tokenBodyParameters List<Property Map>
    A token_body_parameter block as defined below.
    tokenEndpoint String
    The OAUTH Token Endpoint.

    Supporting Types

    AuthorizationServerTokenBodyParameter, AuthorizationServerTokenBodyParameterArgs

    Name string
    The Name of the Parameter.
    Value string
    The Value of the Parameter.
    Name string
    The Name of the Parameter.
    Value string
    The Value of the Parameter.
    name String
    The Name of the Parameter.
    value String
    The Value of the Parameter.
    name string
    The Name of the Parameter.
    value string
    The Value of the Parameter.
    name str
    The Name of the Parameter.
    value str
    The Value of the Parameter.
    name String
    The Name of the Parameter.
    value String
    The Value of the Parameter.

    Import

    API Management Authorization Servers can be imported using the resource id, e.g.

    $ pulumi import azure:apimanagement/authorizationServer:AuthorizationServer example /subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/group1/providers/Microsoft.ApiManagement/service/service1/authorizationServers/server1
    

    To learn more about importing existing cloud resources, see Importing resources.

    Package Details

    Repository
    Azure Classic pulumi/pulumi-azure
    License
    Apache-2.0
    Notes
    This Pulumi package is based on the azurerm Terraform Provider.
    azure logo

    We recommend using Azure Native.

    Azure Classic v5.80.0 published on Monday, Jun 10, 2024 by Pulumi