Azure Native v1.102.0, May 2 23

azure-native.apimanagement.getAuthorizationServer

Explore with Pulumi AI

Gets the details of the authorization server specified by its identifier. API Version: 2020-12-01.

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.

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)
// Output-based functions aren't available in Java yet

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.
ServiceName string: The name of the API Management service.

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

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

authsid string: Identifier of the authorization server.
resourceGroupName string: The name of the resource group.
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.
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.
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.
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: Resource ID.
Name string: Resource name.
Type string: Resource type for API Management resource.
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.

AuthorizationEndpoint string: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
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: Resource ID.
Name string: Resource name.
Type string: Resource type for API Management resource.
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.

authorizationEndpoint String: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
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: Resource ID.
name String: Resource name.
type String: Resource type for API Management resource.
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.

authorizationEndpoint string: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
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: Resource ID.
name string: Resource name.
type string: Resource type for API Management resource.
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.

authorization_endpoint str: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
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: Resource ID.
name str: Resource name.
type str: Resource type for API Management resource.
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.

authorizationEndpoint String: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
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: Resource ID.
name String: Resource name.
type String: Resource type for API Management resource.
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.

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