amf_deployments

Creates, updates, deletes, gets or lists an amf_deployments resource.

Overview

Name	amf_deployments
Type	Resource
Id	azure_extras.mobile_packet_core.amf_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, amfDeploymentName		Get a AmfDeploymentResource
list_by_resource_group	select	subscriptionId, resourceGroupName		List all Access and Mobility Function Deployments by Resource Group.
list_by_subscription	select	subscriptionId		List all Access and Mobility Function Deployments by Subscription ID.
create_or_update	insert	subscriptionId, resourceGroupName, amfDeploymentName		Create a AmfDeploymentResource
delete	delete	subscriptionId, resourceGroupName, amfDeploymentName		Delete a AmfDeploymentResource
update_tags	exec	subscriptionId, resourceGroupName, amfDeploymentName		Update a AmfDeploymentResource

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
amfDeploymentName	string	The name of the AMF Deployment
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.

SELECT examples

get

Get a AmfDeploymentResource

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

list_by_resource_group

List all Access and Mobility Function Deployments by Resource Group.

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

list_by_subscription

List all Access and Mobility Function Deployments by Subscription ID.

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

INSERT examples

create_or_update

Create a AmfDeploymentResource

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

Manifest

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

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

Lifecycle Methods

update_tags

Update a AmfDeploymentResource

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