conditional_credits

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

Overview

Name	conditional_credits
Type	Resource
Id	azure.billing_benefits.conditional_credits

Fields

The following fields are returned by SELECT queries:

get

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. Known values are: "Primary" and "Contributor".
etag	string	The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
identity	object	Managed service identity (system assigned and/or user assigned identities).
kind	string	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
location	string	The geo-location where the resource lives. Required.
managedBy	string	The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
plan	object	Plan for the resource.
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}.
sku	object	The resource model definition representing SKU.
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.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

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. Known values are: "Primary" and "Contributor".
etag	string	The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
identity	object	Managed service identity (system assigned and/or user assigned identities).
kind	string	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
location	string	The geo-location where the resource lives. Required.
managedBy	string	The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
plan	object	Plan for the resource.
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}.
sku	object	The resource model definition representing SKU.
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.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

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. Known values are: "Primary" and "Contributor".
etag	string	The etag field is not required. If it is provided in the response body, it must also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
identity	object	Managed service identity (system assigned and/or user assigned identities).
kind	string	Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
location	string	The geo-location where the resource lives. Required.
managedBy	string	The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
plan	object	Plan for the resource.
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}.
sku	object	The resource model definition representing SKU.
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.
tags	object	Resource tags.
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	select	resource_group_name, conditional_credit_name, subscription_id		Get a conditional credit.
list_by_resource_group	select	resource_group_name, subscription_id		List conditional credits by resource group.
list_by_subscription	select	subscription_id		List conditional credits by subscription.
create_or_update	insert	resource_group_name, conditional_credit_name, subscription_id, location		Create or update a conditional credit.
update	update	resource_group_name, conditional_credit_name, subscription_id		Update a conditional credit.
create_or_update	replace	resource_group_name, conditional_credit_name, subscription_id, location		Create or update a conditional credit.
delete	delete	resource_group_name, conditional_credit_name, subscription_id		Delete a conditional credit.
cancel	exec	resource_group_name, conditional_credit_name, subscription_id		Cancel conditional credit. Stops applying the benefit.
scope_list	exec	scope		List conditional credits that are applicable for a given scope. Currently supported scopes: billing accounts.

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
conditional_credit_name	string	Name of the conditional credit. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
scope	string	The scope at which the benefits are listed. Required.
subscription_id	string

SELECT examples

get

Get a conditional credit.

SELECT
id,
name,
benefitResourceId,
billingAccountResourceId,
displayName,
endAt,
entityType,
etag,
identity,
kind,
location,
managedBy,
plan,
productCode,
provisioningState,
resourceId,
sku,
startAt,
status,
systemData,
tags,
type
FROM azure.billing_benefits.conditional_credits
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND conditional_credit_name = '{{ conditional_credit_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List conditional credits by resource group.

SELECT
id,
name,
benefitResourceId,
billingAccountResourceId,
displayName,
endAt,
entityType,
etag,
identity,
kind,
location,
managedBy,
plan,
productCode,
provisioningState,
resourceId,
sku,
startAt,
status,
systemData,
tags,
type
FROM azure.billing_benefits.conditional_credits
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List conditional credits by subscription.

SELECT
id,
name,
benefitResourceId,
billingAccountResourceId,
displayName,
endAt,
entityType,
etag,
identity,
kind,
location,
managedBy,
plan,
productCode,
provisioningState,
resourceId,
sku,
startAt,
status,
systemData,
tags,
type
FROM azure.billing_benefits.conditional_credits
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create or update a conditional credit.

INSERT INTO azure.billing_benefits.conditional_credits (
tags,
location,
properties,
managedBy,
kind,
identity,
sku,
plan,
resource_group_name,
conditional_credit_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ managedBy }}',
'{{ kind }}',
'{{ identity }}',
'{{ sku }}',
'{{ plan }}',
'{{ resource_group_name }}',
'{{ conditional_credit_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
identity,
kind,
location,
managedBy,
plan,
properties,
sku,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: conditional_credits
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the conditional_credits resource.
  - name: conditional_credit_name
    value: "{{ conditional_credit_name }}"
    description: Required parameter for the conditional_credits resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the conditional_credits resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Conditional credit properties.
    value:
      entityType: "{{ entityType }}"
      displayName: "{{ displayName }}"
      billingAccountResourceId: "{{ billingAccountResourceId }}"
      provisioningState: "{{ provisioningState }}"
      status: "{{ status }}"
      startAt: "{{ startAt }}"
      endAt: "{{ endAt }}"
      productCode: "{{ productCode }}"
      benefitResourceId: "{{ benefitResourceId }}"
      resourceId: "{{ resourceId }}"
  - name: managedBy
    value: "{{ managedBy }}"
    description: |
      The fully qualified resource ID of the resource that manages this resource. Indicates if this resource is managed by another Azure resource. If this is present, complete mode deployment will not delete the resource if it is removed from the template since it is managed by another resource.
  - name: kind
    value: "{{ kind }}"
    description: |
      Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type. E.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
  - name: identity
    description: |
      Managed service identity (system assigned and/or user assigned identities).
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"
  - name: sku
    description: |
      The resource model definition representing SKU.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"
      size: "{{ size }}"
      family: "{{ family }}"
      capacity: {{ capacity }}
  - name: plan
    description: |
      Plan for the resource.
    value:
      name: "{{ name }}"
      publisher: "{{ publisher }}"
      product: "{{ product }}"
      promotionCode: "{{ promotionCode }}"
      version: "{{ version }}"

UPDATE examples

update

Update a conditional credit.

UPDATE azure.billing_benefits.conditional_credits
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND conditional_credit_name = '{{ conditional_credit_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
identity,
kind,
location,
managedBy,
plan,
properties,
sku,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update a conditional credit.

REPLACE azure.billing_benefits.conditional_credits
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
managedBy = '{{ managedBy }}',
kind = '{{ kind }}',
identity = '{{ identity }}',
sku = '{{ sku }}',
plan = '{{ plan }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND conditional_credit_name = '{{ conditional_credit_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
etag,
identity,
kind,
location,
managedBy,
plan,
properties,
sku,
systemData,
tags,
type;

DELETE examples

delete

Delete a conditional credit.

DELETE FROM azure.billing_benefits.conditional_credits
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND conditional_credit_name = '{{ conditional_credit_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

cancel

Cancel conditional credit. Stops applying the benefit.

EXEC azure.billing_benefits.conditional_credits.cancel 
@resource_group_name='{{ resource_group_name }}' --required, 
@conditional_credit_name='{{ conditional_credit_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

scope_list

List conditional credits that are applicable for a given scope. Currently supported scopes: billing accounts.

EXEC azure.billing_benefits.conditional_credits.scope_list 
@scope='{{ scope }}' --required
;