azure_bare_metal_storage_instances

Creates, updates, deletes, gets or lists an azure_bare_metal_storage_instances resource.

Overview

Name	azure_bare_metal_storage_instances
Type	Resource
Id	azure.bare_metal_infrastructure.azure_bare_metal_storage_instances

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
identity	object	The identity of Azure Bare Metal Storage Instance, if configured.
location	string	The geo-location where the resource lives
properties	object	AzureBareMetalStorageInstance properties
tags	object	Resource tags.

list_by_resource_group

Name	Datatype	Description
identity	object	The identity of Azure Bare Metal Storage Instance, if configured.
location	string	The geo-location where the resource lives
properties	object	AzureBareMetalStorageInstance properties
tags	object	Resource tags.

list_by_subscription

Name	Datatype	Description
identity	object	The identity of Azure Bare Metal Storage Instance, if configured.
location	string	The geo-location where the resource lives
properties	object	AzureBareMetalStorageInstance properties
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, azureBareMetalStorageInstanceName		Gets an Azure Bare Metal Storage instance for the specified subscription, resource group, and instance name.
list_by_resource_group	select	subscriptionId, resourceGroupName		Gets a list of AzureBareMetalStorage instances in the specified subscription and resource group. The operations returns various properties of each Azure Bare Metal Instance.
list_by_subscription	select	subscriptionId		Gets a list of AzureBareMetalStorage instances in the specified subscription. The operations returns various properties of each Azure Bare Metal Instance.
create	insert	subscriptionId, resourceGroupName, azureBareMetalStorageInstanceName		Creates an Azure Bare Metal Storage Instance for the specified subscription, resource group, and instance name.
update	update	subscriptionId, resourceGroupName, azureBareMetalStorageInstanceName		Patches the Tags field of a Azure BareMetalStorage instance for the specified subscription, resource group, and instance name.
delete	delete	subscriptionId, resourceGroupName, azureBareMetalStorageInstanceName		Deletes an Azure Bare Metal Storage Instance for the specified subscription, resource group, and instance name.

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
azureBareMetalStorageInstanceName	string	Name of the Azure Bare Metal Storage Instance, also known as the ResourceName.
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 an Azure Bare Metal Storage instance for the specified subscription, resource group, and instance name.

SELECT
identity,
location,
properties,
tags
FROM azure.bare_metal_infrastructure.azure_bare_metal_storage_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND azureBareMetalStorageInstanceName = '{{ azureBareMetalStorageInstanceName }}' -- required
;

list_by_resource_group

Gets a list of AzureBareMetalStorage instances in the specified subscription and resource group. The operations returns various properties of each Azure Bare Metal Instance.

SELECT
identity,
location,
properties,
tags
FROM azure.bare_metal_infrastructure.azure_bare_metal_storage_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Gets a list of AzureBareMetalStorage instances in the specified subscription. The operations returns various properties of each Azure Bare Metal Instance.

SELECT
identity,
location,
properties,
tags
FROM azure.bare_metal_infrastructure.azure_bare_metal_storage_instances
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create

Creates an Azure Bare Metal Storage Instance for the specified subscription, resource group, and instance name.

INSERT INTO azure.bare_metal_infrastructure.azure_bare_metal_storage_instances (
data__properties,
data__identity,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
azureBareMetalStorageInstanceName
)
SELECT 
'{{ properties }}',
'{{ identity }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ azureBareMetalStorageInstanceName }}'
RETURNING
identity,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: azure_bare_metal_storage_instances
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the azure_bare_metal_storage_instances resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the azure_bare_metal_storage_instances resource.
    - name: azureBareMetalStorageInstanceName
      value: string
      description: Required parameter for the azure_bare_metal_storage_instances resource.
    - name: properties
      value: object
      description: |
        AzureBareMetalStorageInstance properties
    - name: identity
      value: object
      description: |
        The identity of Azure Bare Metal Storage Instance, if configured.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Patches the Tags field of a Azure BareMetalStorage instance for the specified subscription, resource group, and instance name.

UPDATE azure.bare_metal_infrastructure.azure_bare_metal_storage_instances
SET 
data__identity = '{{ identity }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND azureBareMetalStorageInstanceName = '{{ azureBareMetalStorageInstanceName }}' --required
RETURNING
identity,
location,
properties,
tags;

DELETE examples

delete

Deletes an Azure Bare Metal Storage Instance for the specified subscription, resource group, and instance name.

DELETE FROM azure.bare_metal_infrastructure.azure_bare_metal_storage_instances
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND azureBareMetalStorageInstanceName = '{{ azureBareMetalStorageInstanceName }}' --required
;