Share via

Microsoft.Billing billingAccounts/billingRoleAssignments 2024-04-01

  • Article

Bicep resource definition

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

resource symbolicname 'Microsoft.Billing/billingAccounts/billingRoleAssignments@2024-04-01' = {
  parent: resourceSymbolicName
  name: 'string'
  properties: {
    principalId: 'string'
    principalPuid: 'string'
    principalTenantId: 'string'
    roleDefinitionId: 'string'
    scope: 'string'
    userAuthenticationType: 'string'
    userEmailAddress: 'string'
  }
  tags: {
    {customized property}: 'string'
  }
}

Property values

BillingRoleAssignmentProperties

Name Description Value
principalId The object id of the user to whom the role was assigned. string
principalPuid The principal PUID of the user to whom the role was assigned. string
principalTenantId The principal tenant id of the user to whom the role was assigned. string
roleDefinitionId The ID of the role definition. string

Constraints:
Min length = 1 (required)
scope The scope at which the role was assigned. string
userAuthenticationType The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. string
userEmailAddress The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. string

Microsoft.Billing/billingAccounts/billingRoleAssignments

Name Description Value
name The resource name string

Constraints:
Pattern = ^[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12}(_[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12})?$ (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: billingAccounts
properties The properties of the billing role assignment. BillingRoleAssignmentProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates

ProxyResourceWithTags

Name Description Value

ARM template resource definition

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

{
  "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments",
  "apiVersion": "2024-04-01",
  "name": "string",
  "properties": {
    "principalId": "string",
    "principalPuid": "string",
    "principalTenantId": "string",
    "roleDefinitionId": "string",
    "scope": "string",
    "userAuthenticationType": "string",
    "userEmailAddress": "string"
  },
  "tags": {
    "{customized property}": "string"
  }
}

Property values

BillingRoleAssignmentProperties

Name Description Value
principalId The object id of the user to whom the role was assigned. string
principalPuid The principal PUID of the user to whom the role was assigned. string
principalTenantId The principal tenant id of the user to whom the role was assigned. string
roleDefinitionId The ID of the role definition. string

Constraints:
Min length = 1 (required)
scope The scope at which the role was assigned. string
userAuthenticationType The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. string
userEmailAddress The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. string

Microsoft.Billing/billingAccounts/billingRoleAssignments

Name Description Value
apiVersion The api version '2024-04-01'
name The resource name string

Constraints:
Pattern = ^[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12}(_[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12})?$ (required)
properties The properties of the billing role assignment. BillingRoleAssignmentProperties
tags Resource tags Dictionary of tag names and values. See Tags in templates
type The resource type 'Microsoft.Billing/billingAccounts/billingRoleAssignments'

ProxyResourceWithTags

Name Description Value

Terraform (AzAPI provider) resource definition

The billingAccounts/billingRoleAssignments resource type can be deployed with operations that target:

  • Tenant

For a list of changed properties in each API version, see change log.

Resource format

To create a Microsoft.Billing/billingAccounts/billingRoleAssignments resource, add the following Terraform to your template.

resource "azapi_resource" "symbolicname" {
  type = "Microsoft.Billing/billingAccounts/billingRoleAssignments@2024-04-01"
  name = "string"
  tags = {
    {customized property} = "string"
  }
  body = jsonencode({
    properties = {
      principalId = "string"
      principalPuid = "string"
      principalTenantId = "string"
      roleDefinitionId = "string"
      scope = "string"
      userAuthenticationType = "string"
      userEmailAddress = "string"
    }
  })
}

Property values

BillingRoleAssignmentProperties

Name Description Value
principalId The object id of the user to whom the role was assigned. string
principalPuid The principal PUID of the user to whom the role was assigned. string
principalTenantId The principal tenant id of the user to whom the role was assigned. string
roleDefinitionId The ID of the role definition. string

Constraints:
Min length = 1 (required)
scope The scope at which the role was assigned. string
userAuthenticationType The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. string
userEmailAddress The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement. string

Microsoft.Billing/billingAccounts/billingRoleAssignments

Name Description Value
name The resource name string

Constraints:
Pattern = ^[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12}(_[a-fA-F0-9]{8}[-]?([a-fA-F0-9]{4}[-]?){3}[a-fA-F0-9]{12})?$ (required)
parent_id The ID of the resource that is the parent for this resource. ID for resource of type: billingAccounts
properties The properties of the billing role assignment. BillingRoleAssignmentProperties
tags Resource tags Dictionary of tag names and values.
type The resource type "Microsoft.Billing/billingAccounts/billingRoleAssignments@2024-04-01"

ProxyResourceWithTags

Name Description Value