BillingRoleAssignmentProperties interface

The properties of the billing role assignment.

Properties

billingAccountDisplayName

The name of the billing account. NOTE: This property will not be serialized. It can only be populated by the server.

billingAccountId

The fully qualified ID that uniquely identifies a billing account. NOTE: This property will not be serialized. It can only be populated by the server.

billingProfileDisplayName

The name of the billing profile. NOTE: This property will not be serialized. It can only be populated by the server.

billingProfileId

The fully qualified ID that uniquely identifies a billing profile. NOTE: This property will not be serialized. It can only be populated by the server.

billingRequestId

The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. NOTE: This property will not be serialized. It can only be populated by the server.

createdByPrincipalId

The object ID of the user who created the role assignment. NOTE: This property will not be serialized. It can only be populated by the server.

createdByPrincipalPuid

The principal PUID of the user who created the role assignment. NOTE: This property will not be serialized. It can only be populated by the server.

createdByPrincipalTenantId

The tenant Id of the user who created the role assignment. NOTE: This property will not be serialized. It can only be populated by the server.

createdByUserEmailAddress

The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. NOTE: This property will not be serialized. It can only be populated by the server.

createdOn

The date the role assignment was created. NOTE: This property will not be serialized. It can only be populated by the server.

customerDisplayName

The name of the customer. NOTE: This property will not be serialized. It can only be populated by the server.

customerId

The fully qualified ID that uniquely identifies a customer. NOTE: This property will not be serialized. It can only be populated by the server.

invoiceSectionDisplayName

The name of the invoice section. NOTE: This property will not be serialized. It can only be populated by the server.

invoiceSectionId

The fully qualified ID that uniquely identifies an invoice section. NOTE: This property will not be serialized. It can only be populated by the server.

modifiedByPrincipalId

The principal PUID of the user who modified the role assignment. NOTE: This property will not be serialized. It can only be populated by the server.

modifiedByPrincipalPuid

The principal PUID of the user who modified the role assignment. NOTE: This property will not be serialized. It can only be populated by the server.

modifiedByPrincipalTenantId

The tenant Id of the user who modified the role assignment. NOTE: This property will not be serialized. It can only be populated by the server.

modifiedByUserEmailAddress

The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. NOTE: This property will not be serialized. It can only be populated by the server.

modifiedOn

The date the role assignment was modified. NOTE: This property will not be serialized. It can only be populated by the server.

principalDisplayName

The display name of the principal to whom the role was assigned. NOTE: This property will not be serialized. It can only be populated by the server.

principalId

The object id of the user to whom the role was assigned.

principalPuid

The principal PUID of the user to whom the role was assigned.

principalTenantId

The principal tenant id of the user to whom the role was assigned.

principalTenantName

The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. NOTE: This property will not be serialized. It can only be populated by the server.

principalType

The type of a role Assignment. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState

The provisioning state of the resource during a long-running operation. NOTE: This property will not be serialized. It can only be populated by the server.

roleDefinitionId

The ID of the role definition.

scope

The scope at which the role was assigned.

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.

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.

Property Details

billingAccountDisplayName

The name of the billing account. NOTE: This property will not be serialized. It can only be populated by the server.

billingAccountDisplayName?: string

Property Value

string

billingAccountId

The fully qualified ID that uniquely identifies a billing account. NOTE: This property will not be serialized. It can only be populated by the server.

billingAccountId?: string

Property Value

string

billingProfileDisplayName

The name of the billing profile. NOTE: This property will not be serialized. It can only be populated by the server.

billingProfileDisplayName?: string

Property Value

string

billingProfileId

The fully qualified ID that uniquely identifies a billing profile. NOTE: This property will not be serialized. It can only be populated by the server.

billingProfileId?: string

Property Value

string

billingRequestId

The ID of the billing request that was created for the role assignment. This is only applicable to cross tenant role assignments or role assignments created through the billing request. NOTE: This property will not be serialized. It can only be populated by the server.

billingRequestId?: string

Property Value

string

createdByPrincipalId

The object ID of the user who created the role assignment. NOTE: This property will not be serialized. It can only be populated by the server.

createdByPrincipalId?: string

Property Value

string

createdByPrincipalPuid

The principal PUID of the user who created the role assignment. NOTE: This property will not be serialized. It can only be populated by the server.

createdByPrincipalPuid?: string

Property Value

string

createdByPrincipalTenantId

The tenant Id of the user who created the role assignment. NOTE: This property will not be serialized. It can only be populated by the server.

createdByPrincipalTenantId?: string

Property Value

string

createdByUserEmailAddress

The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. NOTE: This property will not be serialized. It can only be populated by the server.

createdByUserEmailAddress?: string

Property Value

string

createdOn

The date the role assignment was created. NOTE: This property will not be serialized. It can only be populated by the server.

createdOn?: Date

Property Value

Date

customerDisplayName

The name of the customer. NOTE: This property will not be serialized. It can only be populated by the server.

customerDisplayName?: string

Property Value

string

customerId

The fully qualified ID that uniquely identifies a customer. NOTE: This property will not be serialized. It can only be populated by the server.

customerId?: string

Property Value

string

invoiceSectionDisplayName

The name of the invoice section. NOTE: This property will not be serialized. It can only be populated by the server.

invoiceSectionDisplayName?: string

Property Value

string

invoiceSectionId

The fully qualified ID that uniquely identifies an invoice section. NOTE: This property will not be serialized. It can only be populated by the server.

invoiceSectionId?: string

Property Value

string

modifiedByPrincipalId

The principal PUID of the user who modified the role assignment. NOTE: This property will not be serialized. It can only be populated by the server.

modifiedByPrincipalId?: string

Property Value

string

modifiedByPrincipalPuid

The principal PUID of the user who modified the role assignment. NOTE: This property will not be serialized. It can only be populated by the server.

modifiedByPrincipalPuid?: string

Property Value

string

modifiedByPrincipalTenantId

The tenant Id of the user who modified the role assignment. NOTE: This property will not be serialized. It can only be populated by the server.

modifiedByPrincipalTenantId?: string

Property Value

string

modifiedByUserEmailAddress

The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement. NOTE: This property will not be serialized. It can only be populated by the server.

modifiedByUserEmailAddress?: string

Property Value

string

modifiedOn

The date the role assignment was modified. NOTE: This property will not be serialized. It can only be populated by the server.

modifiedOn?: Date

Property Value

Date

principalDisplayName

The display name of the principal to whom the role was assigned. NOTE: This property will not be serialized. It can only be populated by the server.

principalDisplayName?: string

Property Value

string

principalId

The object id of the user to whom the role was assigned.

principalId?: string

Property Value

string

principalPuid

The principal PUID of the user to whom the role was assigned.

principalPuid?: string

Property Value

string

principalTenantId

The principal tenant id of the user to whom the role was assigned.

principalTenantId?: string

Property Value

string

principalTenantName

The friendly name of the tenant of the user to whom the role was assigned. This will be 'Primary Tenant' for the primary tenant of the billing account. NOTE: This property will not be serialized. It can only be populated by the server.

principalTenantName?: string

Property Value

string

principalType

The type of a role Assignment. NOTE: This property will not be serialized. It can only be populated by the server.

principalType?: string

Property Value

string

provisioningState

The provisioning state of the resource during a long-running operation. NOTE: This property will not be serialized. It can only be populated by the server.

provisioningState?: string

Property Value

string

roleDefinitionId

The ID of the role definition.

roleDefinitionId: string

Property Value

string

scope

The scope at which the role was assigned.

scope?: string

Property Value

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.

userAuthenticationType?: string

Property Value

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.

userEmailAddress?: string

Property Value

string