network_service_design_versions

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

Overview

Name	network_service_design_versions
Type	Resource
Id	azure.hybrid_network.network_service_design_versions

Fields

The following fields are returned by SELECT queries:

get

Request is successful. The operation returns the resulting networkServiceDesignVersion resource.

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

list_by_network_service_design_group

Request is successful. The operation returns the resulting networkServiceDesignVersion resource.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	network service design version 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, networkServiceDesignVersionName		Gets information about a network service design version.
list_by_network_service_design_group	select	subscriptionId, resourceGroupName, publisherName, networkServiceDesignGroupName		Gets information about a list of network service design versions under a network service design group.
create_or_update	insert	subscriptionId, resourceGroupName, publisherName, networkServiceDesignGroupName, networkServiceDesignVersionName		Creates or updates a network service design version.
update	update	subscriptionId, resourceGroupName, publisherName, networkServiceDesignGroupName, networkServiceDesignVersionName		Updates a network service design version resource.
delete	delete	subscriptionId, resourceGroupName, publisherName, networkServiceDesignGroupName, networkServiceDesignVersionName		Deletes the specified network service design version.
update_state	exec	subscriptionId, resourceGroupName, publisherName, networkServiceDesignGroupName, networkServiceDesignVersionName		Update network service design version state.

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.
networkServiceDesignVersionName	string	The name of the network service design version. The name should conform to the SemVer 2.0.0 specification: https://semver.org/spec/v2.0.0.html.
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 a network service design version.

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

list_by_network_service_design_group

Gets information about a list of network service design versions under a network service design group.

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

INSERT examples

create_or_update

Creates or updates a network service design version.

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

Manifest

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

UPDATE examples

update

Updates a network service design version resource.

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

DELETE examples

delete

Deletes the specified network service design version.

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

Lifecycle Methods

update_state

Update network service design version state.

EXEC azure.hybrid_network.network_service_design_versions.update_state 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@publisherName='{{ publisherName }}' --required, 
@networkServiceDesignGroupName='{{ networkServiceDesignGroupName }}' --required, 
@networkServiceDesignVersionName='{{ networkServiceDesignVersionName }}' --required 
@@json=
'{
"versionState": "{{ versionState }}"
}'
;