upf_deployments

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

Overview

Name	upf_deployments
Type	Resource
Id	azure_extras.mobile_packet_core.upf_deployments

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, upfDeploymentName		Get a UpfDeploymentResource
list_by_resource_group	select	subscriptionId, resourceGroupName		List all User Plane Function Deployments by Resource ID.
list_by_subscription	select	subscriptionId		List all User Plane Function Deployments by Subscription ID.
create_or_update	insert	subscriptionId, resourceGroupName, upfDeploymentName		Create a UpfDeploymentResource
delete	delete	subscriptionId, resourceGroupName, upfDeploymentName		Delete a UpfDeploymentResource
update_tags	exec	subscriptionId, resourceGroupName, upfDeploymentName		Update a UpfDeploymentResource

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
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
upfDeploymentName	string	The name of the UpfDeployment

SELECT examples

get

Get a UpfDeploymentResource

SELECT
location,
properties,
tags
FROM azure_extras.mobile_packet_core.upf_deployments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND upfDeploymentName = '{{ upfDeploymentName }}' -- required
;

list_by_resource_group

List all User Plane Function Deployments by Resource ID.

SELECT
location,
properties,
tags
FROM azure_extras.mobile_packet_core.upf_deployments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

List all User Plane Function Deployments by Subscription ID.

SELECT
location,
properties,
tags
FROM azure_extras.mobile_packet_core.upf_deployments
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create a UpfDeploymentResource

INSERT INTO azure_extras.mobile_packet_core.upf_deployments (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
upfDeploymentName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ upfDeploymentName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: upf_deployments
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the upf_deployments resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the upf_deployments resource.
    - name: upfDeploymentName
      value: string
      description: Required parameter for the upf_deployments 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 UpfDeploymentResource

DELETE FROM azure_extras.mobile_packet_core.upf_deployments
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND upfDeploymentName = '{{ upfDeploymentName }}' --required
;

Lifecycle Methods

update_tags

Update a UpfDeploymentResource

EXEC azure_extras.mobile_packet_core.upf_deployments.update_tags 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@upfDeploymentName='{{ upfDeploymentName }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;