Class AuthorizationServer

Manages an Authorization Server within an API Management Service.

Example Usage

using Pulumi;
using Azure = Pulumi.Azure;

class MyStack : Stack
{
public MyStack()
{
    var exampleApi = Output.Create(Azure.ApiManagement.GetApi.InvokeAsync(new Azure.ApiManagement.GetApiArgs
    {
        Name = "search-api",
        ApiManagementName = "search-api-management",
        ResourceGroupName = "search-service",
        Revision = "2",
    }));
    var exampleAuthorizationServer = new Azure.ApiManagement.AuthorizationServer("exampleAuthorizationServer", new Azure.ApiManagement.AuthorizationServerArgs
    {
        ApiManagementName = data.Azurerm_api_management.Example.Name,
        ResourceGroupName = data.Azurerm_api_management.Example.Resource_group_name,
        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",
        },
    });
}

}

Inheritance

System.Object

Resource

CustomResource

AuthorizationServer

Inherited Members

CustomResource.Id

Resource.GetResourceType()

Resource.GetResourceName()

Resource.Urn

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: Pulumi.Azure.ApiManagement

Assembly: Pulumi.Azure.dll

Syntax

public class AuthorizationServer : CustomResource

Constructors

AuthorizationServer(String, AuthorizationServerArgs, CustomResourceOptions)

Create a AuthorizationServer resource with the given unique name, arguments, and options.

Declaration

public AuthorizationServer(string name, AuthorizationServerArgs args, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resource
AuthorizationServerArgs	args	The arguments used to populate this resource's properties
CustomResourceOptions	options	A bag of options that control this resource's behavior

Properties

ApiManagementName

The name of the API Management Service in which this Authorization Server should be created. Changing this forces a new resource to be created.

Declaration

public Output<string> ApiManagementName { get; }

Property Value

Type	Description
Output<System.String>

AuthorizationEndpoint

The OAUTH Authorization Endpoint.

Declaration

public Output<string> AuthorizationEndpoint { get; }

Property Value

Type	Description
Output<System.String>

AuthorizationMethods

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

Declaration

public Output<ImmutableArray<string>> AuthorizationMethods { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

BearerTokenSendingMethods

The mechanism by which Access Tokens are passed to the API. Possible values are authorizationHeader and query.

Declaration

public Output<ImmutableArray<string>> BearerTokenSendingMethods { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

ClientAuthenticationMethods

The Authentication Methods supported by the Token endpoint of this Authorization Server.. Possible values are Basic and Body.

Declaration

public Output<ImmutableArray<string>> ClientAuthenticationMethods { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

ClientId

The Client/App ID registered with this Authorization Server.

Declaration

public Output<string> ClientId { get; }

Property Value

Type	Description
Output<System.String>

ClientRegistrationEndpoint

The URI of page where Client/App Registration is performed for this Authorization Server.

Declaration

public Output<string> ClientRegistrationEndpoint { get; }

Property Value

Type	Description
Output<System.String>

ClientSecret

The Client/App Secret registered with this Authorization Server.

Declaration

public Output<string> ClientSecret { get; }

Property Value

Type	Description
Output<System.String>

DefaultScope

The Default Scope used when requesting an Access Token, specified as a string containing space-delimited values.

Declaration

public Output<string> DefaultScope { get; }

Property Value

Type	Description
Output<System.String>

Description

A description of the Authorization Server, which may contain HTML formatting tags.

Declaration

public Output<string> Description { get; }

Property Value

Type	Description
Output<System.String>

DisplayName

The user-friendly name of this Authorization Server.

Declaration

public Output<string> DisplayName { get; }

Property Value

Type	Description
Output<System.String>

GrantTypes

Form of Authorization Grants required when requesting an Access Token. Possible values are authorizationCode, clientCredentials, implicit and resourceOwnerPassword.

Declaration

public Output<ImmutableArray<string>> GrantTypes { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<System.String>>

Name

The name of this Authorization Server. Changing this forces a new resource to be created.

Declaration

public Output<string> Name { get; }

Property Value

Type	Description
Output<System.String>

ResourceGroupName

The name of the Resource Group in which the API Management Service exists. Changing this forces a new resource to be created.

Declaration

public Output<string> ResourceGroupName { get; }

Property Value

Type	Description
Output<System.String>

ResourceOwnerPassword

The password associated with the Resource Owner.

Declaration

public Output<string> ResourceOwnerPassword { get; }

Property Value

Type	Description
Output<System.String>

ResourceOwnerUsername

The username associated with the Resource Owner.

Declaration

public Output<string> ResourceOwnerUsername { get; }

Property Value

Type	Description
Output<System.String>

SupportState

Does this Authorization Server support State? If this is set to true the client may use the state parameter to raise protocol security.

Declaration

public Output<bool?> SupportState { get; }

Property Value

Type	Description
Output<System.Nullable<System.Boolean>>

TokenBodyParameters

Declaration

public Output<ImmutableArray<AuthorizationServerTokenBodyParameter>> TokenBodyParameters { get; }

Property Value

Type	Description
Output<System.Collections.Immutable.ImmutableArray<AuthorizationServerTokenBodyParameter>>

TokenEndpoint

The OAUTH Token Endpoint.

Declaration

public Output<string> TokenEndpoint { get; }

Property Value

Type	Description
Output<System.String>

Methods

Get(String, Input<String>, AuthorizationServerState, CustomResourceOptions)

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

Declaration

public static AuthorizationServer Get(string name, Input<string> id, AuthorizationServerState state = null, CustomResourceOptions options = null)

Parameters

Type	Name	Description
System.String	name	The unique name of the resulting resource.
Input<System.String>	id	The unique provider ID of the resource to lookup.
AuthorizationServerState	state	Any extra arguments used during the lookup.
CustomResourceOptions	options	A bag of options that control this resource's behavior

Returns

Type	Description
AuthorizationServer