network_functions

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

Overview

Name	network_functions
Type	Resource
Id	azure.hybrid_network.network_functions

Fields

The following fields are returned by SELECT queries:

get

Operation is successful. The operation returns the resulting network function resource.

Name	Datatype	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
identity	object	The managed identity of the network function.
location	string	The geo-location where the resource lives
properties	object	Network function properties.
tags	object	Resource tags.

list_by_resource_group

Request is successful. The operation returns a list of network function resources.

Name	Datatype	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
identity	object	The managed identity of the network function.
location	string	The geo-location where the resource lives
properties	object	Network function properties.
tags	object	Resource tags.

list_by_subscription

Request is successful. The operation returns a list of network function resources.

Name	Datatype	Description
etag	string	A unique read-only string that changes whenever the resource is updated.
identity	object	The managed identity of the network function.
location	string	The geo-location where the resource lives
properties	object	Network function 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, networkFunctionName, subscriptionId		Gets information about the specified network function resource.
list_by_resource_group	select	resourceGroupName, subscriptionId		Lists all the network function resources in a resource group.
list_by_subscription	select	subscriptionId		Lists all the network functions in a subscription.
create_or_update	insert	resourceGroupName, networkFunctionName, subscriptionId		Creates or updates a network function resource.
delete	delete	resourceGroupName, networkFunctionName, subscriptionId		Deletes the specified network function resource.
update_tags	exec	resourceGroupName, networkFunctionName, subscriptionId		Updates the tags for the network function resource.
execute_request	exec	resourceGroupName, networkFunctionName, subscriptionId, serviceEndpoint, requestMetadata		Execute a request to services on a containerized network function.

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
networkFunctionName	string	The name of the network function.
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 network function resource.

SELECT
etag,
identity,
location,
properties,
tags
FROM azure.hybrid_network.network_functions
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND networkFunctionName = '{{ networkFunctionName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

Lists all the network function resources in a resource group.

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

list_by_subscription

Lists all the network functions in a subscription.

SELECT
etag,
identity,
location,
properties,
tags
FROM azure.hybrid_network.network_functions
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Creates or updates a network function resource.

INSERT INTO azure.hybrid_network.network_functions (
data__properties,
data__etag,
data__identity,
data__tags,
data__location,
resourceGroupName,
networkFunctionName,
subscriptionId
)
SELECT 
'{{ properties }}',
'{{ etag }}',
'{{ identity }}',
'{{ tags }}',
'{{ location }}',
'{{ resourceGroupName }}',
'{{ networkFunctionName }}',
'{{ subscriptionId }}'
RETURNING
etag,
identity,
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: network_functions
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the network_functions resource.
    - name: networkFunctionName
      value: string
      description: Required parameter for the network_functions resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the network_functions resource.
    - name: properties
      value: object
      description: |
        Network function properties.
    - name: etag
      value: string
      description: |
        A unique read-only string that changes whenever the resource is updated.
    - name: identity
      value: object
      description: |
        The managed identity of the network function.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

DELETE examples

delete

Deletes the specified network function resource.

DELETE FROM azure.hybrid_network.network_functions
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND networkFunctionName = '{{ networkFunctionName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

update_tags

Updates the tags for the network function resource.

EXEC azure.hybrid_network.network_functions.update_tags 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@networkFunctionName='{{ networkFunctionName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;

execute_request

Execute a request to services on a containerized network function.

EXEC azure.hybrid_network.network_functions.execute_request 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@networkFunctionName='{{ networkFunctionName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"serviceEndpoint": "{{ serviceEndpoint }}", 
"requestMetadata": "{{ requestMetadata }}"
}'
;