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

vw_private_stores

Name	Datatype	Description
id	text	The resource ID.
name	text	The name of the resource.
availability	text	field from the properties object
branding	text	field from the properties object
collection_ids	text	field from the properties object
e_tag	text	field from the properties object
is_gov	text	field from the properties object
notifications_settings	text	field from the properties object
privateStoreId	text	field from the properties object
private_store_id	text	field from the properties object
private_store_name	text	field from the properties object
system_data	text	field from the properties object
tenant_id	text	field from the properties object
type	text	The type of the resource.

private_stores

Name	Datatype	Description
id	string	The resource ID.
name	string	The name of the resource.
properties	object	Describes the json payload on whether or not the private store is enabled for a given tenant
systemData	object	Read only system data
type	string	The type of the resource.

Methods

Name	Accessible by	Required 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.
acknowledge_offer_notification	EXEC	offerId, privateStoreId	Acknowledge notification for offer
admin_request_approvals_list	EXEC	privateStoreId	Get list of admin request approvals
any_existing_offers_in_the_collections	EXEC	privateStoreId	Query whether exists any offer in the collections.
billing_accounts	EXEC	privateStoreId	Tenant billing accounts names
bulk_collections_action	EXEC	privateStoreId	Perform an action on bulk collections
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.
fetch_all_subscriptions_in_tenant	EXEC	privateStoreId	Fetch all subscriptions in tenant, only for marketplace admin
query_approved_plans	EXEC	privateStoreId	Get map of plans and related approved subscriptions.
query_notifications_state	EXEC	privateStoreId	Get private store notifications state
query_offers	EXEC	privateStoreId	List of offers, regardless the collections
query_request_approval	EXEC	privateStoreId, requestApprovalId	Get request statuses foreach plan, this api is used as a complex GET action.
query_user_offers	EXEC	privateStoreId	List of user's approved offers for the provided offers and subscriptions
withdraw_plan	EXEC	privateStoreId, requestApprovalId	Withdraw a user request approval on specific plan

SELECT examples

Gets the list of available private stores.

vw_private_stores

SELECT
id,
name,
availability,
branding,
collection_ids,
e_tag,
is_gov,
notifications_settings,
privateStoreId,
private_store_id,
private_store_name,
system_data,
tenant_id,
type
FROM azure_extras.marketplace.vw_private_stores
;

private_stores

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

INSERT example

Use the following StackQL query and manifest file to create a new private_stores resource.

All Properties

/*+ create */
INSERT INTO azure_extras.marketplace.private_stores (
privateStoreId,
properties
)
SELECT 
'{{ privateStoreId }}',
'{{ properties }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: id
      value: string
    - name: name
      value: string
    - name: type
      value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: []
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedAt
          value: string
    - name: properties
      value:
        - name: availability
          value: string
        - name: privateStoreId
          value: string
        - name: eTag
          value: string
        - name: privateStoreName
          value: string
        - name: tenantId
          value: string
        - name: isGov
          value: boolean
        - name: collectionIds
          value:
            - string
        - name: branding
          value: object
        - name: notificationsSettings
          value:
            - name: recipients
              value:
                - - name: principalId
                    value: string
                  - name: emailAddress
                    value: string
                  - name: displayName
                    value: string
            - name: sendToAllMarketplaceAdmins
              value: boolean

DELETE example

Deletes the specified private_stores resource.

/*+ delete */
DELETE FROM azure_extras.marketplace.private_stores
WHERE privateStoreId = '{{ privateStoreId }}';