Share via

Microsoft.ApiManagement service/authorizationProviders/authorizations

  • Article

Bicep resource definition

The service/authorizationProviders/authorizations resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiManagement/service/authorizationProviders/authorizations resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ApiManagement/service/authorizationProviders/authorizations@2024-06-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    authorizationType: 'string'
    error: {
      code: 'string'
      message: 'string'
    }
    oauth2grantType: 'string'
    parameters: {
      {customized property}: 'string'
    }
    status: 'string'
  }
}

Property Values

AuthorizationContractProperties

Name Description Value
authorizationType Authorization type options 'OAuth2'
error Authorization error details. AuthorizationError
oauth2grantType OAuth2 grant type options 'AuthorizationCode'
'ClientCredentials'
parameters Authorization parameters AuthorizationContractPropertiesParameters
status Status of the Authorization string

AuthorizationContractPropertiesParameters

Name Description Value

AuthorizationError

Name Description Value
code Error code string
message Error message string

Microsoft.ApiManagement/service/authorizationProviders/authorizations

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 256
Pattern = ^[^*#&+:<>?]+$ (required)
parent In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource.

For more information, see Child resource outside parent resource.		 Symbolic name for resource of type: service/authorizationProviders
properties Properties of the Authorization Contract. AuthorizationContractProperties

ARM template resource definition

The service/authorizationProviders/authorizations resource type can be deployed with operations that target:

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiManagement/service/authorizationProviders/authorizations resource, add the following JSON to your template.

{
  "type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations",
  "apiVersion": "2024-06-01-preview",
  "name": "string",
  "properties": {
    "authorizationType": "string",
    "error": {
      "code": "string",
      "message": "string"
    },
    "oauth2grantType": "string",
    "parameters": {
      "{customized property}": "string"
    },
    "status": "string"
  }
}

Property Values

AuthorizationContractProperties

Name Description Value
authorizationType Authorization type options 'OAuth2'
error Authorization error details. AuthorizationError
oauth2grantType OAuth2 grant type options 'AuthorizationCode'
'ClientCredentials'
parameters Authorization parameters AuthorizationContractPropertiesParameters
status Status of the Authorization string

AuthorizationContractPropertiesParameters

Name Description Value

AuthorizationError

Name Description Value
code Error code string
message Error message string

Microsoft.ApiManagement/service/authorizationProviders/authorizations

Name Description Value
apiVersion The api version '2024-06-01-preview'
name The resource name string

Constraints:
Min length = 1
Max length = 256
Pattern = ^[^*#&+:<>?]+$ (required)
properties Properties of the Authorization Contract. AuthorizationContractProperties
type The resource type 'Microsoft.ApiManagement/service/authorizationProviders/authorizations'

Usage Examples

Terraform (AzAPI provider) resource definition

The service/authorizationProviders/authorizations resource type can be deployed with operations that target:

  • Resource groups

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.ApiManagement/service/authorizationProviders/authorizations resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationProviders/authorizations@2024-06-01-preview"
  name = "string"
  parent_id = "string"
  body = {
    properties = {
      authorizationType = "string"
      error = {
        code = "string"
        message = "string"
      }
      oauth2grantType = "string"
      parameters = {
        {customized property} = "string"
      }
      status = "string"
    }
  }
}

Property Values

AuthorizationContractProperties

Name Description Value
authorizationType Authorization type options 'OAuth2'
error Authorization error details. AuthorizationError
oauth2grantType OAuth2 grant type options 'AuthorizationCode'
'ClientCredentials'
parameters Authorization parameters AuthorizationContractPropertiesParameters
status Status of the Authorization string

AuthorizationContractPropertiesParameters

Name Description Value

AuthorizationError

Name Description Value
code Error code string
message Error message string

Microsoft.ApiManagement/service/authorizationProviders/authorizations

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 256
Pattern = ^[^*#&+:<>?]+$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: service/authorizationProviders
properties Properties of the Authorization Contract. AuthorizationContractProperties
type The resource type "Microsoft.ApiManagement/service/authorizationProviders/authorizations@2024-06-01-preview"