network_security_groups

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

Overview

Name	network_security_groups
Type	Resource
Id	azure_stack.azure_stack_hci_vm.network_security_groups

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.
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives. Required.
networkInterfaces	array	A collection of references to network interfaces that are currently using this NSG.
provisioningState	string	The provisioning state of the network security group resource. Known values are: "Succeeded", "Failed", "InProgress", "Accepted", "Deleting", and "Canceled". (Succeeded, Failed, InProgress, Accepted, Deleting, Canceled)
status	object	The observed state of Network Security Group.
subnets	array	A collection of references to logical networks that are currently using this NSG.
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.
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives. Required.
networkInterfaces	array	A collection of references to network interfaces that are currently using this NSG.
provisioningState	string	The provisioning state of the network security group resource. Known values are: "Succeeded", "Failed", "InProgress", "Accepted", "Deleting", and "Canceled". (Succeeded, Failed, InProgress, Accepted, Deleting, Canceled)
status	object	The observed state of Network Security Group.
subnets	array	A collection of references to logical networks that are currently using this NSG.
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_all

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.
eTag	string	If eTag is provided in the response body, it may also be provided as a header per the normal etag convention. Entity tags are used for comparing two or more entities from the same requested resource. HTTP/1.1 uses entity tags in the etag (section 14.19), If-Match (section 14.24), If-None-Match (section 14.26), and If-Range (section 14.27) header fields.
extendedLocation	object	The extendedLocation of the resource.
location	string	The geo-location where the resource lives. Required.
networkInterfaces	array	A collection of references to network interfaces that are currently using this NSG.
provisioningState	string	The provisioning state of the network security group resource. Known values are: "Succeeded", "Failed", "InProgress", "Accepted", "Deleting", and "Canceled". (Succeeded, Failed, InProgress, Accepted, Deleting, Canceled)
status	object	The observed state of Network Security Group.
subnets	array	A collection of references to logical networks that are currently using this NSG.
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_security_group_name, subscription_id		Gets the specified network security group.
list_by_resource_group	select	resource_group_name, subscription_id		Gets all network security groups in a resource group.
list_all	select	subscription_id		Gets all network security groups in a subscription.
create_or_update	insert	resource_group_name, network_security_group_name, subscription_id, location		Creates or updates a network security group in the specified resource group.
update_tags	update	resource_group_name, network_security_group_name, subscription_id		Updates a network security group tags.
create_or_update	replace	resource_group_name, network_security_group_name, subscription_id, location		Creates or updates a network security group in the specified resource group.
delete	delete	resource_group_name, network_security_group_name, subscription_id		Deletes the specified network security group.

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_security_group_name	string	Name of the network security group. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets the specified network security group.

SELECT
id,
name,
eTag,
extendedLocation,
location,
networkInterfaces,
provisioningState,
status,
subnets,
systemData,
tags,
type
FROM azure_stack.azure_stack_hci_vm.network_security_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_security_group_name = '{{ network_security_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Gets all network security groups in a resource group.

SELECT
id,
name,
eTag,
extendedLocation,
location,
networkInterfaces,
provisioningState,
status,
subnets,
systemData,
tags,
type
FROM azure_stack.azure_stack_hci_vm.network_security_groups
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_all

Gets all network security groups in a subscription.

SELECT
id,
name,
eTag,
extendedLocation,
location,
networkInterfaces,
provisioningState,
status,
subnets,
systemData,
tags,
type
FROM azure_stack.azure_stack_hci_vm.network_security_groups
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a network security group in the specified resource group.

INSERT INTO azure_stack.azure_stack_hci_vm.network_security_groups (
tags,
location,
properties,
extendedLocation,
resource_group_name,
network_security_group_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ extendedLocation }}',
'{{ resource_group_name }}',
'{{ network_security_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
eTag,
extendedLocation,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: network_security_groups
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_security_groups resource.
  - name: network_security_group_name
    value: "{{ network_security_group_name }}"
    description: Required parameter for the network_security_groups resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_security_groups resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      networkInterfaces:
        - id: "{{ id }}"
      subnets:
        - id: "{{ id }}"
      provisioningState: "{{ provisioningState }}"
      status:
        errorCode: "{{ errorCode }}"
        errorMessage: "{{ errorMessage }}"
        provisioningStatus:
          operationId: "{{ operationId }}"
          status: "{{ status }}"
  - name: extendedLocation
    description: |
      The extendedLocation of the resource.
    value:
      name: "{{ name }}"
      type: "{{ type }}"

UPDATE examples

update_tags

Updates a network security group tags.

UPDATE azure_stack.azure_stack_hci_vm.network_security_groups
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_security_group_name = '{{ network_security_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
eTag,
extendedLocation,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a network security group in the specified resource group.

REPLACE azure_stack.azure_stack_hci_vm.network_security_groups
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
extendedLocation = '{{ extendedLocation }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_security_group_name = '{{ network_security_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
eTag,
extendedLocation,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes the specified network security group.

DELETE FROM azure_stack.azure_stack_hci_vm.network_security_groups
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_security_group_name = '{{ network_security_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;