conditional_credit_contributors

Creates, updates, deletes, gets or lists a conditional_credit_contributors resource.

Overview

Name	conditional_credit_contributors
Type	Resource
Id	azure.billing_benefits.conditional_credit_contributors

Fields

The following fields are returned by SELECT queries:

get_from_primary

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
benefitResourceId	string	Fully-qualified identifier of the benefit under applicable benefit list.
billingAccountResourceId	string	The billing account resource ID.
displayName	string	Display name for the conditional credit.
endAt	string (date-time)	End date of the conditional credit (derived from last milestone).
entityType	string	Type of conditional credit entity. Required. CONTRIBUTOR.
milestones	array	List of milestones copied from primary conditional credit (excludes award details).
primaryBillingAccountResourceId	string	Fully-qualified billing account resource identifier of the primary CACO. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}.
primaryResourceId	string	Resource ID of the primary conditional credit (required for contributors).
productCode	string	Product code for the conditional credit.
provisioningState	string	The provisioning state of the resource. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", and "Pending". (Unknown, Succeeded, Failed, Canceled, Pending)
resourceId	string	Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}.
startAt	string (date-time)	Start date of the conditional credit.
status	string	The status of the conditional credit. Known values are: "Unknown", "Scheduled", "Active", "Pending", "Failed", "Canceled", "Completed", "Stopped", and "PendingSettlement". (Unknown, Scheduled, Active, Pending, Failed, Canceled, Completed, Stopped, PendingSettlement)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemId	string	System identifier shared between primary and contributor conditional credits representing the same conditional credit program.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_from_primary

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
benefitResourceId	string	Fully-qualified identifier of the benefit under applicable benefit list.
billingAccountResourceId	string	The billing account resource ID.
displayName	string	Display name for the conditional credit.
endAt	string (date-time)	End date of the conditional credit (derived from last milestone).
entityType	string	Type of conditional credit entity. Required. CONTRIBUTOR.
milestones	array	List of milestones copied from primary conditional credit (excludes award details).
primaryBillingAccountResourceId	string	Fully-qualified billing account resource identifier of the primary CACO. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}.
primaryResourceId	string	Resource ID of the primary conditional credit (required for contributors).
productCode	string	Product code for the conditional credit.
provisioningState	string	The provisioning state of the resource. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", and "Pending". (Unknown, Succeeded, Failed, Canceled, Pending)
resourceId	string	Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}.
startAt	string (date-time)	Start date of the conditional credit.
status	string	The status of the conditional credit. Known values are: "Unknown", "Scheduled", "Active", "Pending", "Failed", "Canceled", "Completed", "Stopped", and "PendingSettlement". (Unknown, Scheduled, Active, Pending, Failed, Canceled, Completed, Stopped, PendingSettlement)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemId	string	System identifier shared between primary and contributor conditional credits representing the same conditional credit program.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_from_applicable_conditional_credit

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
benefitResourceId	string	Fully-qualified identifier of the benefit under applicable benefit list.
billingAccountResourceId	string	The billing account resource ID.
displayName	string	Display name for the conditional credit.
endAt	string (date-time)	End date of the conditional credit (derived from last milestone).
entityType	string	Type of conditional credit entity. Required. CONTRIBUTOR.
milestones	array	List of milestones copied from primary conditional credit (excludes award details).
primaryBillingAccountResourceId	string	Fully-qualified billing account resource identifier of the primary CACO. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}.
primaryResourceId	string	Resource ID of the primary conditional credit (required for contributors).
productCode	string	Product code for the conditional credit.
provisioningState	string	The provisioning state of the resource. Known values are: "Unknown", "Succeeded", "Failed", "Canceled", and "Pending". (Unknown, Succeeded, Failed, Canceled, Pending)
resourceId	string	Fully-qualified resource identifier of the resource. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/{benefitType}/{benefitName}.
startAt	string (date-time)	Start date of the conditional credit.
status	string	The status of the conditional credit. Known values are: "Unknown", "Scheduled", "Active", "Pending", "Failed", "Canceled", "Completed", "Stopped", and "PendingSettlement". (Unknown, Scheduled, Active, Pending, Failed, Canceled, Completed, Stopped, PendingSettlement)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemId	string	System identifier shared between primary and contributor conditional credits representing the same conditional credit program.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_from_primary	select	resource_group_name, conditional_credit_name, contributor_name, subscription_id		Get a conditional credit contributor for primary service admin.
list_from_primary	select	resource_group_name, conditional_credit_name, subscription_id		List contributors under a primary conditional credit for primary service admin.
list_from_applicable_conditional_credit	select	billing_account_id, system_id		List contributors under applicable conditional credits for a given billing account.

Parameters

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

Name	Datatype	Description
billing_account_id	string	The billing account Id at which the benefits are listed. Accepted format is: {rootId:orgId}. Required.
conditional_credit_name	string	Name of the conditional credit. Required.
contributor_name	string	Unique name of contributor in the format {contributorCloudSubId}{resourceGroupName}{nameInContributorTenant}. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
system_id	string	System ID of the primary MACC. Required.

SELECT examples

get_from_primary

Get a conditional credit contributor for primary service admin.

SELECT
id,
name,
benefitResourceId,
billingAccountResourceId,
displayName,
endAt,
entityType,
milestones,
primaryBillingAccountResourceId,
primaryResourceId,
productCode,
provisioningState,
resourceId,
startAt,
status,
systemData,
systemId,
type
FROM azure.billing_benefits.conditional_credit_contributors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND conditional_credit_name = '{{ conditional_credit_name }}' -- required
AND contributor_name = '{{ contributor_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_from_primary

List contributors under a primary conditional credit for primary service admin.

SELECT
id,
name,
benefitResourceId,
billingAccountResourceId,
displayName,
endAt,
entityType,
milestones,
primaryBillingAccountResourceId,
primaryResourceId,
productCode,
provisioningState,
resourceId,
startAt,
status,
systemData,
systemId,
type
FROM azure.billing_benefits.conditional_credit_contributors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND conditional_credit_name = '{{ conditional_credit_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_from_applicable_conditional_credit

List contributors under applicable conditional credits for a given billing account.

SELECT
id,
name,
benefitResourceId,
billingAccountResourceId,
displayName,
endAt,
entityType,
milestones,
primaryBillingAccountResourceId,
primaryResourceId,
productCode,
provisioningState,
resourceId,
startAt,
status,
systemData,
systemId,
type
FROM azure.billing_benefits.conditional_credit_contributors
WHERE billing_account_id = '{{ billing_account_id }}' -- required
AND system_id = '{{ system_id }}' -- required
;