Microsoft.ManagedServices registrationDefinitions 2019-06-01
Bicep resource definition
The registrationDefinitions resource type is an extension resource, which means you can apply it to another resource.
Use the scope property on this resource to set the scope for this resource. See Set scope on extension resources in Bicep.
Valid deployment scopes for the registrationDefinitions resource are:
- 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.ManagedServices/registrationDefinitions resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.ManagedServices/registrationDefinitions@2019-06-01' = {
name: 'string'
scope: resourceSymbolicName
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
registrationDefinitions
| Name | Description | Value |
|---|---|---|
| name | The resource name | string (required) |
| scope | Use when creating an extension resource at a scope that is different than the deployment scope. | Target resource For Bicep, set this property to the symbolic name of the resource to apply the extension resource. |
| plan | Plan details for the managed services. | Plan |
| properties | Properties of a registration definition. | RegistrationDefinitionProperties |
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 |
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[] |
| 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) |
ARM template resource definition
The registrationDefinitions resource type is an extension resource, which means you can apply it to another resource.
Use the scope property on this resource to set the scope for this resource. See Set scope on extension resources in ARM templates.
Valid deployment scopes for the registrationDefinitions resource are:
- 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.ManagedServices/registrationDefinitions resource, add the following JSON to your template.
{
"type": "Microsoft.ManagedServices/registrationDefinitions",
"apiVersion": "2019-06-01",
"name": "string",
"scope": "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
registrationDefinitions
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.ManagedServices/registrationDefinitions' |
| apiVersion | The resource api version | '2019-06-01' |
| name | The resource name | string (required) |
| scope | Use when creating an extension resource at a scope that is different than the deployment scope. | Target resource For JSON, set the value to the full name of the resource to apply the extension resource to. |
| plan | Plan details for the managed services. | Plan |
| properties | Properties of a registration definition. | RegistrationDefinitionProperties |
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 |
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[] |
| 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) |
Terraform (AzAPI provider) resource definition
The registrationDefinitions resource type is an extension resource, which means you can apply it to another resource.
Use the parent_id property on this resource to set the scope for this resource.
Valid deployment scopes for the registrationDefinitions resource are:
- Resource groups
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@2019-06-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
authorizations = [
{
delegatedRoleDefinitionIds = [
"string"
]
principalId = "string"
principalIdDisplayName = "string"
roleDefinitionId = "string"
}
]
description = "string"
managedByTenantId = "string"
registrationDefinitionName = "string"
}
plan = {
name = "string"
product = "string"
publisher = "string"
version = "string"
}
})
}
Property values
registrationDefinitions
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.ManagedServices/registrationDefinitions@2019-06-01" |
| 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 |
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 |
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[] |
| 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) |
Feedback
Coming soon: Throughout 2024 we will be phasing out GitHub Issues as the feedback mechanism for content and replacing it with a new feedback system. For more information see: https://aka.ms/ContentUserFeedback.
Submit and view feedback for