addresses
Creates, updates, deletes, gets or lists a addresses
resource.
Overview
Name | addresses |
Type | Resource |
Id | azure_extras.edge_order.addresses |
Fields
- vw_addresses
- addresses
Name | Datatype | Description |
---|---|---|
addressName | text | field from the properties object |
address_classification | text | field from the properties object |
address_validation_status | text | field from the properties object |
contact_details | text | field from the properties object |
location | text | The geo-location where the resource lives |
provisioning_state | text | field from the properties object |
resourceGroupName | text | field from the properties object |
shipping_address | text | field from the properties object |
subscriptionId | text | field from the properties object |
tags | text | Resource tags. |
Name | Datatype | Description |
---|---|---|
location | string | The geo-location where the resource lives |
properties | object | Address Properties. |
tags | object | Resource tags. |
Methods
Name | Accessible by | Required Params | Description |
---|---|---|---|
get | SELECT | addressName, resourceGroupName, subscriptionId | Get information about the specified address. |
list_by_resource_group | SELECT | resourceGroupName, subscriptionId | List all the addresses available under the given resource group. |
list_by_subscription | SELECT | subscriptionId | List all the addresses available under the subscription. |
create | INSERT | addressName, resourceGroupName, subscriptionId, 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. | |||
delete | DELETE | addressName, resourceGroupName, subscriptionId | Delete an address. |
update | UPDATE | addressName, resourceGroupName, subscriptionId | Update the properties of an existing address. |
SELECT
examples
List all the addresses available under the subscription.
- vw_addresses
- addresses
SELECT
addressName,
address_classification,
address_validation_status,
contact_details,
location,
provisioning_state,
resourceGroupName,
shipping_address,
subscriptionId,
tags
FROM azure_extras.edge_order.vw_addresses
WHERE subscriptionId = '{{ subscriptionId }}';
SELECT
location,
properties,
tags
FROM azure_extras.edge_order.addresses
WHERE subscriptionId = '{{ subscriptionId }}';
INSERT
example
Use the following StackQL query and manifest file to create a new addresses
resource.
- All Properties
- Manifest
/*+ create */
INSERT INTO azure_extras.edge_order.addresses (
addressName,
resourceGroupName,
subscriptionId,
data__properties,
tags,
location,
properties
)
SELECT
'{{ addressName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ data__properties }}',
'{{ tags }}',
'{{ location }}',
'{{ properties }}'
;
- name: your_resource_model_name
props:
- name: tags
value: object
- name: location
value: string
- name: properties
value:
- name: addressClassification
value: []
- name: shippingAddress
value:
- name: streetAddress1
value: string
- name: streetAddress2
value: string
- name: streetAddress3
value: string
- name: city
value: string
- name: stateOrProvince
value: string
- name: country
value: string
- name: postalCode
value: string
- name: zipExtendedCode
value: string
- name: companyName
value: string
- name: addressType
value: string
- name: contactDetails
value:
- name: contactName
value: string
- name: phone
value: string
- name: phoneExtension
value: string
- name: mobile
value: string
- name: emailList
value:
- string
- name: addressValidationStatus
value: string
- name: provisioningState
value: []
UPDATE
example
Updates a addresses
resource.
/*+ update */
UPDATE azure_extras.edge_order.addresses
SET
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE
addressName = '{{ addressName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';
DELETE
example
Deletes the specified addresses
resource.
/*+ delete */
DELETE FROM azure_extras.edge_order.addresses
WHERE addressName = '{{ addressName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';