Note
Access to this page requires authorization. You can try signing in or changing directories.
Access to this page requires authorization. You can try changing directories.
Bicep resource definition
The registrationDefinitions 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.ManagedServices/registrationDefinitions resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ManagedServices/registrationDefinitions@2018-06-01-preview' = {
scope: resourceSymbolicName or scope
name: 'string'
plan: {
name: 'string'
product: 'string'
publisher: 'string'
version: 'string'
}
properties: {
authorizations: [
{
delegatedRoleDefinitionIds: [
'string'
]
principalId: 'string'
principalIdDisplayName: 'string'
roleDefinitionId: 'string'
}
]
description: 'string'
managedByTenantId: 'string'
registrationDefinitionName: 'string'
}
}
Property Values
Microsoft.ManagedServices/registrationDefinitions
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| plan | Plan details for the managed services. | Plan |
| properties | Properties of a registration definition. | RegistrationDefinitionProperties |
| scope | Use when creating a resource at a scope that is different than the deployment scope. | Set this property to the symbolic name of a resource to apply the extension resource. |
Authorization
| Name | Description | Value |
|---|---|---|
| delegatedRoleDefinitionIds | The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other security groups/service principals/users. | string Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$[] |
| principalId | Principal Id of the security group/service principal/user that would be assigned permissions to the projected subscription | string (required) |
| principalIdDisplayName | Display name of the principal Id. | string |
| roleDefinitionId | The role definition identifier. This role will define all the permissions that the security group/service principal/user must have on the projected subscription. This role cannot be an owner role. | string (required) |
Plan
| Name | Description | Value |
|---|---|---|
| name | The plan name. | string (required) |
| product | The product code. | string (required) |
| publisher | The publisher ID. | string (required) |
| version | The plan's version. | string (required) |
RegistrationDefinitionProperties
| Name | Description | Value |
|---|---|---|
| authorizations | Authorization tuple containing principal id of the user/security group or service principal and id of the build-in role. | Authorization[] (required) |
| description | Description of the registration definition. | string |
| managedByTenantId | Id of the managedBy tenant. | string (required) |
| registrationDefinitionName | Name of the registration definition. | string |
Usage Examples
Azure Verified Modules
The following Azure Verified Modules can be used to deploy this resource type.
| Module | Description |
|---|---|
| Registration Definition (Lighthouse) | AVM Resource Module for Registration Definition (Lighthouse) |
ARM template resource definition
The registrationDefinitions 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.ManagedServices/registrationDefinitions resource, add the following JSON to your template.
{
"type": "Microsoft.ManagedServices/registrationDefinitions",
"apiVersion": "2018-06-01-preview",
"name": "string",
"plan": {
"name": "string",
"product": "string",
"publisher": "string",
"version": "string"
},
"properties": {
"authorizations": [
{
"delegatedRoleDefinitionIds": [ "string" ],
"principalId": "string",
"principalIdDisplayName": "string",
"roleDefinitionId": "string"
}
],
"description": "string",
"managedByTenantId": "string",
"registrationDefinitionName": "string"
}
}
Property Values
Microsoft.ManagedServices/registrationDefinitions
| Name | Description | Value |
|---|---|---|
| apiVersion | The api version | '2018-06-01-preview' |
| name | The resource name | string (required) |
| plan | Plan details for the managed services. | Plan |
| properties | Properties of a registration definition. | RegistrationDefinitionProperties |
| type | The resource type | 'Microsoft.ManagedServices/registrationDefinitions' |
Authorization
| Name | Description | Value |
|---|---|---|
| delegatedRoleDefinitionIds | The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other security groups/service principals/users. | string Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$[] |
| principalId | Principal Id of the security group/service principal/user that would be assigned permissions to the projected subscription | string (required) |
| principalIdDisplayName | Display name of the principal Id. | string |
| roleDefinitionId | The role definition identifier. This role will define all the permissions that the security group/service principal/user must have on the projected subscription. This role cannot be an owner role. | string (required) |
Plan
| Name | Description | Value |
|---|---|---|
| name | The plan name. | string (required) |
| product | The product code. | string (required) |
| publisher | The publisher ID. | string (required) |
| version | The plan's version. | string (required) |
RegistrationDefinitionProperties
| Name | Description | Value |
|---|---|---|
| authorizations | Authorization tuple containing principal id of the user/security group or service principal and id of the build-in role. | Authorization[] (required) |
| description | Description of the registration definition. | string |
| managedByTenantId | Id of the managedBy tenant. | string (required) |
| registrationDefinitionName | Name of the registration definition. | string |
Usage Examples
Terraform (AzAPI provider) resource definition
The registrationDefinitions 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.ManagedServices/registrationDefinitions resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.ManagedServices/registrationDefinitions@2018-06-01-preview"
name = "string"
parent_id = "string"
body = {
plan = {
name = "string"
product = "string"
publisher = "string"
version = "string"
}
properties = {
authorizations = [
{
delegatedRoleDefinitionIds = [
"string"
]
principalId = "string"
principalIdDisplayName = "string"
roleDefinitionId = "string"
}
]
description = "string"
managedByTenantId = "string"
registrationDefinitionName = "string"
}
}
}
Property Values
Microsoft.ManagedServices/registrationDefinitions
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| parent_id | The ID of the resource to apply this extension resource to. | string (required) |
| plan | Plan details for the managed services. | Plan |
| properties | Properties of a registration definition. | RegistrationDefinitionProperties |
| type | The resource type | "Microsoft.ManagedServices/registrationDefinitions@2018-06-01-preview" |
Authorization
| Name | Description | Value |
|---|---|---|
| delegatedRoleDefinitionIds | The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other security groups/service principals/users. | string Constraints: Min length = 36 Max length = 36 Pattern = ^[0-9a-fA-F]{8}-([0-9a-fA-F]{4}-){3}[0-9a-fA-F]{12}$[] |
| principalId | Principal Id of the security group/service principal/user that would be assigned permissions to the projected subscription | string (required) |
| principalIdDisplayName | Display name of the principal Id. | string |
| roleDefinitionId | The role definition identifier. This role will define all the permissions that the security group/service principal/user must have on the projected subscription. This role cannot be an owner role. | string (required) |
Plan
| Name | Description | Value |
|---|---|---|
| name | The plan name. | string (required) |
| product | The product code. | string (required) |
| publisher | The publisher ID. | string (required) |
| version | The plan's version. | string (required) |
RegistrationDefinitionProperties
| Name | Description | Value |
|---|---|---|
| authorizations | Authorization tuple containing principal id of the user/security group or service principal and id of the build-in role. | Authorization[] (required) |
| description | Description of the registration definition. | string |
| managedByTenantId | Id of the managedBy tenant. | string (required) |
| registrationDefinitionName | Name of the registration definition. | string |