network_functions

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

Overview

Name	network_functions
Type	Resource
Id	azure.mpc_network_function.network_functions

Fields

The following fields are returned by SELECT queries:

get

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_resource_group

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
tags	object	Resource tags.

list_by_subscription

Azure operation completed successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	The resource-specific properties for this resource.
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, networkFunctionName		Get a NetworkFunctionResource
list_by_resource_group	select	subscriptionId, resourceGroupName		List NetworkFunctionResource resources by resource group
list_by_subscription	select	subscriptionId		List NetworkFunctionResource resources by subscription ID
create_or_update	insert	subscriptionId, resourceGroupName, networkFunctionName		Create a NetworkFunctionResource
delete	delete	subscriptionId, resourceGroupName, networkFunctionName		Delete a NetworkFunctionResource
update_tags	exec	subscriptionId, resourceGroupName, networkFunctionName		Update a NetworkFunctionResource

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

Get a NetworkFunctionResource

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

list_by_resource_group

List NetworkFunctionResource resources by resource group

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

list_by_subscription

List NetworkFunctionResource resources by subscription ID

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

INSERT examples

create_or_update

Create a NetworkFunctionResource

INSERT INTO azure.mpc_network_function.network_functions (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
networkFunctionName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ networkFunctionName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: network_functions
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the network_functions resource.
    - 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: properties
      value: object
      description: |
        The resource-specific properties for this resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

DELETE examples

delete

Delete a NetworkFunctionResource

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

Lifecycle Methods

update_tags

Update a NetworkFunctionResource

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