This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.66.0 published on Wednesday, Oct 9, 2024 by Pulumi
azure-native.apimanagement.getAuthorizationServer
Explore with Pulumi AI
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.66.0 published on Wednesday, Oct 9, 2024 by Pulumi
Gets the details of the authorization server specified by its identifier. Azure REST API version: 2022-08-01.
Other available API versions: 2016-07-07, 2016-10-10, 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-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.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- Authsid string
- Identifier of the authorization server.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Service
Name string - The name of the API Management service.
- authsid String
- Identifier of the authorization server.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
- authsid string
- Identifier of the authorization server.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- service
Name string - The name of the API Management service.
- authsid str
- Identifier of the authorization server.
- resource_
group_ strname - 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.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- service
Name String - The name of the API Management service.
getAuthorizationServer Result
The following output properties are available:
- string
- OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
- Client
Id string - Client or app id registered with this authorization server.
- Client
Registration stringEndpoint - 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 string - User-friendly authorization server name.
- Grant
Types 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"
- List<string>
- HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
- Bearer
Token List<string>Sending Methods - Specifies the mechanism by which access token is passed to the API.
- Client
Authentication List<string>Method - 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 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.
- Default
Scope 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.
- Resource
Owner stringPassword - Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
- Resource
Owner stringUsername - 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 List<Pulumi.Parameters Azure Native. Api Management. Outputs. Token Body Parameter Contract Response> - 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 string - OAuth token endpoint. Contains absolute URI to entity being referenced.
- Use
In boolApi Documentation - 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 boolTest Console - If true, the authorization server may be used in the developer portal test console. True by default if no value is provided.
- string
- OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
- Client
Id string - Client or app id registered with this authorization server.
- Client
Registration stringEndpoint - 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 string - User-friendly authorization server name.
- Grant
Types []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"
- []string
- HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
- Bearer
Token []stringSending Methods - Specifies the mechanism by which access token is passed to the API.
- Client
Authentication []stringMethod - 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 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.
- Default
Scope 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.
- Resource
Owner stringPassword - Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
- Resource
Owner stringUsername - 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 []TokenParameters Body Parameter Contract Response - 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 string - OAuth token endpoint. Contains absolute URI to entity being referenced.
- Use
In boolApi Documentation - 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 boolTest Console - If true, the authorization server may be used in the developer portal test console. True by default if no value is provided.
- String
- OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
- client
Id String - Client or app id registered with this authorization server.
- client
Registration StringEndpoint - 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 String - User-friendly authorization server name.
- grant
Types 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"
- List<String>
- HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
- bearer
Token List<String>Sending Methods - Specifies the mechanism by which access token is passed to the API.
- client
Authentication List<String>Method - 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 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.
- default
Scope 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.
- resource
Owner StringPassword - Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
- resource
Owner StringUsername - Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
- support
State 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.
- token
Body List<TokenParameters Body Parameter Contract Response> - 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 String - OAuth token endpoint. Contains absolute URI to entity being referenced.
- use
In BooleanApi Documentation - 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 BooleanTest Console - If true, the authorization server may be used in the developer portal test console. True by default if no value is provided.
- string
- OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
- client
Id string - Client or app id registered with this authorization server.
- client
Registration stringEndpoint - 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 string - User-friendly authorization server name.
- grant
Types 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"
- string[]
- HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
- bearer
Token string[]Sending Methods - Specifies the mechanism by which access token is passed to the API.
- client
Authentication string[]Method - 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 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.
- default
Scope 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.
- resource
Owner stringPassword - Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
- resource
Owner stringUsername - Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
- support
State 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.
- token
Body TokenParameters Body Parameter Contract Response[] - 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 string - OAuth token endpoint. Contains absolute URI to entity being referenced.
- use
In booleanApi Documentation - 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 booleanTest Console - If true, the authorization server may be used in the developer portal test console. True by default if no value is provided.
- 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_ strendpoint - 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"
- Sequence[str]
- HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
- bearer_
token_ Sequence[str]sending_ methods - Specifies the mechanism by which access token is passed to the API.
- client_
authentication_ Sequence[str]method - 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_ strpassword - Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
- resource_
owner_ strusername - 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_ Sequence[Tokenparameters Body Parameter Contract Response] - 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_ boolapi_ documentation - 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_ booltest_ console - If true, the authorization server may be used in the developer portal test console. True by default if no value is provided.
- String
- OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2.
- client
Id String - Client or app id registered with this authorization server.
- client
Registration StringEndpoint - 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 String - User-friendly authorization server name.
- grant
Types 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"
- List<String>
- HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional.
- bearer
Token List<String>Sending Methods - Specifies the mechanism by which access token is passed to the API.
- client
Authentication List<String>Method - 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 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.
- default
Scope 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.
- resource
Owner StringPassword - Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password.
- resource
Owner StringUsername - Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username.
- support
State 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.
- token
Body List<Property Map>Parameters - 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 String - OAuth token endpoint. Contains absolute URI to entity being referenced.
- use
In BooleanApi Documentation - 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 BooleanTest Console - 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
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 v1 docs if using the v1 version of this package.
Azure Native v2.66.0 published on Wednesday, Oct 9, 2024 by Pulumi