namespaces

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

Overview

Name	namespaces
Type	Resource
Id	azure.relay.namespaces

Fields

The following fields are returned by SELECT queries:

get

Namespace description returned successfully.

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Description of Relay namespace
sku	object	SKU of the namespace.
systemData	object	The system meta data relating to this resource.
tags	object	Resource tags.

list_by_resource_group

Namespaces by resource group returned successfully

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Description of Relay namespace
sku	object	SKU of the namespace.
systemData	object	The system meta data relating to this resource.
tags	object	Resource tags.

list

Namespaces returned successfully

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Description of Relay namespace
sku	object	SKU of the namespace.
systemData	object	The system meta data relating to this resource.
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resourceGroupName, namespaceName, subscriptionId		Returns the description for the specified namespace.
list_by_resource_group	select	resourceGroupName, subscriptionId		Lists all the available namespaces within the ResourceGroup.
list	select	subscriptionId		Lists all the available namespaces within the subscription regardless of the resourceGroups.
create_or_update	insert	resourceGroupName, namespaceName, subscriptionId		Create Azure Relay namespace.
update	update	resourceGroupName, namespaceName, subscriptionId		Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
delete	delete	resourceGroupName, namespaceName, subscriptionId		Deletes an existing namespace. This operation also removes all associated resources under the namespace.
regenerate_keys	exec	resourceGroupName, namespaceName, authorizationRuleName, subscriptionId, keyType		Regenerates the primary or secondary connection strings to the namespace.
check_name_availability	exec	subscriptionId, name		Check the specified namespace name availability.

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
authorizationRuleName	string	The authorization rule name.
namespaceName	string	The namespace name
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string	The ID of the target subscription.

SELECT examples

get

Returns the description for the specified namespace.

SELECT
location,
properties,
sku,
systemData,
tags
FROM azure.relay.namespaces
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND namespaceName = '{{ namespaceName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list_by_resource_group

Lists all the available namespaces within the ResourceGroup.

SELECT
location,
properties,
sku,
systemData,
tags
FROM azure.relay.namespaces
WHERE resourceGroupName = '{{ resourceGroupName }}' -- required
AND subscriptionId = '{{ subscriptionId }}' -- required
;

list

Lists all the available namespaces within the subscription regardless of the resourceGroups.

SELECT
location,
properties,
sku,
systemData,
tags
FROM azure.relay.namespaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
;

INSERT examples

create_or_update

Create Azure Relay namespace.

INSERT INTO azure.relay.namespaces (
data__sku,
data__properties,
data__tags,
data__location,
resourceGroupName,
namespaceName,
subscriptionId
)
SELECT 
'{{ sku }}',
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ resourceGroupName }}',
'{{ namespaceName }}',
'{{ subscriptionId }}'
RETURNING
location,
properties,
sku,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: namespaces
  props:
    - name: resourceGroupName
      value: string
      description: Required parameter for the namespaces resource.
    - name: namespaceName
      value: string
      description: Required parameter for the namespaces resource.
    - name: subscriptionId
      value: string
      description: Required parameter for the namespaces resource.
    - name: sku
      value: object
      description: |
        SKU of the namespace.
    - name: properties
      value: object
      description: |
        Description of Relay namespace
    - name: tags
      value: object
      description: |
        Resource tags.
    - name: location
      value: string
      description: |
        The geo-location where the resource lives

UPDATE examples

update

Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.

UPDATE azure.relay.namespaces
SET 
data__sku = '{{ sku }}',
data__properties = '{{ properties }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND namespaceName = '{{ namespaceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
location,
properties,
sku,
systemData,
tags;

DELETE examples

delete

Deletes an existing namespace. This operation also removes all associated resources under the namespace.

DELETE FROM azure.relay.namespaces
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND namespaceName = '{{ namespaceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

regenerate_keys

Regenerates the primary or secondary connection strings to the namespace.

EXEC azure.relay.namespaces.regenerate_keys 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@namespaceName='{{ namespaceName }}' --required, 
@authorizationRuleName='{{ authorizationRuleName }}' --required, 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"keyType": "{{ keyType }}", 
"key": "{{ key }}"
}'
;

check_name_availability

Check the specified namespace name availability.

EXEC azure.relay.namespaces.check_name_availability 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"name": "{{ name }}"
}'
;