Microsoft.ApiManagement service/authorizationProviders/authorizations 2023-09-01-preview
Bicep resource definition
The service/authorizationProviders/authorizations 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/authorizations resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ApiManagement/service/authorizationProviders/authorizations@2023-09-01-preview' = {
name: 'string'
parent: resourceSymbolicName
properties: {
authorizationType: 'OAuth2'
error: {
code: 'string'
message: 'string'
}
oauth2grantType: 'string'
parameters: {
{customized property}: 'string'
}
status: 'string'
}
}
Property values
service/authorizationProviders/authorizations
| 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: authorizationProviders |
| properties | Properties of the Authorization Contract. | AuthorizationContractProperties |
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 |
AuthorizationError
| Name | Description | Value |
|---|---|---|
| code | Error code | string |
| message | Error message | string |
AuthorizationContractPropertiesParameters
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
ARM template resource definition
The service/authorizationProviders/authorizations 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/authorizations resource, add the following JSON to your template.
{
"type": "Microsoft.ApiManagement/service/authorizationProviders/authorizations",
"apiVersion": "2023-09-01-preview",
"name": "string",
"properties": {
"authorizationType": "OAuth2",
"error": {
"code": "string",
"message": "string"
},
"oauth2grantType": "string",
"parameters": {
"{customized property}": "string"
},
"status": "string"
}
}
Property values
service/authorizationProviders/authorizations
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.ApiManagement/service/authorizationProviders/authorizations' |
| 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 Contract. | AuthorizationContractProperties |
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 |
AuthorizationError
| Name | Description | Value |
|---|---|---|
| code | Error code | string |
| message | Error message | string |
AuthorizationContractPropertiesParameters
| Name | Description | Value |
|---|---|---|
| {customized property} | string |
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@2023-09-01-preview"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
authorizationType = "OAuth2"
error = {
code = "string"
message = "string"
}
oauth2grantType = "string"
parameters = {
{customized property} = "string"
}
status = "string"
}
})
}
Property values
service/authorizationProviders/authorizations
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.ApiManagement/service/authorizationProviders/authorizations@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: authorizationProviders |
| properties | Properties of the Authorization Contract. | AuthorizationContractProperties |
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 |
AuthorizationError
| Name | Description | Value |
|---|---|---|
| code | Error code | string |
| message | Error message | string |
AuthorizationContractPropertiesParameters
| Name | Description | Value |
|---|---|---|
| {customized property} | string |