marketplace_gallery_images

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

Overview

Name	marketplace_gallery_images
Type	Resource
Id	azure_stack.azure_stack_hci.marketplace_gallery_images

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives
properties	object	Properties under the marketplace gallery image resource
tags	object	Resource tags.

list

Lists all marketplace gallery images under the resource group.

Name	Datatype	Description
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives
properties	object	Properties under the marketplace gallery image resource
tags	object	Resource tags.

list_all

Lists all marketplace gallery images under the subscription.

Name	Datatype	Description
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives
properties	object	Properties under the marketplace gallery image resource
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, marketplaceGalleryImageName		Gets a marketplace gallery image
list	select	subscriptionId, resourceGroupName		Lists all of the marketplace gallery images in the specified resource group. Use the nextLink property in the response to get the next page of marketplace gallery images.
list_all	select	subscriptionId		Lists all of the marketplace gallery images in the specified subscription. Use the nextLink property in the response to get the next page of marketplace gallery images.
create_or_update	insert	subscriptionId, resourceGroupName, marketplaceGalleryImageName		The operation to create or update a marketplace gallery image. Please note some properties can be set only during marketplace gallery image creation.
update	update	subscriptionId, resourceGroupName, marketplaceGalleryImageName		The operation to update a marketplace gallery image.
delete	delete	subscriptionId, resourceGroupName, marketplaceGalleryImageName		The operation to delete a marketplace gallery image.

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
marketplaceGalleryImageName	string	Name of the marketplace gallery image
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.

SELECT examples

get

Gets a marketplace gallery image

SELECT
extendedLocation,
location,
properties,
tags
FROM azure_stack.azure_stack_hci.marketplace_gallery_images
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND marketplaceGalleryImageName = '{{ marketplaceGalleryImageName }}' -- required
;

list

Lists all of the marketplace gallery images in the specified resource group. Use the nextLink property in the response to get the next page of marketplace gallery images.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure_stack.azure_stack_hci.marketplace_gallery_images
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_all

Lists all of the marketplace gallery images in the specified subscription. Use the nextLink property in the response to get the next page of marketplace gallery images.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure_stack.azure_stack_hci.marketplace_gallery_images
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

The operation to create or update a marketplace gallery image. Please note some properties can be set only during marketplace gallery image creation.

INSERT INTO azure_stack.azure_stack_hci.marketplace_gallery_images (
data__properties,
data__extendedLocation,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
marketplaceGalleryImageName
)
SELECT 
'{{ properties }}',
'{{ extendedLocation }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ marketplaceGalleryImageName }}'
RETURNING
extendedLocation,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: marketplace_gallery_images
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the marketplace_gallery_images resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the marketplace_gallery_images resource.
    - name: marketplaceGalleryImageName
      value: string
      description: Required parameter for the marketplace_gallery_images resource.
    - name: properties
      value: object
      description: |
        Properties under the marketplace gallery image resource
    - name: extendedLocation
      value: object
      description: |
        The extendedLocation of the resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

The operation to update a marketplace gallery image.

UPDATE azure_stack.azure_stack_hci.marketplace_gallery_images
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND marketplaceGalleryImageName = '{{ marketplaceGalleryImageName }}' --required
RETURNING
extendedLocation,
location,
properties,
tags;

DELETE examples

delete

The operation to delete a marketplace gallery image.

DELETE FROM azure_stack.azure_stack_hci.marketplace_gallery_images
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND marketplaceGalleryImageName = '{{ marketplaceGalleryImageName }}' --required
;