private_store_collection_offers

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

Overview

Name	private_store_collection_offers
Type	Resource
Id	azure_extras.marketplace.private_store_collection_offers

Fields

The following fields are returned by SELECT queries:

get

Offer information retrieved

Name	Datatype	Description
id	string	The resource ID.
name	string	The name of the resource.
properties	object	The privateStore offer data structure.
systemData	object	Metadata pertaining to creation and last modification of the resource
type	string	The type of the resource.

list

Name	Datatype	Description
id	string	The resource ID.
name	string	The name of the resource.
properties	object	The privateStore offer data structure.
systemData	object	Metadata pertaining to creation and last modification of the resource
type	string	The type of the resource.

list_by_contexts

Name	Datatype	Description
context	string	Offer's context, e.g. subscription ID, tenant ID.
offers	object	List of offers

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	privateStoreId, collectionId, offerId		Gets information about a specific offer.
list	select	privateStoreId, collectionId		Get a list of all private offers in the given private store and collection
list_by_contexts	select	privateStoreId, collectionId		Get a list of all offers in the given collection according to the required contexts.
create_or_update	insert	privateStoreId, collectionId, offerId		Update or add an offer to a specific collection of the private store.
delete	delete	privateStoreId, collectionId, offerId		Deletes an offer from the given collection of private store.
post	exec	privateStoreId, collectionId, offerId		Delete Private store offer. This is a workaround.
upsert_offer_with_multi_context	exec	privateStoreId, collectionId, offerId		Upsert an offer with multiple context details.

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
collectionId	string	The collection ID
offerId	string	The offer ID to update or delete
privateStoreId	string	The store ID - must use the tenant ID

SELECT examples

get

Gets information about a specific offer.

SELECT
id,
name,
properties,
systemData,
type
FROM azure_extras.marketplace.private_store_collection_offers
WHERE privateStoreId = '{{ privateStoreId }}' -- required
AND collectionId = '{{ collectionId }}' -- required
AND offerId = '{{ offerId }}' -- required
;

list

Get a list of all private offers in the given private store and collection

SELECT
id,
name,
properties,
systemData,
type
FROM azure_extras.marketplace.private_store_collection_offers
WHERE privateStoreId = '{{ privateStoreId }}' -- required
AND collectionId = '{{ collectionId }}' -- required
;

list_by_contexts

Get a list of all offers in the given collection according to the required contexts.

SELECT
context,
offers
FROM azure_extras.marketplace.private_store_collection_offers
WHERE privateStoreId = '{{ privateStoreId }}' -- required
AND collectionId = '{{ collectionId }}' -- required
;

INSERT examples

create_or_update

Update or add an offer to a specific collection of the private store.

INSERT INTO azure_extras.marketplace.private_store_collection_offers (
data__properties,
privateStoreId,
collectionId,
offerId
)
SELECT 
'{{ properties }}',
'{{ privateStoreId }}',
'{{ collectionId }}',
'{{ offerId }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: private_store_collection_offers
  props:
    - name: privateStoreId
      value: string
      description: Required parameter for the private_store_collection_offers resource.
    - name: collectionId
      value: string
      description: Required parameter for the private_store_collection_offers resource.
    - name: offerId
      value: string
      description: Required parameter for the private_store_collection_offers resource.
    - name: properties
      value: object
      description: |
        The privateStore offer data structure.

DELETE examples

delete

Deletes an offer from the given collection of private store.

DELETE FROM azure_extras.marketplace.private_store_collection_offers
WHERE privateStoreId = '{{ privateStoreId }}' --required
AND collectionId = '{{ collectionId }}' --required
AND offerId = '{{ offerId }}' --required
;

Lifecycle Methods

post

Delete Private store offer. This is a workaround.

EXEC azure_extras.marketplace.private_store_collection_offers.post 
@privateStoreId='{{ privateStoreId }}' --required, 
@collectionId='{{ collectionId }}' --required, 
@offerId='{{ offerId }}' --required
;

upsert_offer_with_multi_context

Upsert an offer with multiple context details.

EXEC azure_extras.marketplace.private_store_collection_offers.upsert_offer_with_multi_context 
@privateStoreId='{{ privateStoreId }}' --required, 
@collectionId='{{ collectionId }}' --required, 
@offerId='{{ offerId }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;