sources

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

Overview

Name	`sources`
Type	Resource
Id	`azure.billing_benefits.sources`

Fields

The following fields are returned by SELECT queries:

get
list_by_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.
`credit`	`object`	Commitment towards the benefit.
`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).
`impactedBillingPeriod`	`string`	The billing period of the impact for the resource. Format YYYYMM.
`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.
`sku`	`object`	The resource model definition representing SKU.
`sourceResourceId`	`string`	The uri of the resource impacted which lead to the grant of the credit.
`status`	`string`	Status of the credit. Known values are: "Unknown", "Pending", "Active", "Succeeded", "Canceled", "Failed", "Expired", "Exhausted", and "NotStarted". (Unknown, Pending, Active, Succeeded, Canceled, Failed, Expired, Exhausted, NotStarted)
`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".

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.
`credit`	`object`	Commitment towards the benefit.
`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).
`impactedBillingPeriod`	`string`	The billing period of the impact for the resource. Format YYYYMM.
`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.
`sku`	`object`	The resource model definition representing SKU.
`sourceResourceId`	`string`	The uri of the resource impacted which lead to the grant of the credit.
`status`	`string`	Status of the credit. Known values are: "Unknown", "Pending", "Active", "Succeeded", "Canceled", "Failed", "Expired", "Exhausted", and "NotStarted". (Unknown, Pending, Active, Succeeded, Canceled, Failed, Expired, Exhausted, NotStarted)
`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	Description
`get`	`select`	`resource_group_name`, `credit_name`, `source_name`, `subscription_id`	Get a credit source.
`list_by_credit`	`select`	`resource_group_name`, `credit_name`, `subscription_id`	List credit sources for a credit under a resource group from primary service admin.
`create`	`insert`	`resource_group_name`, `credit_name`, `source_name`, `subscription_id`, `location`	Create a credit source.
`update`	`update`	`resource_group_name`, `credit_name`, `source_name`, `subscription_id`	Update a credit source.
`delete`	`delete`	`resource_group_name`, `credit_name`, `source_name`, `subscription_id`	Delete a credit source.

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
`credit_name`	`string`	Name of the credit. Required.
`resource_group_name`	`string`	The name of the resource group. The name is case insensitive. Required.
`source_name`	`string`	Name of the credit source. Required.
`subscription_id`	`string`

`SELECT` examples

get
list_by_credit

Get a credit source.

SELECT
id,
name,
credit,
etag,
identity,
impactedBillingPeriod,
kind,
location,
managedBy,
plan,
sku,
sourceResourceId,
status,
systemData,
tags,
type
FROM azure.billing_benefits.sources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND credit_name = '{{ credit_name }}' -- required
AND source_name = '{{ source_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

List credit sources for a credit under a resource group from primary service admin.

SELECT
id,
name,
credit,
etag,
identity,
impactedBillingPeriod,
kind,
location,
managedBy,
plan,
sku,
sourceResourceId,
status,
systemData,
tags,
type
FROM azure.billing_benefits.sources
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND credit_name = '{{ credit_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

`INSERT` examples

create
Manifest

Create a credit source.

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

# Description fields are for documentation purposes
- name: sources
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the sources resource.
  - name: credit_name
    value: "{{ credit_name }}"
    description: Required parameter for the sources resource.
  - name: source_name
    value: "{{ source_name }}"
    description: Required parameter for the sources resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the sources resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Credit source properties.
    value:
      status: "{{ status }}"
      sourceResourceId: "{{ sourceResourceId }}"
      impactedBillingPeriod: "{{ impactedBillingPeriod }}"
      credit:
        currencyCode: "{{ currencyCode }}"
        amount: {{ amount }}
        grain: "{{ grain }}"
  - 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 credit source.

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

`DELETE` examples

delete

Delete a credit source.

DELETE FROM azure.billing_benefits.sources
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND credit_name = '{{ credit_name }}' --required
AND source_name = '{{ source_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Overview​

Fields​

Methods​

Parameters​

SELECT examples​

INSERT examples​

UPDATE examples​

DELETE examples​