addresses

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

Overview

Name	addresses
Type	Resource
Id	azure_extras.edge_order.addresses

Fields

The following fields are returned by SELECT queries:

get

Address object.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of an address.
tags	object	Resource tags.

list_by_resource_group

List of addresses available under the resource group.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of an address.
tags	object	Resource tags.

list_by_subscription

List of addresses available under the subscription.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Properties of an address.
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, addressName		Get information about the specified address.
list_by_resource_group	select	subscriptionId, resourceGroupName	$filter, $skipToken, $top	List all the addresses available under the given resource group.
list_by_subscription	select	subscriptionId	$filter, $skipToken, $top	List all the addresses available under the subscription.
create	insert	subscriptionId, resourceGroupName, addressName, data__properties		Create a new address with the specified parameters. Existing address cannot be updated with this API and should instead be updated with the Update address API.
update	update	subscriptionId, resourceGroupName, addressName	If-Match	Update the properties of an existing address.
delete	delete	subscriptionId, resourceGroupName, addressName		Delete an address.

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
addressName	string	The name of the address Resource within the specified resource group. address names must be between 3 and 24 characters in length and use any alphanumeric and underscore only.
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.
$filter	string	$filter is supported to filter based on shipping address properties. Filter supports only equals operation.
$skipToken	string	$skipToken is supported on Get list of addresses, which provides the next page in the list of addresses.
$top	integer (int32)	$top is supported on fetching list of resources. $top=10 means that the first 10 items in the list will be returned to the API caller.
If-Match	string	Defines the If-Match condition. The patch will be performed only if the ETag of the job on the server matches this value.

SELECT examples

get

Get information about the specified address.

SELECT
location,
properties,
tags
FROM azure_extras.edge_order.addresses
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND addressName = '{{ addressName }}' -- required
;

list_by_resource_group

List all the addresses available under the given resource group.

SELECT
location,
properties,
tags
FROM azure_extras.edge_order.addresses
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND $filter = '{{ $filter }}'
AND $skipToken = '{{ $skipToken }}'
AND $top = '{{ $top }}'
;

list_by_subscription

List all the addresses available under the subscription.

SELECT
location,
properties,
tags
FROM azure_extras.edge_order.addresses
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $skipToken = '{{ $skipToken }}'
AND $top = '{{ $top }}'
;

INSERT examples

create

Create a new address with the specified parameters. Existing address cannot be updated with this API and should
instead be updated with the Update address API.

INSERT INTO azure_extras.edge_order.addresses (
data__tags,
data__location,
data__properties,
subscriptionId,
resourceGroupName,
addressName
)
SELECT 
'{{ tags }}',
'{{ location }}',
'{{ properties }}' /* required */,
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ addressName }}'
RETURNING
location,
properties,
tags
;

Manifest

# Description fields are for documentation purposes
- name: addresses
  props:
    - name: subscriptionId
      value: string (uuid)
      description: Required parameter for the addresses resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the addresses resource.
    - name: addressName
      value: string
      description: Required parameter for the addresses resource.
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives
    - name: properties
      value: object
      description: |
        Properties of an address.

UPDATE examples

update

Update the properties of an existing address.

UPDATE azure_extras.edge_order.addresses
SET 
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND addressName = '{{ addressName }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
location,
properties,
tags;

DELETE examples

delete

Delete an address.

DELETE FROM azure_extras.edge_order.addresses
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND addressName = '{{ addressName }}' --required
;