acquired_plans

Creates, updates, deletes, gets or lists an acquired_plans resource.

Overview

Name	acquired_plans
Type	Resource
Id	azure_stack.subscriptions_admin.acquired_plans

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Identifier in the tenant subscription context.
acquisitionId	string	Acquisition identifier.
acquisitionTime	string (date-time)	Acquisition time.
externalReferenceId	string	External reference identifier.
planId	string	Plan identifier in the tenant subscription context.
provisioningState	string	State of the provisioning.

list

Name	Datatype	Description
id	string	Identifier in the tenant subscription context.
acquisitionId	string	Acquisition identifier.
acquisitionTime	string (date-time)	Acquisition time.
externalReferenceId	string	External reference identifier.
planId	string	Plan identifier in the tenant subscription context.
provisioningState	string	State of the provisioning.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, targetSubscriptionId, planAcquisitionId		Gets the specified plan acquired by a subscription consuming the offer.
list	select	subscriptionId, targetSubscriptionId		Get a collection of all acquired plans that subscription has access to.
create	insert	subscriptionId, targetSubscriptionId, planAcquisitionId		Creates an acquired plan.
delete	delete	subscriptionId, targetSubscriptionId, planAcquisitionId		Deletes an acquired plan.

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
planAcquisitionId	string	The plan acquisition Identifier
subscriptionId	string	Subscription credentials which uniquely identify Microsoft Azure subscription.The subscription ID forms part of the URI for every service call.
targetSubscriptionId	string	The target subscription ID.

SELECT examples

get

Gets the specified plan acquired by a subscription consuming the offer.

SELECT
id,
acquisitionId,
acquisitionTime,
externalReferenceId,
planId,
provisioningState
FROM azure_stack.subscriptions_admin.acquired_plans
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND targetSubscriptionId = '{{ targetSubscriptionId }}' -- required
AND planAcquisitionId = '{{ planAcquisitionId }}' -- required
;

list

Get a collection of all acquired plans that subscription has access to.

SELECT
id,
acquisitionId,
acquisitionTime,
externalReferenceId,
planId,
provisioningState
FROM azure_stack.subscriptions_admin.acquired_plans
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND targetSubscriptionId = '{{ targetSubscriptionId }}' -- required
;

INSERT examples

create

Creates an acquired plan.

INSERT INTO azure_stack.subscriptions_admin.acquired_plans (
data__acquisitionId,
data__id,
data__planId,
data__externalReferenceId,
data__provisioningState,
data__acquisitionTime,
subscriptionId,
targetSubscriptionId,
planAcquisitionId
)
SELECT 
'{{ acquisitionId }}',
'{{ id }}',
'{{ planId }}',
'{{ externalReferenceId }}',
'{{ provisioningState }}',
'{{ acquisitionTime }}',
'{{ subscriptionId }}',
'{{ targetSubscriptionId }}',
'{{ planAcquisitionId }}'
RETURNING
id,
acquisitionId,
acquisitionTime,
externalReferenceId,
planId,
provisioningState
;

Manifest

# Description fields are for documentation purposes
- name: acquired_plans
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the acquired_plans resource.
    - name: targetSubscriptionId
      value: string
      description: Required parameter for the acquired_plans resource.
    - name: planAcquisitionId
      value: string
      description: Required parameter for the acquired_plans resource.
    - name: acquisitionId
      value: string
      description: |
        Acquisition identifier.
    - name: id
      value: string
      description: |
        Identifier in the tenant subscription context.
    - name: planId
      value: string
      description: |
        Plan identifier in the tenant subscription context.
    - name: externalReferenceId
      value: string
      description: |
        External reference identifier.
    - name: provisioningState
      value: string
      description: |
        State of the provisioning.
      valid_values: ['NotSpecified', 'Accepted', 'Failed', 'Succeeded']
    - name: acquisitionTime
      value: string
      description: |
        Acquisition time.

DELETE examples

delete

Deletes an acquired plan.

DELETE FROM azure_stack.subscriptions_admin.acquired_plans
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND targetSubscriptionId = '{{ targetSubscriptionId }}' --required
AND planAcquisitionId = '{{ planAcquisitionId }}' --required
;