racks

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

Overview

Name	racks
Type	Resource
Id	azure.nexus.racks

Fields

The following fields are returned by SELECT queries:

get

The resource has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster associated with the resource. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: RackProperties represents the properties of the rack.)
tags	object	Resource tags.

list_by_resource_group

The resource list has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster associated with the resource. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: RackProperties represents the properties of the rack.)
tags	object	Resource tags.

list_by_subscription

The resource list has been successfully retrieved.

Name	Datatype	Description
extendedLocation	object	The extended location of the cluster associated with the resource. (title: ExtendedLocation represents the Azure custom location where the resource will be created.)
location	string	The geo-location where the resource lives
properties	object	The list of the resource properties. (title: RackProperties represents the properties of the rack.)
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, rackName		Get properties of the provided rack.
list_by_resource_group	select	subscriptionId, resourceGroupName		Get a list of racks in the provided resource group.
list_by_subscription	select	subscriptionId		Get a list of racks in the provided subscription.
create_or_update	insert	subscriptionId, resourceGroupName, rackName, data__extendedLocation, data__properties		Create a new rack or update properties of the existing one. All customer initiated requests will be rejected as the life cycle of this resource is managed by the system.
update	update	subscriptionId, resourceGroupName, rackName		Patch properties of the provided rack, or update the tags associated with the rack. Properties and tag updates can be done independently.
delete	delete	subscriptionId, resourceGroupName, rackName		Delete the provided rack. All customer initiated requests will be rejected as the life cycle of this resource is managed by the system.

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
rackName	string	The name of the rack.
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

Get properties of the provided rack.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.nexus.racks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND rackName = '{{ rackName }}' -- required
;

list_by_resource_group

Get a list of racks in the provided resource group.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.nexus.racks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

Get a list of racks in the provided subscription.

SELECT
extendedLocation,
location,
properties,
tags
FROM azure.nexus.racks
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create a new rack or update properties of the existing one.
All customer initiated requests will be rejected as the life cycle of this resource is managed by the system.

INSERT INTO azure.nexus.racks (
data__extendedLocation,
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
rackName
)
SELECT 
'{{ extendedLocation }}' /* required */,
'{{ properties }}' /* required */,
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ rackName }}'
RETURNING
extendedLocation,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: racks
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the racks resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the racks resource.
    - name: rackName
      value: string
      description: Required parameter for the racks resource.
    - name: extendedLocation
      value: object
      description: |
        The extended location of the cluster associated with the resource.
    - name: properties
      value: object
      description: |
        The list of the resource properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Patch properties of the provided rack, or update the tags associated with the rack. Properties and tag updates can be done independently.

UPDATE azure.nexus.racks
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND rackName = '{{ rackName }}' --required
RETURNING
extendedLocation,
location,
properties,
tags;

DELETE examples

delete

Delete the provided rack.
All customer initiated requests will be rejected as the life cycle of this resource is managed by the system.

DELETE FROM azure.nexus.racks
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND rackName = '{{ rackName }}' --required
;