contributors

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

Overview

Name	contributors
Type	Resource
Id	azure.billing_benefits.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.
allowContributors	boolean	Setting this to true means multi-entity.
automaticShortfall	string	Setting this to 'Enable' enables automatic shortfall charging when commitment is not met. Known values are: "Unknown", "Enabled", and "Disabled". (Unknown, Enabled, Disabled)
automaticShortfallSuppressReason	object	Optional field to record suppression reason for automatic shortfall.
billingAccountResourceId	string	Fully-qualified identifier of the billing account where the MACC is applied. Present only for Enterprise Agreement customers. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}.
commitment	object	Commitment towards the benefit.
displayName	string	Display name.
endAt	string (date-time)	Must be end of month. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z.
entityType	string	Represents type of the object being operated on. Possible values are primary or contributor. Required. Known values are: "Primary" and "Contributor". (Primary, Contributor)
milestones	array	List of milestones associated with this MACC.
primaryBillingAccountResourceId	string	Fully-qualified billing account resource identifier of the primary MACC. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}.
primaryResourceId	string	Fully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}.
productCode	string	Represents catalog UPN.
provisioningState	string	Provisioning state of MACC as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of MACC resource, refer to MaccStatus.
resourceId	string	This is the resource identifier of either the primary MACC or the contributor. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}.
shortfall	object	MACC shortfall.
startAt	string (date-time)	Must be start of month. Timestamp must be in the ISO date format YYYY-MM-DDT00:00:00Z.
status	string	Represents the current status of the MACC. Known values are: "Unknown", "Scheduled", "Active", "Pending", "Failed", "Canceled", "Completed", "Stopped", "PendingSettlement", "ShortfallCharged", and "ShortfallWaived". (Unknown, Scheduled, Active, Pending, Failed, Canceled, Completed, Stopped, PendingSettlement, ShortfallCharged, ShortfallWaived)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemId	string	This is the globally unique identifier of the MACC which will not change for the lifetime of the MACC.
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.
allowContributors	boolean	Setting this to true means multi-entity.
automaticShortfall	string	Setting this to 'Enable' enables automatic shortfall charging when commitment is not met. Known values are: "Unknown", "Enabled", and "Disabled". (Unknown, Enabled, Disabled)
automaticShortfallSuppressReason	object	Optional field to record suppression reason for automatic shortfall.
billingAccountResourceId	string	Fully-qualified identifier of the billing account where the MACC is applied. Present only for Enterprise Agreement customers. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}.
commitment	object	Commitment towards the benefit.
displayName	string	Display name.
endAt	string (date-time)	Must be end of month. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z.
entityType	string	Represents type of the object being operated on. Possible values are primary or contributor. Required. Known values are: "Primary" and "Contributor". (Primary, Contributor)
milestones	array	List of milestones associated with this MACC.
primaryBillingAccountResourceId	string	Fully-qualified billing account resource identifier of the primary MACC. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}.
primaryResourceId	string	Fully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}.
productCode	string	Represents catalog UPN.
provisioningState	string	Provisioning state of MACC as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of MACC resource, refer to MaccStatus.
resourceId	string	This is the resource identifier of either the primary MACC or the contributor. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}.
shortfall	object	MACC shortfall.
startAt	string (date-time)	Must be start of month. Timestamp must be in the ISO date format YYYY-MM-DDT00:00:00Z.
status	string	Represents the current status of the MACC. Known values are: "Unknown", "Scheduled", "Active", "Pending", "Failed", "Canceled", "Completed", "Stopped", "PendingSettlement", "ShortfallCharged", and "ShortfallWaived". (Unknown, Scheduled, Active, Pending, Failed, Canceled, Completed, Stopped, PendingSettlement, ShortfallCharged, ShortfallWaived)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemId	string	This is the globally unique identifier of the MACC which will not change for the lifetime of the MACC.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_from_applicable_macc

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.
allowContributors	boolean	Setting this to true means multi-entity.
automaticShortfall	string	Setting this to 'Enable' enables automatic shortfall charging when commitment is not met. Known values are: "Unknown", "Enabled", and "Disabled". (Unknown, Enabled, Disabled)
automaticShortfallSuppressReason	object	Optional field to record suppression reason for automatic shortfall.
billingAccountResourceId	string	Fully-qualified identifier of the billing account where the MACC is applied. Present only for Enterprise Agreement customers. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}.
commitment	object	Commitment towards the benefit.
displayName	string	Display name.
endAt	string (date-time)	Must be end of month. Timestamp must be in the ISO date format YYYY-MM-DDT23:59:59Z.
entityType	string	Represents type of the object being operated on. Possible values are primary or contributor. Required. Known values are: "Primary" and "Contributor". (Primary, Contributor)
milestones	array	List of milestones associated with this MACC.
primaryBillingAccountResourceId	string	Fully-qualified billing account resource identifier of the primary MACC. Format must be Azure Resource ID: /providers/Microsoft.Billing/billingAccounts/{acctId:orgId}.
primaryResourceId	string	Fully-qualified resource identifier of the primary MACC. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}.
productCode	string	Represents catalog UPN.
provisioningState	string	Provisioning state of MACC as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of MACC resource, refer to MaccStatus.
resourceId	string	This is the resource identifier of either the primary MACC or the contributor. Format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BillingBenefits/maccs/{maccName}.
shortfall	object	MACC shortfall.
startAt	string (date-time)	Must be start of month. Timestamp must be in the ISO date format YYYY-MM-DDT00:00:00Z.
status	string	Represents the current status of the MACC. Known values are: "Unknown", "Scheduled", "Active", "Pending", "Failed", "Canceled", "Completed", "Stopped", "PendingSettlement", "ShortfallCharged", and "ShortfallWaived". (Unknown, Scheduled, Active, Pending, Failed, Canceled, Completed, Stopped, PendingSettlement, ShortfallCharged, ShortfallWaived)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemId	string	This is the globally unique identifier of the MACC which will not change for the lifetime of the MACC.
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, macc_name, contributor_name, subscription_id		Get a contributor for primary service admin.
list_from_primary	select	resource_group_name, macc_name, subscription_id		List contributors under a MACC for primary service admin.
list_from_applicable_macc	select	billing_account_id, system_id		List contributors under applicable MACCs 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.
contributor_name	string	Unique name of contributor in the format {contributorCloudSubId}{resourceGroupName}{nameInContributorTenant}. Required.
macc_name	string	Name of primary MACC. 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 contributor for primary service admin.

SELECT
id,
name,
allowContributors,
automaticShortfall,
automaticShortfallSuppressReason,
billingAccountResourceId,
commitment,
displayName,
endAt,
entityType,
milestones,
primaryBillingAccountResourceId,
primaryResourceId,
productCode,
provisioningState,
resourceId,
shortfall,
startAt,
status,
systemData,
systemId,
type
FROM azure.billing_benefits.contributors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND macc_name = '{{ macc_name }}' -- required
AND contributor_name = '{{ contributor_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_from_primary

List contributors under a MACC for primary service admin.

SELECT
id,
name,
allowContributors,
automaticShortfall,
automaticShortfallSuppressReason,
billingAccountResourceId,
commitment,
displayName,
endAt,
entityType,
milestones,
primaryBillingAccountResourceId,
primaryResourceId,
productCode,
provisioningState,
resourceId,
shortfall,
startAt,
status,
systemData,
systemId,
type
FROM azure.billing_benefits.contributors
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND macc_name = '{{ macc_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_from_applicable_macc

List contributors under applicable MACCs for a given billing account.

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