Microsoft.ApiManagement service/authorizationProviders 2023-09-01-preview
Bicep resource definition
The service/authorizationProviders resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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@2023-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
displayName: 'string'
identityProvider: 'string'
oauth2: {
grantTypes: {
authorizationCode: {
{customized property}: 'string'
}
clientCredentials: {
{customized property}: 'string'
}
}
redirectUrl: 'string'
}
}
}
Property values
service/authorizationProviders
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (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 |
AuthorizationProviderContractProperties
| Name | Description | Value |
|---|---|---|
| displayName | Authorization Provider name. Must be 1 to 300 characters long. | string Constraints: Min length = 1 Max length = 300 |
| identityProvider | Identity provider name. Must be 1 to 300 characters long. | string |
| oauth2 | OAuth2 settings | AuthorizationProviderOAuth2Settings |
AuthorizationProviderOAuth2Settings
| Name | Description | Value |
|---|---|---|
| grantTypes | OAuth2 settings | AuthorizationProviderOAuth2GrantTypes |
| redirectUrl | Redirect URL to be set in the OAuth application. | string |
AuthorizationProviderOAuth2GrantTypes
| Name | Description | Value |
|---|---|---|
| authorizationCode | OAuth2 authorization code grant parameters | AuthorizationProviderOAuth2GrantTypesAuthorizationCo... |
| clientCredentials | OAuth2 client credential grant parameters | AuthorizationProviderOAuth2GrantTypesClientCredentia... |
AuthorizationProviderOAuth2GrantTypesAuthorizationCo...
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
AuthorizationProviderOAuth2GrantTypesClientCredentia...
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
ARM template resource definition
The service/authorizationProviders resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
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": "2023-09-01-preview",
"name": "string",
"properties": {
"displayName": "string",
"identityProvider": "string",
"oauth2": {
"grantTypes": {
"authorizationCode": {
"{customized property}": "string"
},
"clientCredentials": {
"{customized property}": "string"
}
},
"redirectUrl": "string"
}
}
}
Property values
service/authorizationProviders
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.ApiManagement/service/authorizationProviders' |
| apiVersion | The resource api version | '2023-09-01-preview' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| properties | Properties of the Authorization Provider Contract. | AuthorizationProviderContractProperties |
AuthorizationProviderContractProperties
| Name | Description | Value |
|---|---|---|
| displayName | Authorization Provider name. Must be 1 to 300 characters long. | string Constraints: Min length = 1 Max length = 300 |
| identityProvider | Identity provider name. Must be 1 to 300 characters long. | string |
| oauth2 | OAuth2 settings | AuthorizationProviderOAuth2Settings |
AuthorizationProviderOAuth2Settings
| Name | Description | Value |
|---|---|---|
| grantTypes | OAuth2 settings | AuthorizationProviderOAuth2GrantTypes |
| redirectUrl | Redirect URL to be set in the OAuth application. | string |
AuthorizationProviderOAuth2GrantTypes
| Name | Description | Value |
|---|---|---|
| authorizationCode | OAuth2 authorization code grant parameters | AuthorizationProviderOAuth2GrantTypesAuthorizationCo... |
| clientCredentials | OAuth2 client credential grant parameters | AuthorizationProviderOAuth2GrantTypesClientCredentia... |
AuthorizationProviderOAuth2GrantTypesAuthorizationCo...
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
AuthorizationProviderOAuth2GrantTypesClientCredentia...
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
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@2023-09-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
displayName = "string"
identityProvider = "string"
oauth2 = {
grantTypes = {
authorizationCode = {
{customized property} = "string"
}
clientCredentials = {
{customized property} = "string"
}
}
redirectUrl = "string"
}
}
})
}
Property values
service/authorizationProviders
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.ApiManagement/service/authorizationProviders@2023-09-01-preview" |
| name | The resource name | string (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 |
AuthorizationProviderContractProperties
| Name | Description | Value |
|---|---|---|
| displayName | Authorization Provider name. Must be 1 to 300 characters long. | string Constraints: Min length = 1 Max length = 300 |
| identityProvider | Identity provider name. Must be 1 to 300 characters long. | string |
| oauth2 | OAuth2 settings | AuthorizationProviderOAuth2Settings |
AuthorizationProviderOAuth2Settings
| Name | Description | Value |
|---|---|---|
| grantTypes | OAuth2 settings | AuthorizationProviderOAuth2GrantTypes |
| redirectUrl | Redirect URL to be set in the OAuth application. | string |
AuthorizationProviderOAuth2GrantTypes
| Name | Description | Value |
|---|---|---|
| authorizationCode | OAuth2 authorization code grant parameters | AuthorizationProviderOAuth2GrantTypesAuthorizationCo... |
| clientCredentials | OAuth2 client credential grant parameters | AuthorizationProviderOAuth2GrantTypesClientCredentia... |
AuthorizationProviderOAuth2GrantTypesAuthorizationCo...
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
AuthorizationProviderOAuth2GrantTypesClientCredentia...
| Name | Description | Value |
|---|---|---|
| {customized property} | string |