network_functions

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

Overview

Name	network_functions
Type	Resource
Id	azure_extras.hybrid_network.network_functions

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
allowSoftwareUpdate	boolean	Indicates if software updates are allowed during deployment.
configurationType	string	The value which indicates if NF values are secrets. Required. Known values are: "Unknown", "Secret", and "Open".
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. Required.
networkFunctionDefinitionGroupName	string	The network function definition group name for the network function.
networkFunctionDefinitionOfferingLocation	string	The location of the network function definition offering.
networkFunctionDefinitionVersion	string	The network function definition version for the network function.
networkFunctionDefinitionVersionResourceReference	object	The network function definition version resource reference.
nfviId	string	The nfviId for the network function.
nfviType	string	The nfvi type for the network function. Known values are: "Unknown", "AzureArcKubernetes", "AzureCore", and "AzureOperatorNexus".
provisioningState	string	The provisioning state of the network function resource. Known values are: "Unknown", "Succeeded", "Accepted", "Deleting", "Failed", "Canceled", "Deleted", and "Converging".
publisherName	string	The publisher name for the network function.
publisherScope	string	The scope of the publisher. Known values are: "Unknown" and "Private".
roleOverrideValues	array	The role configuration override values from the user.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
allowSoftwareUpdate	boolean	Indicates if software updates are allowed during deployment.
configurationType	string	The value which indicates if NF values are secrets. Required. Known values are: "Unknown", "Secret", and "Open".
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. Required.
networkFunctionDefinitionGroupName	string	The network function definition group name for the network function.
networkFunctionDefinitionOfferingLocation	string	The location of the network function definition offering.
networkFunctionDefinitionVersion	string	The network function definition version for the network function.
networkFunctionDefinitionVersionResourceReference	object	The network function definition version resource reference.
nfviId	string	The nfviId for the network function.
nfviType	string	The nfvi type for the network function. Known values are: "Unknown", "AzureArcKubernetes", "AzureCore", and "AzureOperatorNexus".
provisioningState	string	The provisioning state of the network function resource. Known values are: "Unknown", "Succeeded", "Accepted", "Deleting", "Failed", "Canceled", "Deleted", and "Converging".
publisherName	string	The publisher name for the network function.
publisherScope	string	The scope of the publisher. Known values are: "Unknown" and "Private".
roleOverrideValues	array	The role configuration override values from the user.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
allowSoftwareUpdate	boolean	Indicates if software updates are allowed during deployment.
configurationType	string	The value which indicates if NF values are secrets. Required. Known values are: "Unknown", "Secret", and "Open".
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. Required.
networkFunctionDefinitionGroupName	string	The network function definition group name for the network function.
networkFunctionDefinitionOfferingLocation	string	The location of the network function definition offering.
networkFunctionDefinitionVersion	string	The network function definition version for the network function.
networkFunctionDefinitionVersionResourceReference	object	The network function definition version resource reference.
nfviId	string	The nfviId for the network function.
nfviType	string	The nfvi type for the network function. Known values are: "Unknown", "AzureArcKubernetes", "AzureCore", and "AzureOperatorNexus".
provisioningState	string	The provisioning state of the network function resource. Known values are: "Unknown", "Succeeded", "Accepted", "Deleting", "Failed", "Canceled", "Deleted", and "Converging".
publisherName	string	The publisher name for the network function.
publisherScope	string	The scope of the publisher. Known values are: "Unknown" and "Private".
roleOverrideValues	array	The role configuration override values from the user.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, network_function_name, subscription_id		Gets information about the specified network function resource.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all the network function resources in a resource group.
list_by_subscription	select	subscription_id		Lists all the network functions in a subscription.
create_or_update	insert	resource_group_name, network_function_name, subscription_id, location		Creates or updates a network function resource.
update_tags	update	resource_group_name, network_function_name, subscription_id		Updates the tags for the network function resource.
create_or_update	replace	resource_group_name, network_function_name, subscription_id, location		Creates or updates a network function resource.
delete	delete	resource_group_name, network_function_name, subscription_id		Deletes the specified network function resource.
execute_request	exec	resource_group_name, network_function_name, subscription_id, 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
network_function_name	string	The name of the network function. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Gets information about the specified network function resource.

SELECT
id,
name,
allowSoftwareUpdate,
configurationType,
etag,
identity,
location,
networkFunctionDefinitionGroupName,
networkFunctionDefinitionOfferingLocation,
networkFunctionDefinitionVersion,
networkFunctionDefinitionVersionResourceReference,
nfviId,
nfviType,
provisioningState,
publisherName,
publisherScope,
roleOverrideValues,
systemData,
tags,
type
FROM azure_extras.hybrid_network.network_functions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND network_function_name = '{{ network_function_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all the network function resources in a resource group.

SELECT
id,
name,
allowSoftwareUpdate,
configurationType,
etag,
identity,
location,
networkFunctionDefinitionGroupName,
networkFunctionDefinitionOfferingLocation,
networkFunctionDefinitionVersion,
networkFunctionDefinitionVersionResourceReference,
nfviId,
nfviType,
provisioningState,
publisherName,
publisherScope,
roleOverrideValues,
systemData,
tags,
type
FROM azure_extras.hybrid_network.network_functions
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists all the network functions in a subscription.

SELECT
id,
name,
allowSoftwareUpdate,
configurationType,
etag,
identity,
location,
networkFunctionDefinitionGroupName,
networkFunctionDefinitionOfferingLocation,
networkFunctionDefinitionVersion,
networkFunctionDefinitionVersionResourceReference,
nfviId,
nfviType,
provisioningState,
publisherName,
publisherScope,
roleOverrideValues,
systemData,
tags,
type
FROM azure_extras.hybrid_network.network_functions
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Creates or updates a network function resource.

INSERT INTO azure_extras.hybrid_network.network_functions (
tags,
location,
properties,
etag,
identity,
resource_group_name,
network_function_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ etag }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ network_function_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: network_functions
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the network_functions resource.
  - name: network_function_name
    value: "{{ network_function_name }}"
    description: Required parameter for the network_functions resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the network_functions resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      Network function properties.
    value:
      provisioningState: "{{ provisioningState }}"
      publisherName: "{{ publisherName }}"
      publisherScope: "{{ publisherScope }}"
      networkFunctionDefinitionGroupName: "{{ networkFunctionDefinitionGroupName }}"
      networkFunctionDefinitionVersion: "{{ networkFunctionDefinitionVersion }}"
      networkFunctionDefinitionOfferingLocation: "{{ networkFunctionDefinitionOfferingLocation }}"
      networkFunctionDefinitionVersionResourceReference:
        idType: "{{ idType }}"
      nfviType: "{{ nfviType }}"
      nfviId: "{{ nfviId }}"
      allowSoftwareUpdate: {{ allowSoftwareUpdate }}
      configurationType: "{{ configurationType }}"
      roleOverrideValues:
        - "{{ roleOverrideValues }}"
  - name: etag
    value: "{{ etag }}"
    description: |
      A unique read-only string that changes whenever the resource is updated.
  - name: identity
    description: |
      The managed identity of the network function.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update_tags

Updates the tags for the network function resource.

UPDATE azure_extras.hybrid_network.network_functions
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_function_name = '{{ network_function_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

Creates or updates a network function resource.

REPLACE azure_extras.hybrid_network.network_functions
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
etag = '{{ etag }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND network_function_name = '{{ network_function_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
etag,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Deletes the specified network function resource.

DELETE FROM azure_extras.hybrid_network.network_functions
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND network_function_name = '{{ network_function_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

execute_request

Execute a request to services on a containerized network function.

EXEC azure_extras.hybrid_network.network_functions.execute_request 
@resource_group_name='{{ resource_group_name }}' --required, 
@network_function_name='{{ network_function_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"serviceEndpoint": "{{ serviceEndpoint }}", 
"requestMetadata": "{{ requestMetadata }}"
}'
;