@azure/arm-billing-trust package

Classes

BillingTrustClient

Interfaces

Assessment	A billing trust assessment. An assessment runs a set of rules to evaluate trust attributes of a billing account. The assessment is a singleton per parent resource and is always named 'default'. Re-issuing PUT with the same assessmentType is idempotent; changing assessmentType after the assessment exists is not supported.
AssessmentProperties	The properties of an Assessment resource
AssessmentsCreateOrUpdateOptionalParams	Optional parameters.
AssessmentsDeleteOptionalParams	Optional parameters.
AssessmentsGetOptionalParams	Optional parameters.
AssessmentsListOptionalParams	Optional parameters.
AssessmentsListUploadTokenOptionalParams	Optional parameters.
AssessmentsOperations	Interface representing a Assessments operations.
BillingTrustClientOptionalParams	Optional parameters for the client.
BusinessVerificationRulePatchProperties	Patch body for a businessVerification rule. Settable while evaluationState is pending or actionRequired. externalId lets the customer disambiguate an ambiguous verification match (e.g. via DUNS); supplementalDocuments carries references to documents uploaded via the assessment-scoped upload-token action.
BusinessVerificationRuleProperties	Properties of a business verification rule. Verifies the billing account's business identity. Sold-to fields (soldTo, registrationNumber, taxIds) reflect the billing account's information on file and cannot be supplied by end users.
DomainEntry	A domain entry within an education qualification rule. domainNames and tenantId are supplied on creation; state and error are returned by the service.
EduInitialValue	Initial values for an education qualification rule. Per-domain entries (domainNames + tenantId) are used to populate the rule when the assessment is created.
EduQualificationRulePatchProperties	Patch body for an eduQualification rule. Only supplementalDocuments is settable, and only when evaluationState == actionRequired.
EduQualificationRuleProperties	Properties of an eduQualification rule. Verifies education-domain ownership for a billing account.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Common error response for all Azure Resource Manager APIs to return error details for failed operations.
ExtensionResource	The base extension resource.
ExternalId	External-registry identifier (e.g. DUNS) used to disambiguate ambiguous verification matches.
GenerateUploadTokenResponse	Response containing an upload token for supplemental document uploads
InitialRuleValueBase	Base type for write-only initial values supplied when creating an assessment. Polymorphic by kind; per-kind initial values forward into the corresponding rule.
Operation	Details of a REST API operation, returned from the Resource Provider Operations API
OperationDisplay	Localized display information for an operation.
OperationsListOptionalParams	Optional parameters.
OperationsOperations	Interface representing a Operations operations.
PageSettings	Options for the byPage method
PagedAsyncIterableIterator	An interface that allows async iterable iteration both to completion and by page.
ProxyResource	The resource model definition for a Azure Resource Manager proxy resource. It will not have tags and a location
RegistrationNumber	Registration number context for business verification.
Resource	Common fields that are returned in the response for all Azure Resource Manager resources
RestorePollerOptions
Rule	A rule within an assessment
RulePatchProperties	Patch body for updating a rule. Polymorphic by kind — kind-specific patchable fields live on per-kind subtypes. PATCH cannot change a rule's kind; the discriminator carries the rule's existing kind for routing only.
RuleProperties	Base properties of a Rule resource. Polymorphic by kind — kind-specific writable fields live on derived models.
RulesCreateOrUpdateOptionalParams	Optional parameters.
RulesGetOptionalParams	Optional parameters.
RulesListOptionalParams	Optional parameters.
RulesOperations	Interface representing a Rules operations.
RulesUpdateOptionalParams	Optional parameters.
SoldTo	Sold-to identity used for business verification. Data classification — Personally Identifiable Information (PII): This model carries customer/contact PII (names, email, phone, postal address). Producers (service code paths populating SoldTo) and consumers (anything emitting it to logs / telemetry) MUST treat individual field values as PII and avoid clear-text logging. BillingTrust's existing runtime discipline keeps SoldTo out of Geneva logs (see Services/Rpaas/RpaasRuleProjector.cs — raw bodies and parsed error messages are filtered before emission). Downstream consumers of the public OpenAPI surface should follow the same convention. Tracked for follow-up alignment with ARM ARG002 (control-plane PII guidance) — see PR description.
SystemData	Metadata pertaining to creation and last modification of the resource.
TaxId	Tax id entry associated with the sold-to identity.

Type Aliases

ActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs. KnownActionType can be used interchangeably with ActionType, this enum contains the known values that the service supports. Known values supported by the service Internal: Actions are for internal-only APIs.
AssessmentState	The aggregated evaluation state of an assessment, derived from its rules KnownAssessmentState can be used interchangeably with AssessmentState, this enum contains the known values that the service supports. Known values supported by the service pending: One or more rules have not reached a steady state running: One or more rules are currently being evaluated actionRequired: One or more rules require user action underReview: One or more rules require manual review failed: All rules reached a steady state, and the last non-skipped rule failed succeeded: All rules reached a steady state, and the last non-skipped rule succeeded succeededWithOverride: Assessment succeeded but with a manual override applied by operations failedWithOverride: Assessment failed but with a manual override applied by operations expired: Assessment expired and requires re-evaluation
AssessmentType	Assessment template name. Each template defines a fixed set of rules and their configuration. The list of templates may be extended in future API versions. KnownAssessmentType can be used interchangeably with AssessmentType, this enum contains the known values that the service supports. Known values supported by the service Edu: Education qualification assessment. Verifies that the billing account qualifies for education programs based on customer-supplied domains. BusinessVerification: Business verification assessment. Verifies the billing account's business identity against the sold-to information on file. PayeeEnrollment: Payee enrollment assessment. Verifies a billing account is eligible to enroll as a payee. Rule names within this template may change between API versions — iterate rules via LIST rather than addressing rules by name. PayeeProfile: Payee profile assessment. Verifies the payee profile associated with a billing account. Rule names within this template may change between API versions — iterate rules via LIST rather than addressing rules by name.
AzureSupportedClouds	The supported values for cloud setting as a string literal type
ContinuablePage	An interface that describes a page of results.
CreatedByType	The kind of entity that created the resource. KnownCreatedByType can be used interchangeably with CreatedByType, this enum contains the known values that the service supports. Known values supported by the service User: The entity was created by a user. Application: The entity was created by an application. ManagedIdentity: The entity was created by a managed identity. Key: The entity was created by a key.
DomainEntryState	The verification state of a single domain entry within an eduQualification rule KnownDomainEntryState can be used interchangeably with DomainEntryState, this enum contains the known values that the service supports. Known values supported by the service pending: Domain verification queued or in progress actionRequired: Customer must supply additional evidence (e.g. supplemental documents) failed: Domain verification failed succeeded: Domain verification succeeded
InitialRuleValueBaseUnion	Alias for InitialRuleValueBaseUnion
Origin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system" KnownOrigin can be used interchangeably with Origin, this enum contains the known values that the service supports. Known values supported by the service user: Indicates the operation is initiated by a user. system: Indicates the operation is initiated by a system. user,system: Indicates the operation is initiated by a user or system.
ProvisioningState	The status of the current operation KnownProvisioningState can be used interchangeably with ProvisioningState, this enum contains the known values that the service supports. Known values supported by the service Succeeded: Resource has been created. Failed: Resource creation failed. Canceled: Resource creation was canceled. Provisioning: The resource is being provisioned Updating: The resource is updating Accepted: The resource create request has been accepted
RegistrationRequirement	Whether a registration number is required for the sold-to country. Extensible — additional states may be introduced as country-specific tax requirements evolve. KnownRegistrationRequirement can be used interchangeably with RegistrationRequirement, this enum contains the known values that the service supports. Known values supported by the service required: A registration number is required for the sold-to country. optional: A registration number is optional for the sold-to country. notApplicable: A registration number is not applicable for the sold-to country.
RuleKind	The kind of rule. Additional kinds may be added in future API versions. KnownRuleKind can be used interchangeably with RuleKind, this enum contains the known values that the service supports. Known values supported by the service eduQualification: Education qualification rule. Verifies education-domain ownership for the billing account. businessVerification: Business verification rule. Verifies the business identity of the billing account.
RulePatchPropertiesUnion	Alias for RulePatchPropertiesUnion
RulePropertiesUnion	Alias for RulePropertiesUnion
RuleState	The evaluation state of a rule KnownRuleState can be used interchangeably with RuleState, this enum contains the known values that the service supports. Known values supported by the service pending: Rule is queued and not yet evaluated running: Rule evaluation is in progress actionRequired: Customer input is required to proceed underReview: Operations review is in progress skipped: Rule preconditions (runAfter) were not met; rule was skipped failed: Rule evaluation failed succeeded: Rule evaluation succeeded succeededWithOverride: Rule succeeded but with a manual override applied by operations failedWithOverride: Rule failed but with a manual override applied by operations expired: Rule expired and requires re-evaluation
TaxIdStatus	Status of a tax id record. KnownTaxIdStatus can be used interchangeably with TaxIdStatus, this enum contains the known values that the service supports. Known values supported by the service valid: The tax id has been verified and is currently valid. invalid: The tax id is no longer valid (e.g. expired or revoked). other: Status could not be determined from the upstream registry.

Enums

AzureClouds	An enum to describe Azure Cloud environments.
KnownActionType	Extensible enum. Indicates the action type. "Internal" refers to actions that are for internal only APIs.
KnownAssessmentState	The aggregated evaluation state of an assessment, derived from its rules
KnownAssessmentType	Assessment template name. Each template defines a fixed set of rules and their configuration. The list of templates may be extended in future API versions.
KnownCreatedByType	The kind of entity that created the resource.
KnownDomainEntryState	The verification state of a single domain entry within an eduQualification rule
KnownOrigin	The intended executor of the operation; as in Resource Based Access Control (RBAC) and audit logs UX. Default value is "user,system"
KnownProvisioningState	The status of the current operation
KnownRegistrationRequirement	Whether a registration number is required for the sold-to country. Extensible — additional states may be introduced as country-specific tax requirements evolve.
KnownRuleKind	The kind of rule. Additional kinds may be added in future API versions.
KnownRuleState	The evaluation state of a rule
KnownTaxIdStatus	Status of a tax id record.
KnownVersions	Supported API Versions for Microsoft.BillingTrust

Functions

isRestError(unknown)	Typeguard for RestError
restorePoller<TResponse, TResult>(BillingTrustClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)	Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

Variables

RestError

A custom error type for failed pipeline requests.

Function Details

isRestError(unknown)

Typeguard for RestError

function isRestError(e: unknown): e

Parameters

e

unknown

Something caught by a catch clause.

Returns

e

restorePoller<TResponse, TResult>(BillingTrustClient, string, (args: any[]) => PollerLike<OperationState<TResult>, TResult>, RestorePollerOptions<TResult, PathUncheckedResponse>)

Creates a poller from the serialized state of another poller. This can be useful when you want to create pollers on a different host or a poller needs to be constructed after the original one is not in scope.

function restorePoller<TResponse, TResult>(client: BillingTrustClient, serializedState: string, sourceOperation: (args: any[]) => PollerLike<OperationState<TResult>, TResult>, options?: RestorePollerOptions<TResult, PathUncheckedResponse>): PollerLike<OperationState<TResult>, TResult>

Parameters

client

BillingTrustClient

serializedState

string

sourceOperation

(args: any[]) => PollerLike<OperationState<TResult>, TResult>

options

RestorePollerOptions<TResult, PathUncheckedResponse>

Returns

PollerLike<OperationState<TResult>, TResult>

Variable Details

RestError

A custom error type for failed pipeline requests.

RestError: RestErrorConstructor

Type

RestErrorConstructor