sites

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

Overview

Name	sites
Type	Resource
Id	azure.mobile_network.sites

Fields

The following fields are returned by SELECT queries:

get

Request successful. The operation returns the resulting mobile network site resource.

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

list_by_mobile_network

Request successful. The operation returns a list of mobile network resources.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Site properties.
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, mobileNetworkName, siteName		Gets information about the specified mobile network site.
list_by_mobile_network	select	subscriptionId, resourceGroupName, mobileNetworkName		Lists all sites in the mobile network.
create_or_update	insert	subscriptionId, resourceGroupName, mobileNetworkName, siteName		Creates or updates a mobile network site. Must be created in the same location as its parent mobile network.
delete	delete	subscriptionId, resourceGroupName, mobileNetworkName, siteName		Deletes the specified mobile network site. This will also delete any network functions that are a part of this site.
update_tags	exec	subscriptionId, resourceGroupName, mobileNetworkName, siteName		Updates site tags.

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

SELECT examples

get

Gets information about the specified mobile network site.

SELECT
location,
properties,
tags
FROM azure.mobile_network.sites
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND mobileNetworkName = '{{ mobileNetworkName }}' -- required
AND siteName = '{{ siteName }}' -- required
;

list_by_mobile_network

Lists all sites in the mobile network.

SELECT
location,
properties,
tags
FROM azure.mobile_network.sites
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND mobileNetworkName = '{{ mobileNetworkName }}' -- required
;

INSERT examples

create_or_update

Creates or updates a mobile network site. Must be created in the same location as its parent mobile network.

INSERT INTO azure.mobile_network.sites (
data__properties,
data__tags,
data__location,
subscriptionId,
resourceGroupName,
mobileNetworkName,
siteName
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ mobileNetworkName }}',
'{{ siteName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: sites
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the sites resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the sites resource.
    - name: mobileNetworkName
      value: string
      description: Required parameter for the sites resource.
    - name: siteName
      value: string
      description: Required parameter for the sites resource.
    - name: properties
      value: object
      description: |
        Site properties.
    - 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 mobile network site. This will also delete any network functions that are a part of this site.

DELETE FROM azure.mobile_network.sites
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND mobileNetworkName = '{{ mobileNetworkName }}' --required
AND siteName = '{{ siteName }}' --required
;

Lifecycle Methods

update_tags

Updates site tags.

EXEC azure.mobile_network.sites.update_tags 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@mobileNetworkName='{{ mobileNetworkName }}' --required, 
@siteName='{{ siteName }}' --required 
@@json=
'{
"tags": "{{ tags }}"
}'
;