BillingRoleAssignmentProperties Class

Package:

com.azure.resourcemanager.billing.models

Maven Artifact:

com.azure.resourcemanager:azure-resourcemanager-billing:1.0.0

• java.lang.Object
• • com.azure.resourcemanager.billing.models.BillingRoleAssignmentProperties

Implements

JsonSerializable<BillingRoleAssignmentProperties>

public final class BillingRoleAssignmentProperties
implements JsonSerializable<BillingRoleAssignmentProperties>

The properties of the billing role assignment.

Constructor Summary

Constructor	Description
BillingRoleAssignmentProperties()	Creates an instance of BillingRoleAssignmentProperties class.

Method Summary

Modifier and Type	Method and Description
String	billingAccountDisplayName() Get the billingAccountDisplayName property: The name of the billing account.
String	billingAccountId() Get the billingAccountId property: The fully qualified ID that uniquely identifies a billing account.
String	billingProfileDisplayName() Get the billingProfileDisplayName property: The name of the billing profile.
String	billingProfileId() Get the billingProfileId property: The fully qualified ID that uniquely identifies a billing profile.
String	billingRequestId() Get the billingRequestId property: The ID of the billing request that was created for the role assignment.
String	createdByPrincipalId() Get the createdByPrincipalId property: The object ID of the user who created the role assignment.
String	createdByPrincipalPuid() Get the createdByPrincipalPuid property: The principal PUID of the user who created the role assignment.
String	createdByPrincipalTenantId() Get the createdByPrincipalTenantId property: The tenant Id of the user who created the role assignment.
String	createdByUserEmailAddress() Get the createdByUserEmailAddress property: The email address of the user who created the role assignment.
OffsetDateTime	createdOn() Get the createdOn property: The date the role assignment was created.
String	customerDisplayName() Get the customerDisplayName property: The name of the customer.
String	customerId() Get the customerId property: The fully qualified ID that uniquely identifies a customer.
static BillingRoleAssignmentProperties	fromJson(JsonReader jsonReader) Reads an instance of BillingRoleAssignmentProperties from the JsonReader.
String	invoiceSectionDisplayName() Get the invoiceSectionDisplayName property: The name of the invoice section.
String	invoiceSectionId() Get the invoiceSectionId property: The fully qualified ID that uniquely identifies an invoice section.
String	modifiedByPrincipalId() Get the modifiedByPrincipalId property: The principal PUID of the user who modified the role assignment.
String	modifiedByPrincipalPuid() Get the modifiedByPrincipalPuid property: The principal PUID of the user who modified the role assignment.
String	modifiedByPrincipalTenantId() Get the modifiedByPrincipalTenantId property: The tenant Id of the user who modified the role assignment.
String	modifiedByUserEmailAddress() Get the modifiedByUserEmailAddress property: The email address of the user who modified the role assignment.
OffsetDateTime	modifiedOn() Get the modifiedOn property: The date the role assignment was modified.
String	principalDisplayName() Get the principalDisplayName property: The display name of the principal to whom the role was assigned.
String	principalId() Get the principalId property: The object id of the user to whom the role was assigned.
String	principalPuid() Get the principalPuid property: The principal PUID of the user to whom the role was assigned.
String	principalTenantId() Get the principalTenantId property: The principal tenant id of the user to whom the role was assigned.
String	principalTenantName() Get the principalTenantName property: The friendly name of the tenant of the user to whom the role was assigned.
PrincipalType	principalType() Get the principalType property: The type of a role Assignment.
ProvisioningState	provisioningState() Get the provisioningState property: The provisioning state of the resource during a long-running operation.
String	roleDefinitionId() Get the roleDefinitionId property: The ID of the role definition.
String	scope() Get the scope property: The scope at which the role was assigned.
JsonWriter	toJson(JsonWriter jsonWriter)
String	userAuthenticationType() Get the userAuthenticationType property: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned.
String	userEmailAddress() Get the userEmailAddress property: The email address of the user to whom the role was assigned.
void	validate() Validates the instance.
BillingRoleAssignmentProperties	withPrincipalId(String principalId) Set the principalId property: The object id of the user to whom the role was assigned.
BillingRoleAssignmentProperties	withPrincipalPuid(String principalPuid) Set the principalPuid property: The principal PUID of the user to whom the role was assigned.
BillingRoleAssignmentProperties	withPrincipalTenantId(String principalTenantId) Set the principalTenantId property: The principal tenant id of the user to whom the role was assigned.
BillingRoleAssignmentProperties	withRoleDefinitionId(String roleDefinitionId) Set the roleDefinitionId property: The ID of the role definition.
BillingRoleAssignmentProperties	withScope(String scope) Set the scope property: The scope at which the role was assigned.
BillingRoleAssignmentProperties	withUserAuthenticationType(String userAuthenticationType) Set the userAuthenticationType property: The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned.
BillingRoleAssignmentProperties	withUserEmailAddress(String userEmailAddress) Set the userEmailAddress property: The email address of the user to whom the role was assigned.

Methods inherited from java.lang.Object

clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Constructor Details

BillingRoleAssignmentProperties

public BillingRoleAssignmentProperties()

Creates an instance of BillingRoleAssignmentProperties class.

Method Details

billingAccountDisplayName

public String billingAccountDisplayName()

Get the billingAccountDisplayName property: The name of the billing account.

Returns:

the billingAccountDisplayName value.

billingAccountId

public String billingAccountId()

Get the billingAccountId property: The fully qualified ID that uniquely identifies a billing account.

Returns:

the billingAccountId value.

billingProfileDisplayName

public String billingProfileDisplayName()

Get the billingProfileDisplayName property: The name of the billing profile.

Returns:

the billingProfileDisplayName value.

billingProfileId

public String billingProfileId()

Get the billingProfileId property: The fully qualified ID that uniquely identifies a billing profile.

Returns:

the billingProfileId value.

billingRequestId

public String billingRequestId()

Get the billingRequestId property: 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.

Returns:

the billingRequestId value.

createdByPrincipalId

public String createdByPrincipalId()

Get the createdByPrincipalId property: The object ID of the user who created the role assignment.

Returns:

the createdByPrincipalId value.

createdByPrincipalPuid

public String createdByPrincipalPuid()

Get the createdByPrincipalPuid property: The principal PUID of the user who created the role assignment.

Returns:

the createdByPrincipalPuid value.

createdByPrincipalTenantId

public String createdByPrincipalTenantId()

Get the createdByPrincipalTenantId property: The tenant Id of the user who created the role assignment.

Returns:

the createdByPrincipalTenantId value.

createdByUserEmailAddress

public String createdByUserEmailAddress()

Get the createdByUserEmailAddress property: The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement.

Returns:

the createdByUserEmailAddress value.

createdOn

public OffsetDateTime createdOn()

Get the createdOn property: The date the role assignment was created.

Returns:

the createdOn value.

customerDisplayName

public String customerDisplayName()

Get the customerDisplayName property: The name of the customer.

Returns:

the customerDisplayName value.

customerId

public String customerId()

Get the customerId property: The fully qualified ID that uniquely identifies a customer.

Returns:

the customerId value.

fromJson

public static BillingRoleAssignmentProperties fromJson(JsonReader jsonReader)

Reads an instance of BillingRoleAssignmentProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

An instance of BillingRoleAssignmentProperties if the JsonReader was pointing to an instance of it, or null if it was pointing to JSON null.

Throws:

IOException

- If the deserialized JSON object was missing any required properties.

invoiceSectionDisplayName

public String invoiceSectionDisplayName()

Get the invoiceSectionDisplayName property: The name of the invoice section.

Returns:

the invoiceSectionDisplayName value.

invoiceSectionId

public String invoiceSectionId()

Get the invoiceSectionId property: The fully qualified ID that uniquely identifies an invoice section.

Returns:

the invoiceSectionId value.

modifiedByPrincipalId

public String modifiedByPrincipalId()

Get the modifiedByPrincipalId property: The principal PUID of the user who modified the role assignment.

Returns:

the modifiedByPrincipalId value.

modifiedByPrincipalPuid

public String modifiedByPrincipalPuid()

Get the modifiedByPrincipalPuid property: The principal PUID of the user who modified the role assignment.

Returns:

the modifiedByPrincipalPuid value.

modifiedByPrincipalTenantId

public String modifiedByPrincipalTenantId()

Get the modifiedByPrincipalTenantId property: The tenant Id of the user who modified the role assignment.

Returns:

the modifiedByPrincipalTenantId value.

modifiedByUserEmailAddress

public String modifiedByUserEmailAddress()

Get the modifiedByUserEmailAddress property: The email address of the user who modified the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement.

Returns:

the modifiedByUserEmailAddress value.

modifiedOn

public OffsetDateTime modifiedOn()

Get the modifiedOn property: The date the role assignment was modified.

Returns:

the modifiedOn value.

principalDisplayName

public String principalDisplayName()

Get the principalDisplayName property: The display name of the principal to whom the role was assigned.

Returns:

the principalDisplayName value.

principalId

public String principalId()

Get the principalId property: The object id of the user to whom the role was assigned.

Returns:

the principalId value.

principalPuid

public String principalPuid()

Get the principalPuid property: The principal PUID of the user to whom the role was assigned.

Returns:

the principalPuid value.

principalTenantId

public String principalTenantId()

Get the principalTenantId property: The principal tenant id of the user to whom the role was assigned.

Returns:

the principalTenantId value.

principalTenantName

public String principalTenantName()

Get the principalTenantName property: 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.

Returns:

the principalTenantName value.

principalType

public PrincipalType principalType()

Get the principalType property: The type of a role Assignment.

Returns:

the principalType value.

provisioningState

public ProvisioningState provisioningState()

Get the provisioningState property: The provisioning state of the resource during a long-running operation.

Returns:

the provisioningState value.

roleDefinitionId

public String roleDefinitionId()

Get the roleDefinitionId property: The ID of the role definition.

Returns:

the roleDefinitionId value.

scope

public String scope()

Get the scope property: The scope at which the role was assigned.

Returns:

the scope value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

IOException

userAuthenticationType

public String userAuthenticationType()

Get the userAuthenticationType property: 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.

Returns:

the userAuthenticationType value.

userEmailAddress

public String userEmailAddress()

Get the userEmailAddress property: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement.

Returns:

the userEmailAddress value.

validate

public void validate()

Validates the instance.

withPrincipalId

public BillingRoleAssignmentProperties withPrincipalId(String principalId)

Set the principalId property: The object id of the user to whom the role was assigned.

Parameters:

principalId - the principalId value to set.

Returns:

the BillingRoleAssignmentProperties object itself.

withPrincipalPuid

public BillingRoleAssignmentProperties withPrincipalPuid(String principalPuid)

Set the principalPuid property: The principal PUID of the user to whom the role was assigned.

Parameters:

principalPuid - the principalPuid value to set.

Returns:

the BillingRoleAssignmentProperties object itself.

withPrincipalTenantId

public BillingRoleAssignmentProperties withPrincipalTenantId(String principalTenantId)

Set the principalTenantId property: The principal tenant id of the user to whom the role was assigned.

Parameters:

principalTenantId - the principalTenantId value to set.

Returns:

the BillingRoleAssignmentProperties object itself.

withRoleDefinitionId

public BillingRoleAssignmentProperties withRoleDefinitionId(String roleDefinitionId)

Set the roleDefinitionId property: The ID of the role definition.

Parameters:

roleDefinitionId - the roleDefinitionId value to set.

Returns:

the BillingRoleAssignmentProperties object itself.

withScope

public BillingRoleAssignmentProperties withScope(String scope)

Set the scope property: The scope at which the role was assigned.

Parameters:

scope - the scope value to set.

Returns:

the BillingRoleAssignmentProperties object itself.

withUserAuthenticationType

public BillingRoleAssignmentProperties withUserAuthenticationType(String userAuthenticationType)

Set the userAuthenticationType property: 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.

Parameters:

userAuthenticationType - the userAuthenticationType value to set.

Returns:

the BillingRoleAssignmentProperties object itself.

withUserEmailAddress

public BillingRoleAssignmentProperties withUserEmailAddress(String userEmailAddress)

Set the userEmailAddress property: The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement.

Parameters:

userEmailAddress - the userEmailAddress value to set.

Returns:

the BillingRoleAssignmentProperties object itself.