network_racks

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

Overview

Name	network_racks
Type	Resource
Id	azure_extras.managed_network_fabric.network_racks

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
annotation	string	Switch configuration description.
configurationState	string	Configuration state of the resource. Known values are: "Succeeded", "Failed", "Rejected", "Accepted", "Provisioned", "ErrorProvisioning", "Deprovisioning", "Deprovisioned", "ErrorDeprovisioning", "DeferredControl", "Provisioning", "PendingCommit", and "PendingAdministrativeUpdate". (Succeeded, Failed, Rejected, Accepted, Provisioned, ErrorProvisioning, Deprovisioning, Deprovisioned, ErrorDeprovisioning, DeferredControl, Provisioning, PendingCommit, PendingAdministrativeUpdate)
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
networkDevices	array	List of network device ARM resource IDs.
networkFabricId	string	ARM resource ID of the Network Fabric. Required.
networkRackType	string	Network Rack SKU name. Known values are: "Aggregate", "Compute", and "Combined". (Aggregate, Compute, Combined)
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
annotation	string	Switch configuration description.
configurationState	string	Configuration state of the resource. Known values are: "Succeeded", "Failed", "Rejected", "Accepted", "Provisioned", "ErrorProvisioning", "Deprovisioning", "Deprovisioned", "ErrorDeprovisioning", "DeferredControl", "Provisioning", "PendingCommit", and "PendingAdministrativeUpdate". (Succeeded, Failed, Rejected, Accepted, Provisioned, ErrorProvisioning, Deprovisioning, Deprovisioned, ErrorDeprovisioning, DeferredControl, Provisioning, PendingCommit, PendingAdministrativeUpdate)
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
networkDevices	array	List of network device ARM resource IDs.
networkFabricId	string	ARM resource ID of the Network Fabric. Required.
networkRackType	string	Network Rack SKU name. Known values are: "Aggregate", "Compute", and "Combined". (Aggregate, Compute, Combined)
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
annotation	string	Switch configuration description.
configurationState	string	Configuration state of the resource. Known values are: "Succeeded", "Failed", "Rejected", "Accepted", "Provisioned", "ErrorProvisioning", "Deprovisioning", "Deprovisioned", "ErrorDeprovisioning", "DeferredControl", "Provisioning", "PendingCommit", and "PendingAdministrativeUpdate". (Succeeded, Failed, Rejected, Accepted, Provisioned, ErrorProvisioning, Deprovisioning, Deprovisioned, ErrorDeprovisioning, DeferredControl, Provisioning, PendingCommit, PendingAdministrativeUpdate)
lastOperation	object	Details of the last operation performed on the resource.
location	string	The geo-location where the resource lives. Required.
networkDevices	array	List of network device ARM resource IDs.
networkFabricId	string	ARM resource ID of the Network Fabric. Required.
networkRackType	string	Network Rack SKU name. Known values are: "Aggregate", "Compute", and "Combined". (Aggregate, Compute, Combined)
provisioningState	string	Provisioning state of the resource. Known values are: "Accepted", "Succeeded", "Updating", "Deleting", "Failed", and "Canceled". (Accepted, Succeeded, Updating, Deleting, Failed, Canceled)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, network_rack_name, subscription_id		Get Network Rack resource details.
list_by_resource_group	select	resource_group_name, subscription_id		List all Network Rack resources in the given resource group.
list_by_subscription	select	subscription_id		List all Network Rack resources in the given subscription.
create	insert	resource_group_name, network_rack_name, subscription_id, location, properties		Create Network Rack resource.
update	update	resource_group_name, network_rack_name, subscription_id		Update certain properties of the Network Rack resource.
delete	delete	resource_group_name, network_rack_name, subscription_id		Delete Network Rack resource.

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
network_rack_name	string	Name of the Network Rack. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get Network Rack resource details.

SELECT
id,
name,
annotation,
configurationState,
lastOperation,
location,
networkDevices,
networkFabricId,
networkRackType,
provisioningState,
systemData,
tags,
type
FROM azure_extras.managed_network_fabric.network_racks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_rack_name = '{{ network_rack_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List all Network Rack resources in the given resource group.

SELECT
id,
name,
annotation,
configurationState,
lastOperation,
location,
networkDevices,
networkFabricId,
networkRackType,
provisioningState,
systemData,
tags,
type
FROM azure_extras.managed_network_fabric.network_racks
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List all Network Rack resources in the given subscription.

SELECT
id,
name,
annotation,
configurationState,
lastOperation,
location,
networkDevices,
networkFabricId,
networkRackType,
provisioningState,
systemData,
tags,
type
FROM azure_extras.managed_network_fabric.network_racks
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create Network Rack resource.

INSERT INTO azure_extras.managed_network_fabric.network_racks (
tags,
location,
properties,
resource_group_name,
network_rack_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ resource_group_name }}',
'{{ network_rack_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: network_racks
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_racks resource.
  - name: network_rack_name
    value: "{{ network_rack_name }}"
    description: Required parameter for the network_racks resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_racks resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Network Rack Properties. Required.
    value:
      annotation: "{{ annotation }}"
      networkRackType: "{{ networkRackType }}"
      networkFabricId: "{{ networkFabricId }}"
      networkDevices:
        - "{{ networkDevices }}"
      lastOperation:
        details: "{{ details }}"
      provisioningState: "{{ provisioningState }}"
      configurationState: "{{ configurationState }}"

UPDATE examples

update

Update certain properties of the Network Rack resource.

UPDATE azure_extras.managed_network_fabric.network_racks
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_rack_name = '{{ network_rack_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete Network Rack resource.

DELETE FROM azure_extras.managed_network_fabric.network_racks
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_rack_name = '{{ network_rack_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;