pulumi-azure-kotlin/com.pulumi.azure.apimanagement.kotlin/AuthorizationServer

AuthorizationServer

class AuthorizationServer : KotlinCustomResource

Manages an Authorization Server within an API Management Service.

Example Usage

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 exampleService = ApimanagementFunctions.getService(GetServiceArgs.builder()
            .name("search-api")
            .resourceGroupName("search-service")
            .build());
        var exampleAuthorizationServer = new AuthorizationServer("exampleAuthorizationServer", AuthorizationServerArgs.builder()
            .apiManagementName(exampleService.applyValue(getServiceResult -> getServiceResult.name()))
            .resourceGroupName(exampleService.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());
    }
}

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

Properties

apiManagementName

val apiManagementName: Output<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

val authorizationEndpoint: Output<String>

The OAUTH Authorization Endpoint.

authorizationMethods

val authorizationMethods: Output<List<String>>

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

bearerTokenSendingMethods

val bearerTokenSendingMethods: Output<List<String>>?

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

clientAuthenticationMethods

val clientAuthenticationMethods: Output<List<String>>?

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

clientId

val clientId: Output<String>

The Client/App ID registered with this Authorization Server.

clientRegistrationEndpoint

val clientRegistrationEndpoint: Output<String>

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

clientSecret

val clientSecret: Output<String>?

The Client/App Secret registered with this Authorization Server.

defaultScope

val defaultScope: Output<String>?

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

description

val description: Output<String>?

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

displayName

val displayName: Output<String>

The user-friendly name of this Authorization Server.

grantTypes

val grantTypes: Output<List<String>>

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