marketplace_agreements

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

Overview

Name	marketplace_agreements
Type	Resource
Id	azure_extras.marketplace_ordering.marketplace_agreements

Fields

The following fields are returned by SELECT queries:

get

Terms returned successfully

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	Represents the properties of the resource.
systemData	object	The system meta data relating to this resource.
type	string	Resource type.

list

Terms returned successfully

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
properties	object	Represents the properties of the resource.
type	string	Resource type.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, offerType, publisherId, offerId, planId		Get marketplace terms.
list	select	subscriptionId		List marketplace agreements in the subscription.
create	insert	offerType, subscriptionId, publisherId, offerId, planId		Save marketplace terms.
sign	exec	subscriptionId, publisherId, offerId, planId		Sign marketplace terms.
cancel	exec	subscriptionId, publisherId, offerId, planId		Cancel marketplace terms.

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
offerId	string	Offer identifier string of image being deployed.
offerType	string	Offer Type, currently only virtualmachine type is supported.
planId	string	Plan identifier string of image being deployed.
publisherId	string	Publisher identifier string of image being deployed.
subscriptionId	string	The subscription ID that identifies an Azure subscription.

SELECT examples

get

Get marketplace terms.

SELECT
id,
name,
properties,
systemData,
type
FROM azure_extras.marketplace_ordering.marketplace_agreements
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND offerType = '{{ offerType }}' -- required
AND publisherId = '{{ publisherId }}' -- required
AND offerId = '{{ offerId }}' -- required
AND planId = '{{ planId }}' -- required
;

list

List marketplace agreements in the subscription.

SELECT
id,
name,
properties,
type
FROM azure_extras.marketplace_ordering.marketplace_agreements
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Save marketplace terms.

INSERT INTO azure_extras.marketplace_ordering.marketplace_agreements (
data__properties,
offerType,
subscriptionId,
publisherId,
offerId,
planId
)
SELECT 
'{{ properties }}',
'{{ offerType }}',
'{{ subscriptionId }}',
'{{ publisherId }}',
'{{ offerId }}',
'{{ planId }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: marketplace_agreements
  props:
    - name: offerType
      value: string
      description: Required parameter for the marketplace_agreements resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the marketplace_agreements resource.
    - name: publisherId
      value: string
      description: Required parameter for the marketplace_agreements resource.
    - name: offerId
      value: string
      description: Required parameter for the marketplace_agreements resource.
    - name: planId
      value: string
      description: Required parameter for the marketplace_agreements resource.
    - name: properties
      value: object
      description: |
        Represents the properties of the resource.

Lifecycle Methods

sign

Sign marketplace terms.

EXEC azure_extras.marketplace_ordering.marketplace_agreements.sign 
@subscriptionId='{{ subscriptionId }}' --required, 
@publisherId='{{ publisherId }}' --required, 
@offerId='{{ offerId }}' --required, 
@planId='{{ planId }}' --required
;

cancel

Cancel marketplace terms.

EXEC azure_extras.marketplace_ordering.marketplace_agreements.cancel 
@subscriptionId='{{ subscriptionId }}' --required, 
@publisherId='{{ publisherId }}' --required, 
@offerId='{{ offerId }}' --required, 
@planId='{{ planId }}' --required
;