private_stores

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

Overview

Name	private_stores
Type	Resource
Id	azure_extras.marketplace.private_stores

Fields

The following fields are returned by SELECT queries:

get

OK. The request has succeeded.

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

list

OK. The request has succeeded.

Name	Datatype	Description
id	string	The resource ID.
name	string	The name of the resource.
properties	object	The PrivateStore 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		Get information about the private store
list	select			Gets the list of available private stores.
create_or_update	insert	privateStoreId		Changes private store properties
delete	delete	privateStoreId		Deletes the private store. All that is not saved will be lost.
any_existing_offers_in_the_collections	exec	privateStoreId		Query whether exists any offer in the collections.
query_offers	exec	privateStoreId		List of offers, regardless the collections
query_user_offers	exec	privateStoreId		List of user's approved offers for the provided offers and subscriptions
billing_accounts	exec	privateStoreId		Tenant billing accounts names
collections_to_subscriptions_mapping	exec	privateStoreId		For a given subscriptions list, the API will return a map of collections and the related subscriptions from the supplied list.
query_approved_plans	exec	privateStoreId		Get map of plans and related approved subscriptions.
bulk_collections_action	exec	privateStoreId		Perform an action on bulk collections
query_request_approval	exec	privateStoreId, requestApprovalId		Get request statuses foreach plan, this api is used as a complex GET action.
admin_request_approvals_list	exec	privateStoreId		Get list of admin request approvals
query_notifications_state	exec	privateStoreId		Get private store notifications state
acknowledge_offer_notification	exec	privateStoreId, offerId		Acknowledge notification for offer
withdraw_plan	exec	privateStoreId, requestApprovalId		Withdraw a user request approval on specific plan
fetch_all_subscriptions_in_tenant	exec	privateStoreId	next-page-token	Fetch all subscriptions in tenant, only for marketplace admin

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	The offer ID to update or delete
privateStoreId	string	The store ID - must use the tenant ID
requestApprovalId	string	The request approval ID to get create or update
next-page-token	string	The skip token to get the next page.

SELECT examples

get

Get information about the private store

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

list

Gets the list of available private stores.

SELECT
id,
name,
properties,
systemData,
type
FROM azure_extras.marketplace.private_stores
;

INSERT examples

create_or_update

Changes private store properties

INSERT INTO azure_extras.marketplace.private_stores (
data__properties,
privateStoreId
)
SELECT 
'{{ properties }}',
'{{ privateStoreId }}'
;

Manifest

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

DELETE examples

delete

Deletes the private store. All that is not saved will be lost.

DELETE FROM azure_extras.marketplace.private_stores
WHERE privateStoreId = '{{ privateStoreId }}' --required
;

Lifecycle Methods

any_existing_offers_in_the_collections

Query whether exists any offer in the collections.

EXEC azure_extras.marketplace.private_stores.any_existing_offers_in_the_collections 
@privateStoreId='{{ privateStoreId }}' --required
;

query_offers

List of offers, regardless the collections

EXEC azure_extras.marketplace.private_stores.query_offers 
@privateStoreId='{{ privateStoreId }}' --required
;

query_user_offers

List of user's approved offers for the provided offers and subscriptions

EXEC azure_extras.marketplace.private_stores.query_user_offers 
@privateStoreId='{{ privateStoreId }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

billing_accounts

Tenant billing accounts names

EXEC azure_extras.marketplace.private_stores.billing_accounts 
@privateStoreId='{{ privateStoreId }}' --required
;

collections_to_subscriptions_mapping

For a given subscriptions list, the API will return a map of collections and the related subscriptions from the supplied list.

EXEC azure_extras.marketplace.private_stores.collections_to_subscriptions_mapping 
@privateStoreId='{{ privateStoreId }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

query_approved_plans

Get map of plans and related approved subscriptions.

EXEC azure_extras.marketplace.private_stores.query_approved_plans 
@privateStoreId='{{ privateStoreId }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

bulk_collections_action

Perform an action on bulk collections

EXEC azure_extras.marketplace.private_stores.bulk_collections_action 
@privateStoreId='{{ privateStoreId }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

query_request_approval

Get request statuses foreach plan, this api is used as a complex GET action.

EXEC azure_extras.marketplace.private_stores.query_request_approval 
@privateStoreId='{{ privateStoreId }}' --required, 
@requestApprovalId='{{ requestApprovalId }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

admin_request_approvals_list

Get list of admin request approvals

EXEC azure_extras.marketplace.private_stores.admin_request_approvals_list 
@privateStoreId='{{ privateStoreId }}' --required
;

query_notifications_state

Get private store notifications state

EXEC azure_extras.marketplace.private_stores.query_notifications_state 
@privateStoreId='{{ privateStoreId }}' --required
;

acknowledge_offer_notification

Acknowledge notification for offer

EXEC azure_extras.marketplace.private_stores.acknowledge_offer_notification 
@privateStoreId='{{ privateStoreId }}' --required, 
@offerId='{{ offerId }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

withdraw_plan

Withdraw a user request approval on specific plan

EXEC azure_extras.marketplace.private_stores.withdraw_plan 
@privateStoreId='{{ privateStoreId }}' --required, 
@requestApprovalId='{{ requestApprovalId }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

fetch_all_subscriptions_in_tenant

Fetch all subscriptions in tenant, only for marketplace admin

EXEC azure_extras.marketplace.private_stores.fetch_all_subscriptions_in_tenant 
@privateStoreId='{{ privateStoreId }}' --required, 
@next-page-token='{{ next-page-token }}'
;