network_function_definition_groups

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

Overview

Name	network_function_definition_groups
Type	Resource
Id	azure.hybrid_network.network_function_definition_groups

Fields

The following fields are returned by SELECT queries:

get

Request is successful. The operation returns the resulting publisher network function definition group resource.

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

list_by_publisher

Request is successful. The operation returns the resulting networkFunctionDefinition group resource.

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

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

list_by_publisher

Gets information of the network function definition groups under a publisher.

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

INSERT examples

create_or_update

Creates or updates a network function definition group.

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

Manifest

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

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

DELETE examples

delete

Deletes a specified network function definition group.

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