Azure Native v3.0.1, Apr 7 25

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi

azure-native.apimanagement.getAuthorizationServer

Explore with Pulumi AI

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi

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 for details.

Using getAuthorizationServer

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

TypeScript
Python
Go
C#
Java
YAML

function getAuthorizationServer(args: GetAuthorizationServerArgs, opts?: InvokeOptions): Promise<GetAuthorizationServerResult>
function getAuthorizationServerOutput(args: GetAuthorizationServerOutputArgs, opts?: InvokeOptions): Output<GetAuthorizationServerResult>

def get_authorization_server(authsid: Optional[str] = None,
                             resource_group_name: Optional[str] = None,
                             service_name: Optional[str] = None,
                             opts: Optional[InvokeOptions] = None) -> GetAuthorizationServerResult
def get_authorization_server_output(authsid: Optional[pulumi.Input[str]] = None,
                             resource_group_name: Optional[pulumi.Input[str]] = None,
                             service_name: Optional[pulumi.Input[str]] = None,
                             opts: Optional[InvokeOptions] = None) -> Output[GetAuthorizationServerResult]

func LookupAuthorizationServer(ctx *Context, args *LookupAuthorizationServerArgs, opts ...InvokeOption) (*LookupAuthorizationServerResult, error)
func LookupAuthorizationServerOutput(ctx *Context, args *LookupAuthorizationServerOutputArgs, opts ...InvokeOption) LookupAuthorizationServerResultOutput

> Note: This function is named LookupAuthorizationServer in the Go SDK.

public static class GetAuthorizationServer 
{
    public static Task<GetAuthorizationServerResult> InvokeAsync(GetAuthorizationServerArgs args, InvokeOptions? opts = null)
    public static Output<GetAuthorizationServerResult> Invoke(GetAuthorizationServerInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetAuthorizationServerResult> getAuthorizationServer(GetAuthorizationServerArgs args, InvokeOptions options)
public static Output<GetAuthorizationServerResult> getAuthorizationServer(GetAuthorizationServerArgs args, InvokeOptions options)

fn::invoke:
  function: azure-native:apimanagement:getAuthorizationServer
  arguments:
    # arguments dictionary

The following arguments are supported:

Authsid string: Identifier of the authorization server.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
ServiceName string: The name of the API Management service.

Authsid string: Identifier of the authorization server.
ResourceGroupName string: The name of the resource group. The name is case insensitive.
ServiceName string: The name of the API Management service.

authsid String: Identifier of the authorization server.
resourceGroupName String: The name of the resource group. The name is case insensitive.
serviceName String: The name of the API Management service.

authsid string: Identifier of the authorization server.
resourceGroupName string: The name of the resource group. The name is case insensitive.
serviceName string: The name of the API Management service.

authsid str: Identifier of the authorization server.
resource_group_name str: The name of the resource group. The name is case insensitive.
service_name str: The name of the API Management service.

authsid String: Identifier of the authorization server.
resourceGroupName String: The name of the resource group. The name is case insensitive.
serviceName String: The name of the API Management service.

getAuthorizationServer Result

The following output properties are available:

AuthorizationEndpoint string: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
AzureApiVersion string: The Azure API version of the resource.
ClientId string: Client or app id registered with this authorization server.
ClientRegistrationEndpoint string: Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
DisplayName string: User-friendly authorization server name.
GrantTypes List<string>: Form of an authorization grant, which the client uses to request the access token.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string: The name of the resource
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AuthorizationMethods List<string>: HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
BearerTokenSendingMethods List<string>: Specifies the mechanism by which access token is passed to the API.
ClientAuthenticationMethod List<string>: 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.
ClientSecret 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.
DefaultScope 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.
Description string: Description of the authorization server. Can contain HTML formatting tags.
ResourceOwnerPassword string: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
ResourceOwnerUsername string: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
SupportState bool: If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
TokenBodyParameters List<Pulumi.AzureNative.ApiManagement.Outputs.TokenBodyParameterContractResponse>: 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"}.
TokenEndpoint string: OAuth token endpoint. Contains absolute URI to entity being referenced.
UseInApiDocumentation bool: If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided.
UseInTestConsole bool: If true, the authorization server may be used in the developer portal test console. True by default if no value is provided.

AuthorizationEndpoint string: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
AzureApiVersion string: The Azure API version of the resource.
ClientId string: Client or app id registered with this authorization server.
ClientRegistrationEndpoint string: Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
DisplayName string: User-friendly authorization server name.
GrantTypes []string: Form of an authorization grant, which the client uses to request the access token.
Id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Name string: The name of the resource
Type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
AuthorizationMethods []string: HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
BearerTokenSendingMethods []string: Specifies the mechanism by which access token is passed to the API.
ClientAuthenticationMethod []string: 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.
ClientSecret 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.
DefaultScope 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.
Description string: Description of the authorization server. Can contain HTML formatting tags.
ResourceOwnerPassword string: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
ResourceOwnerUsername string: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
SupportState bool: If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
TokenBodyParameters []TokenBodyParameterContractResponse: 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"}.
TokenEndpoint string: OAuth token endpoint. Contains absolute URI to entity being referenced.
UseInApiDocumentation bool: If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided.
UseInTestConsole bool: If true, the authorization server may be used in the developer portal test console. True by default if no value is provided.

authorizationEndpoint String: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
azureApiVersion String: The Azure API version of the resource.
clientId String: Client or app id registered with this authorization server.
clientRegistrationEndpoint String: Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
displayName String: User-friendly authorization server name.
grantTypes List<String>: Form of an authorization grant, which the client uses to request the access token.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String: The name of the resource
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
authorizationMethods List<String>: HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
bearerTokenSendingMethods List<String>: Specifies the mechanism by which access token is passed to the API.
clientAuthenticationMethod List<String>: 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.
clientSecret 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.
defaultScope 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.
description String: Description of the authorization server. Can contain HTML formatting tags.
resourceOwnerPassword String: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
resourceOwnerUsername String: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
supportState Boolean: If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
tokenBodyParameters List<TokenBodyParameterContractResponse>: 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"}.
tokenEndpoint String: OAuth token endpoint. Contains absolute URI to entity being referenced.
useInApiDocumentation Boolean: If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided.
useInTestConsole Boolean: If true, the authorization server may be used in the developer portal test console. True by default if no value is provided.

authorizationEndpoint string: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
azureApiVersion string: The Azure API version of the resource.
clientId string: Client or app id registered with this authorization server.
clientRegistrationEndpoint string: Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
displayName string: User-friendly authorization server name.
grantTypes string[]: Form of an authorization grant, which the client uses to request the access token.
id string: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name string: The name of the resource
type string: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
authorizationMethods string[]: HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
bearerTokenSendingMethods string[]: Specifies the mechanism by which access token is passed to the API.
clientAuthenticationMethod string[]: 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.
clientSecret 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.
defaultScope 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.
description string: Description of the authorization server. Can contain HTML formatting tags.
resourceOwnerPassword string: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
resourceOwnerUsername string: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
supportState boolean: If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
tokenBodyParameters TokenBodyParameterContractResponse[]: 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"}.
tokenEndpoint string: OAuth token endpoint. Contains absolute URI to entity being referenced.
useInApiDocumentation boolean: If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided.
useInTestConsole boolean: If true, the authorization server may be used in the developer portal test console. True by default if no value is provided.

authorization_endpoint str: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
azure_api_version str: The Azure API version of the resource.
client_id str: Client or app id registered with this authorization server.
client_registration_endpoint str: Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
display_name str: User-friendly authorization server name.
grant_types Sequence[str]: Form of an authorization grant, which the client uses to request the access token.
id str: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name str: The name of the resource
type str: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
authorization_methods Sequence[str]: HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
bearer_token_sending_methods Sequence[str]: Specifies the mechanism by which access token is passed to the API.
client_authentication_method Sequence[str]: 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.
client_secret str: 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.
default_scope str: 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.
description str: Description of the authorization server. Can contain HTML formatting tags.
resource_owner_password str: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
resource_owner_username str: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
support_state bool: If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
token_body_parameters Sequence[TokenBodyParameterContractResponse]: 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"}.
token_endpoint str: OAuth token endpoint. Contains absolute URI to entity being referenced.
use_in_api_documentation bool: If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided.
use_in_test_console bool: If true, the authorization server may be used in the developer portal test console. True by default if no value is provided.

authorizationEndpoint String: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
azureApiVersion String: The Azure API version of the resource.
clientId String: Client or app id registered with this authorization server.
clientRegistrationEndpoint String: Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced.
displayName String: User-friendly authorization server name.
grantTypes List<String>: Form of an authorization grant, which the client uses to request the access token.
id String: Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name String: The name of the resource
type String: The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
authorizationMethods List<String>: HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
bearerTokenSendingMethods List<String>: Specifies the mechanism by which access token is passed to the API.
clientAuthenticationMethod List<String>: 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.
clientSecret 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.
defaultScope 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.
description String: Description of the authorization server. Can contain HTML formatting tags.
resourceOwnerPassword String: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
resourceOwnerUsername String: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
supportState Boolean: If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security.
tokenBodyParameters List<Property Map>: 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"}.
tokenEndpoint String: OAuth token endpoint. Contains absolute URI to entity being referenced.
useInApiDocumentation Boolean: If true, the authorization server will be used in the API documentation in the developer portal. False by default if no value is provided.
useInTestConsole Boolean: If true, the authorization server may be used in the developer portal test console. True by default if no value is provided.

Supporting Types

TokenBodyParameterContractResponse

Name string: body parameter name.
Value string: body parameter value.

Name string: body parameter name.
Value string: body parameter value.

name String: body parameter name.
value String: body parameter value.

name string: body parameter name.
value string: body parameter value.

name str: body parameter name.
value str: body parameter value.

name String: body parameter name.
value String: body parameter value.

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.

Azure Native v3.0.1 published on Monday, Apr 7, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.apimanagement.getAuthorizationServer

On this page

On this page

Using getAuthorizationServer

getAuthorizationServer Result

Supporting Types

TokenBodyParameterContractResponse

Package Details

On this page

On this page