1. Packages
  2. Azure Native
  3. API Docs
  4. apimanagement
  5. getAuthorization
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.90.0 published on Thursday, Mar 27, 2025 by Pulumi

azure-native.apimanagement.getAuthorization

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.90.0 published on Thursday, Mar 27, 2025 by Pulumi

Gets the details of the authorization specified by its identifier.

Uses Azure REST API version 2022-08-01.

Other available API versions: 2022-09-01-preview, 2023-03-01-preview, 2023-05-01-preview, 2023-09-01-preview, 2024-05-01, 2024-06-01-preview.

Using getAuthorization

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 getAuthorization(args: GetAuthorizationArgs, opts?: InvokeOptions): Promise<GetAuthorizationResult>
function getAuthorizationOutput(args: GetAuthorizationOutputArgs, opts?: InvokeOptions): Output<GetAuthorizationResult>
Copy
def get_authorization(authorization_id: Optional[str] = None,
                      authorization_provider_id: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      service_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetAuthorizationResult
def get_authorization_output(authorization_id: Optional[pulumi.Input[str]] = None,
                      authorization_provider_id: 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[GetAuthorizationResult]
Copy
func LookupAuthorization(ctx *Context, args *LookupAuthorizationArgs, opts ...InvokeOption) (*LookupAuthorizationResult, error)
func LookupAuthorizationOutput(ctx *Context, args *LookupAuthorizationOutputArgs, opts ...InvokeOption) LookupAuthorizationResultOutput
Copy

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

public static class GetAuthorization 
{
    public static Task<GetAuthorizationResult> InvokeAsync(GetAuthorizationArgs args, InvokeOptions? opts = null)
    public static Output<GetAuthorizationResult> Invoke(GetAuthorizationInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetAuthorizationResult> getAuthorization(GetAuthorizationArgs args, InvokeOptions options)
public static Output<GetAuthorizationResult> getAuthorization(GetAuthorizationArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:apimanagement:getAuthorization
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AuthorizationId
This property is required.
Changes to this property will trigger replacement.
string
Identifier of the authorization.
AuthorizationProviderId
This property is required.
Changes to this property will trigger replacement.
string
Identifier of the authorization provider.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
AuthorizationId
This property is required.
Changes to this property will trigger replacement.
string
Identifier of the authorization.
AuthorizationProviderId
This property is required.
Changes to this property will trigger replacement.
string
Identifier of the authorization provider.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
authorizationId
This property is required.
Changes to this property will trigger replacement.
String
Identifier of the authorization.
authorizationProviderId
This property is required.
Changes to this property will trigger replacement.
String
Identifier of the authorization provider.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.
authorizationId
This property is required.
Changes to this property will trigger replacement.
string
Identifier of the authorization.
authorizationProviderId
This property is required.
Changes to this property will trigger replacement.
string
Identifier of the authorization provider.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the API Management service.
authorization_id
This property is required.
Changes to this property will trigger replacement.
str
Identifier of the authorization.
authorization_provider_id
This property is required.
Changes to this property will trigger replacement.
str
Identifier of the authorization provider.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource group. The name is case insensitive.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the API Management service.
authorizationId
This property is required.
Changes to this property will trigger replacement.
String
Identifier of the authorization.
authorizationProviderId
This property is required.
Changes to this property will trigger replacement.
String
Identifier of the authorization provider.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource group. The name is case insensitive.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the API Management service.

getAuthorization Result

The following output properties are available:

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"
AuthorizationType string
Authorization type options
Error Pulumi.AzureNative.ApiManagement.Outputs.AuthorizationErrorResponse
Authorization error details.
OAuth2GrantType string
OAuth2 grant type options
Parameters Dictionary<string, string>
Authorization parameters
Status string
Status of the Authorization
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"
AuthorizationType string
Authorization type options
Error AuthorizationErrorResponse
Authorization error details.
OAuth2GrantType string
OAuth2 grant type options
Parameters map[string]string
Authorization parameters
Status string
Status of the Authorization
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"
authorizationType String
Authorization type options
error AuthorizationErrorResponse
Authorization error details.
oAuth2GrantType String
OAuth2 grant type options
parameters Map<String,String>
Authorization parameters
status String
Status of the Authorization
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"
authorizationType string
Authorization type options
error AuthorizationErrorResponse
Authorization error details.
oAuth2GrantType string
OAuth2 grant type options
parameters {[key: string]: string}
Authorization parameters
status string
Status of the Authorization
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_type str
Authorization type options
error AuthorizationErrorResponse
Authorization error details.
o_auth2_grant_type str
OAuth2 grant type options
parameters Mapping[str, str]
Authorization parameters
status str
Status of the Authorization
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"
authorizationType String
Authorization type options
error Property Map
Authorization error details.
oAuth2GrantType String
OAuth2 grant type options
parameters Map<String>
Authorization parameters
status String
Status of the Authorization

Supporting Types

AuthorizationErrorResponse

Code string
Error code
Message string
Error message
Code string
Error code
Message string
Error message
code String
Error code
message String
Error message
code string
Error code
message string
Error message
code str
Error code
message str
Error message
code String
Error code
message String
Error message

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.90.0 published on Thursday, Mar 27, 2025 by Pulumi