network_service_design_groups

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

Overview

Name	network_service_design_groups
Type	Resource
Id	azure.hybrid_network.network_service_design_groups

Fields

The following fields are returned by SELECT queries:

get

Request is successful. The operation returns the resulting publisher network service design group resource.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	network service design group properties.
tags	object	Resource tags.

list_by_publisher

Request is successful. The operation returns the resulting network service design group resource.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	network service design group 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, publisherName, networkServiceDesignGroupName		Gets information about the specified networkServiceDesign group.
list_by_publisher	select	subscriptionId, resourceGroupName, publisherName		Gets information of the network service design groups under a publisher.
create_or_update	insert	subscriptionId, resourceGroupName, publisherName, networkServiceDesignGroupName		Creates or updates a network service design group.
update	update	subscriptionId, resourceGroupName, publisherName, networkServiceDesignGroupName		Updates a network service design groups resource.
delete	delete	subscriptionId, resourceGroupName, publisherName, networkServiceDesignGroupName		Deletes a specified network service design 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
networkServiceDesignGroupName	string	The name of the network service design group.
publisherName	string	The name of the publisher.
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Gets information about the specified networkServiceDesign group.

SELECT
location,
properties,
tags
FROM azure.hybrid_network.network_service_design_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND publisherName = '{{ publisherName }}' -- required
AND networkServiceDesignGroupName = '{{ networkServiceDesignGroupName }}' -- required
;

list_by_publisher

Gets information of the network service design groups under a publisher.

SELECT
location,
properties,
tags
FROM azure.hybrid_network.network_service_design_groups
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND publisherName = '{{ publisherName }}' -- required
;

INSERT examples

create_or_update

Creates or updates a network service design group.

INSERT INTO azure.hybrid_network.network_service_design_groups (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
publisherName,
networkServiceDesignGroupName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ publisherName }}',
'{{ networkServiceDesignGroupName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: network_service_design_groups
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the network_service_design_groups resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the network_service_design_groups resource.
    - name: publisherName
      value: string
      description: Required parameter for the network_service_design_groups resource.
    - name: networkServiceDesignGroupName
      value: string
      description: Required parameter for the network_service_design_groups resource.
    - name: properties
      value: object
      description: |
        network service design group properties.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Updates a network service design groups resource.

UPDATE azure.hybrid_network.network_service_design_groups
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND publisherName = '{{ publisherName }}' --required
AND networkServiceDesignGroupName = '{{ networkServiceDesignGroupName }}' --required
RETURNING
location,
properties,
tags;

DELETE examples

delete

Deletes a specified network service design group.

DELETE FROM azure.hybrid_network.network_service_design_groups
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND publisherName = '{{ publisherName }}' --required
AND networkServiceDesignGroupName = '{{ networkServiceDesignGroupName }}' --required
;