private_store_collections

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

Overview

Name	private_store_collections
Type	Resource
Id	azure_extras.marketplace.private_store_collections

Fields

The following fields are returned by SELECT queries:

get

Collection information retrieved

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

list

Collections list information retrieved

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

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	privateStoreId, collectionId		Gets private store collection
list	select	privateStoreId		Gets private store collections list
create_or_update	insert	privateStoreId, collectionId		Create or update private store collection
delete	delete	privateStoreId, collectionId		Delete a collection from the given private store.
post	exec	privateStoreId, collectionId		Delete Private store collection. This is a workaround.
transfer_offers	exec	privateStoreId, collectionId		transferring offers (copy or move) from source collection to target collection(s)
approve_all_items	exec	privateStoreId, collectionId		Delete all existing offers from the collection and enable approve all items.
disable_approve_all_items	exec	privateStoreId, collectionId		Disable approve all items for the collection.

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
privateStoreId	string	The store ID - must use the tenant ID

SELECT examples

get

Gets private store collection

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

list

Gets private store collections list

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

INSERT examples

create_or_update

Create or update private store collection

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

Manifest

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

DELETE examples

delete

Delete a collection from the given private store.

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

Lifecycle Methods

post

Delete Private store collection. This is a workaround.

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

transfer_offers

transferring offers (copy or move) from source collection to target collection(s)

EXEC azure_extras.marketplace.private_store_collections.transfer_offers 
@privateStoreId='{{ privateStoreId }}' --required, 
@collectionId='{{ collectionId }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

approve_all_items

Delete all existing offers from the collection and enable approve all items.

EXEC azure_extras.marketplace.private_store_collections.approve_all_items 
@privateStoreId='{{ privateStoreId }}' --required, 
@collectionId='{{ collectionId }}' --required
;

disable_approve_all_items

Disable approve all items for the collection.

EXEC azure_extras.marketplace.private_store_collections.disable_approve_all_items 
@privateStoreId='{{ privateStoreId }}' --required, 
@collectionId='{{ collectionId }}' --required
;