network_function_definition_versions

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

Overview

Name	network_function_definition_versions
Type	Resource
Id	azure.hybrid_network.network_function_definition_versions

Fields

The following fields are returned by SELECT queries:

get

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

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Network function definition version properties.
tags	object	Resource tags.

list_by_network_function_definition_group

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

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Network function definition 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	resourceGroupName, publisherName, networkFunctionDefinitionGroupName, networkFunctionDefinitionVersionName, subscriptionId		Gets information about a network function definition version.
list_by_network_function_definition_group	select	resourceGroupName, publisherName, networkFunctionDefinitionGroupName, subscriptionId		Gets information about a list of network function definition versions under a network function definition group.
create_or_update	insert	resourceGroupName, publisherName, networkFunctionDefinitionGroupName, networkFunctionDefinitionVersionName, subscriptionId		Creates or updates a network function definition version.
update	update	resourceGroupName, publisherName, networkFunctionDefinitionGroupName, networkFunctionDefinitionVersionName, subscriptionId		Updates a network function definition version resource.
delete	delete	resourceGroupName, publisherName, networkFunctionDefinitionGroupName, networkFunctionDefinitionVersionName, subscriptionId		Deletes the specified network function definition version.
update_state	exec	resourceGroupName, publisherName, networkFunctionDefinitionGroupName, networkFunctionDefinitionVersionName, subscriptionId		Update network function definition 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
networkFunctionDefinitionGroupName	string	The name of the network function definition group.
networkFunctionDefinitionVersionName	string	The name of the network function definition 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 function definition version.

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

list_by_network_function_definition_group

Gets information about a list of network function definition versions under a network function definition group.

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

INSERT examples

create_or_update

Creates or updates a network function definition version.

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

Manifest

# Description fields are for documentation purposes
- name: network_function_definition_versions
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the network_function_definition_versions resource.
    - name: publisherName
      value: string
      description: Required parameter for the network_function_definition_versions resource.
    - name: networkFunctionDefinitionGroupName
      value: string
      description: Required parameter for the network_function_definition_versions resource.
    - name: networkFunctionDefinitionVersionName
      value: string
      description: Required parameter for the network_function_definition_versions resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the network_function_definition_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 function definition version properties.

UPDATE examples

update

Updates a network function definition version resource.

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

DELETE examples

delete

Deletes the specified network function definition version.

DELETE FROM azure.hybrid_network.network_function_definition_versions
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND publisherName = '{{ publisherName }}' --required
AND networkFunctionDefinitionGroupName = '{{ networkFunctionDefinitionGroupName }}' --required
AND networkFunctionDefinitionVersionName = '{{ networkFunctionDefinitionVersionName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

update_state

Update network function definition version state.

EXEC azure.hybrid_network.network_function_definition_versions.update_state 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@publisherName='{{ publisherName }}' --required, 
@networkFunctionDefinitionGroupName='{{ networkFunctionDefinitionGroupName }}' --required, 
@networkFunctionDefinitionVersionName='{{ networkFunctionDefinitionVersionName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"versionState": "{{ versionState }}"
}'
;