Share via

Microsoft.ApiManagement service/authorizationProviders 2022-09-01-preview

  • Article

Bicep resource definition

The service/authorizationProviders 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 resource, add the following Bicep to your template.

resource symbolicname 'Microsoft.ApiManagement/service/authorizationProviders@2022-09-01-preview' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    displayName: 'string'
    identityProvider: 'string'
    oauth2: {
      grantTypes: {
        authorizationCode: {
          {customized property}: 'string'
        }
        clientCredentials: {
          {customized property}: 'string'
        }
      }
      redirectUrl: 'string'
    }
  }
}

Property values

AuthorizationProviderContractProperties

Name Description Value
displayName Authorization Provider name. Must be 1 to 300 characters long. string

Constraints:
Min length = 1
Max length = 1
identityProvider Identity provider name. Must be 1 to 300 characters long. string
oauth2 OAuth2 settings AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2GrantTypes

Name Description Value
authorizationCode OAuth2 authorization code grant parameters AuthorizationProviderOAuth2GrantTypesAuthorizationCode
clientCredentials OAuth2 client credential grant parameters AuthorizationProviderOAuth2GrantTypesClientCredentials

AuthorizationProviderOAuth2GrantTypesAuthorizationCode

Name Description Value

AuthorizationProviderOAuth2GrantTypesClientCredentials

Name Description Value

AuthorizationProviderOAuth2Settings

Name Description Value
grantTypes OAuth2 settings AuthorizationProviderOAuth2GrantTypes
redirectUrl Redirect URL to be set in the OAuth application. string

Microsoft.ApiManagement/service/authorizationProviders

Name Description Value
name The resource name string

Constraints:
Min length = 1
Max length = 1
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
properties Properties of the Authorization Provider Contract. AuthorizationProviderContractProperties

ARM template resource definition

The service/authorizationProviders 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 resource, add the following JSON to your template.

{
  "type": "Microsoft.ApiManagement/service/authorizationProviders",
  "apiVersion": "2022-09-01-preview",
  "name": "string",
  "properties": {
    "displayName": "string",
    "identityProvider": "string",
    "oauth2": {
      "grantTypes": {
        "authorizationCode": {
          "{customized property}": "string"
        },
        "clientCredentials": {
          "{customized property}": "string"
        }
      },
      "redirectUrl": "string"
    }
  }
}

Property values

AuthorizationProviderContractProperties

Name Description Value
displayName Authorization Provider name. Must be 1 to 300 characters long. string

Constraints:
Min length = 1
Max length = 1
identityProvider Identity provider name. Must be 1 to 300 characters long. string
oauth2 OAuth2 settings AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2GrantTypes

Name Description Value
authorizationCode OAuth2 authorization code grant parameters AuthorizationProviderOAuth2GrantTypesAuthorizationCode
clientCredentials OAuth2 client credential grant parameters AuthorizationProviderOAuth2GrantTypesClientCredentials

AuthorizationProviderOAuth2GrantTypesAuthorizationCode

Name Description Value

AuthorizationProviderOAuth2GrantTypesClientCredentials

Name Description Value

AuthorizationProviderOAuth2Settings

Name Description Value
grantTypes OAuth2 settings AuthorizationProviderOAuth2GrantTypes
redirectUrl Redirect URL to be set in the OAuth application. string

Microsoft.ApiManagement/service/authorizationProviders

Name Description Value
apiVersion The api version '2022-09-01-preview'
name The resource name string

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

Terraform (AzAPI provider) resource definition

The service/authorizationProviders 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 resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.ApiManagement/service/authorizationProviders@2022-09-01-preview"
  name = "string"
  body = jsonencode({
    properties = {
      displayName = "string"
      identityProvider = "string"
      oauth2 = {
        grantTypes = {
          authorizationCode = {
            {customized property} = "string"
          }
          clientCredentials = {
            {customized property} = "string"
          }
        }
        redirectUrl = "string"
      }
    }
  })
}

Property values

AuthorizationProviderContractProperties

Name Description Value
displayName Authorization Provider name. Must be 1 to 300 characters long. string

Constraints:
Min length = 1
Max length = 1
identityProvider Identity provider name. Must be 1 to 300 characters long. string
oauth2 OAuth2 settings AuthorizationProviderOAuth2Settings

AuthorizationProviderOAuth2GrantTypes

Name Description Value
authorizationCode OAuth2 authorization code grant parameters AuthorizationProviderOAuth2GrantTypesAuthorizationCode
clientCredentials OAuth2 client credential grant parameters AuthorizationProviderOAuth2GrantTypesClientCredentials

AuthorizationProviderOAuth2GrantTypesAuthorizationCode

Name Description Value

AuthorizationProviderOAuth2GrantTypesClientCredentials

Name Description Value

AuthorizationProviderOAuth2Settings

Name Description Value
grantTypes OAuth2 settings AuthorizationProviderOAuth2GrantTypes
redirectUrl Redirect URL to be set in the OAuth application. string

Microsoft.ApiManagement/service/authorizationProviders

Name Description Value
name The resource name string

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