BillingRequestProperties Class

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

Implements

public final class BillingRequestProperties
implements JsonSerializable<BillingRequestProperties>

A request submitted by a user to manage billing. Users with an owner role on the scope can approve or decline these requests.

Constructor Summary

Constructor Description
BillingRequestProperties()

Creates an instance of BillingRequestProperties class.

Method Summary

Modifier and Type Method and Description
Map<String,String> additionalInformation()

Get the additionalInformation property: Additional information for the billing request.

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 billingAccountName()

Get the billingAccountName property: The ID that uniquely identifies a billing account.

String billingAccountPrimaryBillingTenantId()

Get the billingAccountPrimaryBillingTenantId property: The primary tenant ID of the billing account for which the billing request was submitted.

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 billingProfileName()

Get the billingProfileName property: The ID that uniquely identifies a billing profile.

String billingScope()

Get the billingScope property: The billing scope for which the request will be applied.

BillingRequestPropertiesCreatedBy createdBy()

Get the createdBy property: The principal of the entity who created the request.

OffsetDateTime creationDate()

Get the creationDate property: The date and time when the request 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.

String customerName()

Get the customerName property: The ID that uniquely identifies a customer.

String decisionReason()

Get the decisionReason property: The reason to approve or decline the request.

OffsetDateTime expirationDate()

Get the expirationDate property: The date and time when the request expires.

static BillingRequestProperties fromJson(JsonReader jsonReader)

Reads an instance of BillingRequestProperties 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 invoiceSectionName()

Get the invoiceSectionName property: The ID that uniquely identifies an invoice section.

String justification()

Get the justification property: Justification for submitting request.

BillingRequestPropertiesLastUpdatedBy lastUpdatedBy()

Get the lastUpdatedBy property: The principal of the entity who last updated the request.

OffsetDateTime lastUpdatedDate()

Get the lastUpdatedDate property: Date and time of last update.

ProvisioningState provisioningState()

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

List<Principal> recipients()

Get the recipients property: The recipients of the billing request.

String requestScope()

Get the requestScope property: The billing scope for which the request was submitted (ex.

OffsetDateTime reviewalDate()

Get the reviewalDate property: The date and time when the request was reviewed.

BillingRequestPropertiesReviewedBy reviewedBy()

Get the reviewedBy property: The principal of the request reviewer.

BillingRequestStatus status()

Get the status property: Status of billing request.

String subscriptionDisplayName()

Get the subscriptionDisplayName property: The name of the billing subscription.

String subscriptionId()

Get the subscriptionId property: The fully qualified ID that uniquely identifies a billing subscription.

String subscriptionName()

Get the subscriptionName property: The ID that uniquely identifies a billing subscription.

JsonWriter toJson(JsonWriter jsonWriter)
BillingRequestType type()

Get the type property: Type of billing request.

void validate()

Validates the instance.

BillingRequestProperties withAdditionalInformation(Map<String,String> additionalInformation)

Set the additionalInformation property: Additional information for the billing request.

BillingRequestProperties withCreatedBy(BillingRequestPropertiesCreatedBy createdBy)

Set the createdBy property: The principal of the entity who created the request.

BillingRequestProperties withDecisionReason(String decisionReason)

Set the decisionReason property: The reason to approve or decline the request.

BillingRequestProperties withJustification(String justification)

Set the justification property: Justification for submitting request.

BillingRequestProperties withLastUpdatedBy(BillingRequestPropertiesLastUpdatedBy lastUpdatedBy)

Set the lastUpdatedBy property: The principal of the entity who last updated the request.

BillingRequestProperties withRecipients(List<Principal> recipients)

Set the recipients property: The recipients of the billing request.

BillingRequestProperties withRequestScope(String requestScope)

Set the requestScope property: The billing scope for which the request was submitted (ex.

BillingRequestProperties withReviewedBy(BillingRequestPropertiesReviewedBy reviewedBy)

Set the reviewedBy property: The principal of the request reviewer.

BillingRequestProperties withStatus(BillingRequestStatus status)

Set the status property: Status of billing request.

BillingRequestProperties withType(BillingRequestType type)

Set the type property: Type of billing request.

Methods inherited from java.lang.Object

Constructor Details

BillingRequestProperties

public BillingRequestProperties()

Creates an instance of BillingRequestProperties class.

Method Details

additionalInformation

public Map<String,String> additionalInformation()

Get the additionalInformation property: Additional information for the billing request.

Returns:

the additionalInformation value.

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.

billingAccountName

public String billingAccountName()

Get the billingAccountName property: The ID that uniquely identifies a billing account.

Returns:

the billingAccountName value.

billingAccountPrimaryBillingTenantId

public String billingAccountPrimaryBillingTenantId()

Get the billingAccountPrimaryBillingTenantId property: The primary tenant ID of the billing account for which the billing request was submitted.

Returns:

the billingAccountPrimaryBillingTenantId 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.

billingProfileName

public String billingProfileName()

Get the billingProfileName property: The ID that uniquely identifies a billing profile.

Returns:

the billingProfileName value.

billingScope

public String billingScope()

Get the billingScope property: The billing scope for which the request will be applied. This is a read only property derived by the service.

Returns:

the billingScope value.

createdBy

public BillingRequestPropertiesCreatedBy createdBy()

Get the createdBy property: The principal of the entity who created the request.

Returns:

the createdBy value.

creationDate

public OffsetDateTime creationDate()

Get the creationDate property: The date and time when the request was created.

Returns:

the creationDate 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.

customerName

public String customerName()

Get the customerName property: The ID that uniquely identifies a customer.

Returns:

the customerName value.

decisionReason

public String decisionReason()

Get the decisionReason property: The reason to approve or decline the request.

Returns:

the decisionReason value.

expirationDate

public OffsetDateTime expirationDate()

Get the expirationDate property: The date and time when the request expires.

Returns:

the expirationDate value.

fromJson

public static BillingRequestProperties fromJson(JsonReader jsonReader)

Reads an instance of BillingRequestProperties from the JsonReader.

Parameters:

jsonReader - The JsonReader being read.

Returns:

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

Throws:

IOException

- If an error occurs while reading the BillingRequestProperties.

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.

invoiceSectionName

public String invoiceSectionName()

Get the invoiceSectionName property: The ID that uniquely identifies an invoice section.

Returns:

the invoiceSectionName value.

justification

public String justification()

Get the justification property: Justification for submitting request.

Returns:

the justification value.

lastUpdatedBy

public BillingRequestPropertiesLastUpdatedBy lastUpdatedBy()

Get the lastUpdatedBy property: The principal of the entity who last updated the request.

Returns:

the lastUpdatedBy value.

lastUpdatedDate

public OffsetDateTime lastUpdatedDate()

Get the lastUpdatedDate property: Date and time of last update.

Returns:

the lastUpdatedDate value.

provisioningState

public ProvisioningState provisioningState()

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

Returns:

the provisioningState value.

recipients

public List<Principal> recipients()

Get the recipients property: The recipients of the billing request.

Returns:

the recipients value.

requestScope

public String requestScope()

Get the requestScope property: The billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}').

Returns:

the requestScope value.

reviewalDate

public OffsetDateTime reviewalDate()

Get the reviewalDate property: The date and time when the request was reviewed.

Returns:

the reviewalDate value.

reviewedBy

public BillingRequestPropertiesReviewedBy reviewedBy()

Get the reviewedBy property: The principal of the request reviewer. Will only be set if request is approved.

Returns:

the reviewedBy value.

status

public BillingRequestStatus status()

Get the status property: Status of billing request.

Returns:

the status value.

subscriptionDisplayName

public String subscriptionDisplayName()

Get the subscriptionDisplayName property: The name of the billing subscription.

Returns:

the subscriptionDisplayName value.

subscriptionId

public String subscriptionId()

Get the subscriptionId property: The fully qualified ID that uniquely identifies a billing subscription.

Returns:

the subscriptionId value.

subscriptionName

public String subscriptionName()

Get the subscriptionName property: The ID that uniquely identifies a billing subscription.

Returns:

the subscriptionName value.

toJson

public JsonWriter toJson(JsonWriter jsonWriter)

Parameters:

jsonWriter

Throws:

type

public BillingRequestType type()

Get the type property: Type of billing request.

Returns:

the type value.

validate

public void validate()

Validates the instance.

withAdditionalInformation

public BillingRequestProperties withAdditionalInformation(Map<String,String> additionalInformation)

Set the additionalInformation property: Additional information for the billing request.

Parameters:

additionalInformation - the additionalInformation value to set.

Returns:

the BillingRequestProperties object itself.

withCreatedBy

public BillingRequestProperties withCreatedBy(BillingRequestPropertiesCreatedBy createdBy)

Set the createdBy property: The principal of the entity who created the request.

Parameters:

createdBy - the createdBy value to set.

Returns:

the BillingRequestProperties object itself.

withDecisionReason

public BillingRequestProperties withDecisionReason(String decisionReason)

Set the decisionReason property: The reason to approve or decline the request.

Parameters:

decisionReason - the decisionReason value to set.

Returns:

the BillingRequestProperties object itself.

withJustification

public BillingRequestProperties withJustification(String justification)

Set the justification property: Justification for submitting request.

Parameters:

justification - the justification value to set.

Returns:

the BillingRequestProperties object itself.

withLastUpdatedBy

public BillingRequestProperties withLastUpdatedBy(BillingRequestPropertiesLastUpdatedBy lastUpdatedBy)

Set the lastUpdatedBy property: The principal of the entity who last updated the request.

Parameters:

lastUpdatedBy - the lastUpdatedBy value to set.

Returns:

the BillingRequestProperties object itself.

withRecipients

public BillingRequestProperties withRecipients(List<Principal> recipients)

Set the recipients property: The recipients of the billing request.

Parameters:

recipients - the recipients value to set.

Returns:

the BillingRequestProperties object itself.

withRequestScope

public BillingRequestProperties withRequestScope(String requestScope)

Set the requestScope property: The billing scope for which the request was submitted (ex. '/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}').

Parameters:

requestScope - the requestScope value to set.

Returns:

the BillingRequestProperties object itself.

withReviewedBy

public BillingRequestProperties withReviewedBy(BillingRequestPropertiesReviewedBy reviewedBy)

Set the reviewedBy property: The principal of the request reviewer. Will only be set if request is approved.

Parameters:

reviewedBy - the reviewedBy value to set.

Returns:

the BillingRequestProperties object itself.

withStatus

public BillingRequestProperties withStatus(BillingRequestStatus status)

Set the status property: Status of billing request.

Parameters:

status - the status value to set.

Returns:

the BillingRequestProperties object itself.

withType

public BillingRequestProperties withType(BillingRequestType type)

Set the type property: Type of billing request.

Parameters:

type - the type value to set.

Returns:

the BillingRequestProperties object itself.

Applies to