reservations

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

Overview

Name	reservations
Type	Resource
Id	azure_isv.purestorageblock.reservations

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.
location	string	The geo-location where the resource lives. Required.
marketplace	object	Marketplace details. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Deleting, Accepted)
reservationInternalId	string	Pure Storage's internal ID for the reservation.
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".
user	object	User details. Required.

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.
location	string	The geo-location where the resource lives. Required.
marketplace	object	Marketplace details. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Deleting, Accepted)
reservationInternalId	string	Pure Storage's internal ID for the reservation.
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".
user	object	User details. Required.

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.
location	string	The geo-location where the resource lives. Required.
marketplace	object	Marketplace details. Required.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Deleting, Accepted)
reservationInternalId	string	Pure Storage's internal ID for the reservation.
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".
user	object	User details. Required.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, reservation_name, subscription_id		Get a reservation.
list_by_resource_group	select	resource_group_name, subscription_id		List reservations by resource group.
list_by_subscription	select	subscription_id		List reservations by Azure subscription ID.
create	insert	resource_group_name, reservation_name, subscription_id, location		Create a reservation.
update	update	resource_group_name, reservation_name, subscription_id		Update a reservation.
delete	delete	resource_group_name, reservation_name, subscription_id		Delete a reservation.
get_resource_limits	exec	resource_group_name, reservation_name, subscription_id		Limits constraining certain resource properties.
get_billing_status	exec	resource_group_name, reservation_name, subscription_id		Provides various statistics about resources billed via given reservation.
get_billing_report	exec	resource_group_name, reservation_name, subscription_id		Provides a summarized report along with actions for resources billed via given reservation.

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

SELECT examples

get

Get a reservation.

SELECT
id,
name,
location,
marketplace,
provisioningState,
reservationInternalId,
systemData,
tags,
type,
user
FROM azure_isv.purestorageblock.reservations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND reservation_name = '{{ reservation_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List reservations by resource group.

SELECT
id,
name,
location,
marketplace,
provisioningState,
reservationInternalId,
systemData,
tags,
type,
user
FROM azure_isv.purestorageblock.reservations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List reservations by Azure subscription ID.

SELECT
id,
name,
location,
marketplace,
provisioningState,
reservationInternalId,
systemData,
tags,
type,
user
FROM azure_isv.purestorageblock.reservations
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a reservation.

INSERT INTO azure_isv.purestorageblock.reservations (
tags,
location,
properties,
resource_group_name,
reservation_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ reservation_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: reservations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the reservations resource.
  - name: reservation_name
    value: "{{ reservation_name }}"
    description: Required parameter for the reservations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the reservations resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      reservationInternalId: "{{ reservationInternalId }}"
      marketplace:
        subscriptionId: "{{ subscriptionId }}"
        subscriptionStatus: "{{ subscriptionStatus }}"
        offerDetails:
          publisherId: "{{ publisherId }}"
          offerId: "{{ offerId }}"
          planId: "{{ planId }}"
          planName: "{{ planName }}"
          termUnit: "{{ termUnit }}"
          termId: "{{ termId }}"
      user:
        firstName: "{{ firstName }}"
        lastName: "{{ lastName }}"
        emailAddress: "{{ emailAddress }}"
        upn: "{{ upn }}"
        phoneNumber: "{{ phoneNumber }}"
        companyDetails:
          companyName: "{{ companyName }}"
          address:
            addressLine1: "{{ addressLine1 }}"
            addressLine2: "{{ addressLine2 }}"
            city: "{{ city }}"
            state: "{{ state }}"
            country: "{{ country }}"
            postalCode: "{{ postalCode }}"
      provisioningState: "{{ provisioningState }}"

UPDATE examples

update

Update a reservation.

UPDATE azure_isv.purestorageblock.reservations
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND reservation_name = '{{ reservation_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a reservation.

DELETE FROM azure_isv.purestorageblock.reservations
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND reservation_name = '{{ reservation_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

get_resource_limits

Limits constraining certain resource properties.

EXEC azure_isv.purestorageblock.reservations.get_resource_limits 
@resource_group_name='{{ resource_group_name }}' --required, 
@reservation_name='{{ reservation_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_billing_status

Provides various statistics about resources billed via given reservation.

EXEC azure_isv.purestorageblock.reservations.get_billing_status 
@resource_group_name='{{ resource_group_name }}' --required, 
@reservation_name='{{ reservation_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_billing_report

Provides a summarized report along with actions for resources billed via given reservation.

EXEC azure_isv.purestorageblock.reservations.get_billing_report 
@resource_group_name='{{ resource_group_name }}' --required, 
@reservation_name='{{ reservation_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;