address

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

Overview

Name	address
Type	Resource
Id	azure_extras.edgeorder.address

Fields

The following fields are returned by SELECT queries:

get_address_by_name

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
addressValidationStatus	string	Status of address validation. Known values are: "Valid", "Invalid", and "Ambiguous".
contactDetails	object	Contact details for the address. Required.
location	string	The geo-location where the resource lives. Required.
shippingAddress	object	Shipping details for the address.
systemData	object	Represents resource creation and update time.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get_address_by_name	select	address_name, resource_group_name, subscription_id		Gets information about the specified address.
create_address	insert	address_name, resource_group_name, subscription_id, location, properties		Creates a new address with the specified parameters. Existing address can be updated with this API.
update_address	update	address_name, resource_group_name, subscription_id	If-Match	Updates the properties of an existing address.
delete_address_by_name	delete	address_name, resource_group_name, subscription_id		Deletes 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
address_name	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. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
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. Default value is None.

SELECT examples

get_address_by_name

Gets information about the specified address.

SELECT
id,
name,
addressValidationStatus,
contactDetails,
location,
shippingAddress,
systemData,
tags,
type
FROM azure_extras.edgeorder.address
WHERE address_name = '{{ address_name }}' -- required
AND resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_address

Creates a new address with the specified parameters. Existing address can be updated with this API.

INSERT INTO azure_extras.edgeorder.address (
tags,
location,
properties,
address_name,
resource_group_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}' /* required */,
'{{ address_name }}',
'{{ resource_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: address
props:
  - name: address_name
    value: "{{ address_name }}"
    description: Required parameter for the address resource.
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the address resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the address resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    value:
      shippingAddress:
        streetAddress1: "{{ streetAddress1 }}"
        streetAddress2: "{{ streetAddress2 }}"
        streetAddress3: "{{ streetAddress3 }}"
        city: "{{ city }}"
        stateOrProvince: "{{ stateOrProvince }}"
        country: "{{ country }}"
        postalCode: "{{ postalCode }}"
        zipExtendedCode: "{{ zipExtendedCode }}"
        companyName: "{{ companyName }}"
        addressType: "{{ addressType }}"
      contactDetails:
        contactName: "{{ contactName }}"
        phone: "{{ phone }}"
        phoneExtension: "{{ phoneExtension }}"
        mobile: "{{ mobile }}"
        emailList:
          - "{{ emailList }}"

UPDATE examples

update_address

Updates the properties of an existing address.

UPDATE azure_extras.edgeorder.address
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
address_name = '{{ address_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND If-Match = '{{ If-Match}}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete_address_by_name

Deletes an address.

DELETE FROM azure_extras.edgeorder.address
WHERE address_name = '{{ address_name }}' --required
AND resource_group_name = '{{ resource_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;