free_services

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

Overview

Name	free_services
Type	Resource
Id	azure.billing_benefits.free_services

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.
billingAccountResourceId	string	Billing account resource id where the free services metadata is present.
billingProfileResourceId	string	Billing profile resource id where the free services are scoped to.
customerResourceId	string	Customer resource id where the free services are scoped to.
endAt	string (date-time)	Expiration date and time of the free services.
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	This is the catalog UPN for the product.
provisioningState	string	Provisioning state of Free Services as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of Free Services resource, refer to FreeServicesStatus.
sku	object	The resource model definition representing SKU.
startAt	string (date-time)	Date and time when the free services become active.
status	string	Current status of the free services. Known values are: "Unknown", "Pending", "Active", "Canceled", and "Completed". (Unknown, Pending, Active, Canceled, Completed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemId	string	This is the globally unique identifier of the free services which will not change for its lifetime.
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.
billingAccountResourceId	string	Billing account resource id where the free services metadata is present.
billingProfileResourceId	string	Billing profile resource id where the free services are scoped to.
customerResourceId	string	Customer resource id where the free services are scoped to.
endAt	string (date-time)	Expiration date and time of the free services.
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	This is the catalog UPN for the product.
provisioningState	string	Provisioning state of Free Services as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of Free Services resource, refer to FreeServicesStatus.
sku	object	The resource model definition representing SKU.
startAt	string (date-time)	Date and time when the free services become active.
status	string	Current status of the free services. Known values are: "Unknown", "Pending", "Active", "Canceled", and "Completed". (Unknown, Pending, Active, Canceled, Completed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemId	string	This is the globally unique identifier of the free services which will not change for its lifetime.
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.
billingAccountResourceId	string	Billing account resource id where the free services metadata is present.
billingProfileResourceId	string	Billing profile resource id where the free services are scoped to.
customerResourceId	string	Customer resource id where the free services are scoped to.
endAt	string (date-time)	Expiration date and time of the free services.
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	This is the catalog UPN for the product.
provisioningState	string	Provisioning state of Free Services as assigned by RPaaS. This indicates the last operation's status. For all practical purposes, this can be ignored. For current status of Free Services resource, refer to FreeServicesStatus.
sku	object	The resource model definition representing SKU.
startAt	string (date-time)	Date and time when the free services become active.
status	string	Current status of the free services. Known values are: "Unknown", "Pending", "Active", "Canceled", and "Completed". (Unknown, Pending, Active, Canceled, Completed)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
systemId	string	This is the globally unique identifier of the free services which will not change for its lifetime.
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, free_service_name, subscription_id		This operation retrieves properties for free services.
list_by_resource_group	select	resource_group_name, subscription_id		This operation lists the free services that are available under the specified resource group.
list_by_subscription	select	subscription_id		This operation lists free services that are available under the specified subscription.
create	insert	resource_group_name, free_service_name, subscription_id, location		This operation creates or updates free services in Azure.
update	update	resource_group_name, free_service_name, subscription_id		This operation updates free services in Azure.
delete	delete	resource_group_name, free_service_name, subscription_id		This operation deletes free services from the subscription. Only free services that are in an expired or cancelled states can be deleted.

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
free_service_name	string	Name of the free service. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

This operation retrieves properties for free services.

SELECT
id,
name,
billingAccountResourceId,
billingProfileResourceId,
customerResourceId,
endAt,
etag,
identity,
kind,
location,
managedBy,
plan,
productCode,
provisioningState,
sku,
startAt,
status,
systemData,
systemId,
tags,
type
FROM azure.billing_benefits.free_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND free_service_name = '{{ free_service_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

This operation lists the free services that are available under the specified resource group.

SELECT
id,
name,
billingAccountResourceId,
billingProfileResourceId,
customerResourceId,
endAt,
etag,
identity,
kind,
location,
managedBy,
plan,
productCode,
provisioningState,
sku,
startAt,
status,
systemData,
systemId,
tags,
type
FROM azure.billing_benefits.free_services
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

This operation lists free services that are available under the specified subscription.

SELECT
id,
name,
billingAccountResourceId,
billingProfileResourceId,
customerResourceId,
endAt,
etag,
identity,
kind,
location,
managedBy,
plan,
productCode,
provisioningState,
sku,
startAt,
status,
systemData,
systemId,
tags,
type
FROM azure.billing_benefits.free_services
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

This operation creates or updates free services in Azure.

INSERT INTO azure.billing_benefits.free_services (
tags,
location,
properties,
managedBy,
kind,
identity,
sku,
plan,
resource_group_name,
free_service_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ managedBy }}',
'{{ kind }}',
'{{ identity }}',
'{{ sku }}',
'{{ plan }}',
'{{ resource_group_name }}',
'{{ free_service_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: free_services
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the free_services resource.
  - name: free_service_name
    value: "{{ free_service_name }}"
    description: Required parameter for the free_services resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the free_services resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Free services properties.
    value:
      productCode: "{{ productCode }}"
      status: "{{ status }}"
      startAt: "{{ startAt }}"
      endAt: "{{ endAt }}"
      provisioningState: "{{ provisioningState }}"
      billingAccountResourceId: "{{ billingAccountResourceId }}"
      billingProfileResourceId: "{{ billingProfileResourceId }}"
      customerResourceId: "{{ customerResourceId }}"
      systemId: "{{ systemId }}"
  - 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

This operation updates free services in Azure.

UPDATE azure.billing_benefits.free_services
SET 
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND free_service_name = '{{ free_service_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

This operation deletes free services from the subscription. Only free services that are in an expired or cancelled states can be deleted.

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