extended_zones

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

Overview

Name	extended_zones
Type	Resource
Id	azure.edge_zones.extended_zones

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
displayName	string	Display name of the Azure Extended Zone. Required.
geography	string	Geography of the Azure Extended Zone. Required.
geographyGroup	string	The Geography Group of the Azure Extended Zone. Required.
homeLocation	string	The Home Location of the Azure Extended Zone. Required.
latitude	string	The Latitude of the Azure Extended Zone. Required.
longitude	string	The Longitude of the Azure Extended Zone. Required.
provisioningState	string	Status of the last operation performed by the subscription on the Edge Zone resource. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
regionCategory	string	Category of region for the Azure Extended Zone. Required.
regionType	string	Type of region for the Azure Extended Zone. Required.
regionalDisplayName	string	Regional display name of the Azure Extended Zone. Required.
registrationState	string	Indicates the Azure Extended Zone registration’s approval status. Known values are: "NotRegistered", "PendingRegister", "Registered", and "PendingUnregister". (NotRegistered, PendingRegister, Registered, PendingUnregister)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
displayName	string	Display name of the Azure Extended Zone. Required.
geography	string	Geography of the Azure Extended Zone. Required.
geographyGroup	string	The Geography Group of the Azure Extended Zone. Required.
homeLocation	string	The Home Location of the Azure Extended Zone. Required.
latitude	string	The Latitude of the Azure Extended Zone. Required.
longitude	string	The Longitude of the Azure Extended Zone. Required.
provisioningState	string	Status of the last operation performed by the subscription on the Edge Zone resource. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted". (Succeeded, Failed, Canceled, Provisioning, Updating, Deleting, Accepted)
regionCategory	string	Category of region for the Azure Extended Zone. Required.
regionType	string	Type of region for the Azure Extended Zone. Required.
regionalDisplayName	string	Regional display name of the Azure Extended Zone. Required.
registrationState	string	Indicates the Azure Extended Zone registration’s approval status. Known values are: "NotRegistered", "PendingRegister", "Registered", and "PendingUnregister". (NotRegistered, PendingRegister, Registered, PendingUnregister)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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	select	extended_zone_name, subscription_id		Gets an Azure Extended Zone for a subscription.
list_by_subscription	select	subscription_id		Lists the Azure Extended Zones available to a subscription.
register	exec	extended_zone_name, subscription_id		Registers a subscription for an Extended Zone.
unregister	exec	extended_zone_name, subscription_id		Unregisters a subscription for an Extended Zone.

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
extended_zone_name	string	The name of the ExtendedZone. Required.
subscription_id	string

SELECT examples

get

Gets an Azure Extended Zone for a subscription.

SELECT
id,
name,
displayName,
geography,
geographyGroup,
homeLocation,
latitude,
longitude,
provisioningState,
regionCategory,
regionType,
regionalDisplayName,
registrationState,
systemData,
type
FROM azure.edge_zones.extended_zones
WHERE extended_zone_name = '{{ extended_zone_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

Lists the Azure Extended Zones available to a subscription.

SELECT
id,
name,
displayName,
geography,
geographyGroup,
homeLocation,
latitude,
longitude,
provisioningState,
regionCategory,
regionType,
regionalDisplayName,
registrationState,
systemData,
type
FROM azure.edge_zones.extended_zones
WHERE subscription_id = '{{ subscription_id }}' -- required
;

Lifecycle Methods

register

Registers a subscription for an Extended Zone.

EXEC azure.edge_zones.extended_zones.register 
@extended_zone_name='{{ extended_zone_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

unregister

Unregisters a subscription for an Extended Zone.

EXEC azure.edge_zones.extended_zones.unregister 
@extended_zone_name='{{ extended_zone_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;