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:

list_keys

Name	Datatype	Description
keyName	string	A string that describes the authorization rule.
primaryConnectionString	string	Primary connection string of the created namespace authorization rule.
primaryKey	string	A base64-encoded 256-bit primary key for signing and validating the SAS token.
secondaryConnectionString	string	Secondary connection string of the created namespace authorization rule.
secondaryKey	string	A base64-encoded 256-bit secondary key for signing and validating the SAS token.

get

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
createdAt	string (date-time)	The time the namespace was created.
location	string	Resource location. Required.
metricId	string	Identifier for Azure Insights metrics.
provisioningState	string	Known values are: "Created", "Succeeded", "Deleted", "Failed", "Updating", and "Unknown".
serviceBusEndpoint	string	Endpoint you can use to perform Service Bus operations.
sku	object	SKU of the namespace.
tags	object	Resource tags.
type	string	Resource type.
updatedAt	string (date-time)	The time the namespace was updated.

list_by_resource_group

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
createdAt	string (date-time)	The time the namespace was created.
location	string	Resource location. Required.
metricId	string	Identifier for Azure Insights metrics.
provisioningState	string	Known values are: "Created", "Succeeded", "Deleted", "Failed", "Updating", and "Unknown".
serviceBusEndpoint	string	Endpoint you can use to perform Service Bus operations.
sku	object	SKU of the namespace.
tags	object	Resource tags.
type	string	Resource type.
updatedAt	string (date-time)	The time the namespace was updated.

check_name_availability

Name	Datatype	Description
message	string	The detailed info regarding the reason associated with the namespace.
nameAvailable	boolean	Value indicating namespace is available. Returns true if the namespace is available; otherwise, false.
reason	string	The reason for unavailability of a namespace. Known values are: "None", "InvalidName", "SubscriptionIsDisabled", "NameInUse", "NameInLockdown", and "TooManyNamespaceInCurrentSubscription".

list

Name	Datatype	Description
id	string	Resource ID.
name	string	Resource name.
createdAt	string (date-time)	The time the namespace was created.
location	string	Resource location. Required.
metricId	string	Identifier for Azure Insights metrics.
provisioningState	string	Known values are: "Created", "Succeeded", "Deleted", "Failed", "Updating", and "Unknown".
serviceBusEndpoint	string	Endpoint you can use to perform Service Bus operations.
sku	object	SKU of the namespace.
tags	object	Resource tags.
type	string	Resource type.
updatedAt	string (date-time)	The time the namespace was updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
list_keys	select	resource_group_name, namespace_name, authorization_rule_name, subscription_id		Primary and secondary connection strings to the namespace.
get	select	resource_group_name, namespace_name, subscription_id		Returns the description for the specified namespace.
list_by_resource_group	select	resource_group_name, subscription_id		Lists all the available namespaces within the ResourceGroup.
check_name_availability	select	subscription_id		Check the specified namespace name availability.
list	select	subscription_id		Lists all the available namespaces within the subscription regardless of the resourceGroups.
create_or_update	insert	resource_group_name, namespace_name, subscription_id, location		Create Azure Relay namespace.
update	update	resource_group_name, namespace_name, subscription_id		Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
create_or_update	replace	resource_group_name, namespace_name, subscription_id, location		Create Azure Relay namespace.
delete	delete	resource_group_name, namespace_name, subscription_id		Deletes an existing namespace. This operation also removes all associated resources under the namespace.
list_authorization_rules	exec	resource_group_name, namespace_name, subscription_id		Authorization rules for a namespace.
get_authorization_rule	exec	resource_group_name, namespace_name, authorization_rule_name, subscription_id		Authorization rule for a namespace by name.
create_or_update_authorization_rule	exec	resource_group_name, namespace_name, authorization_rule_name, subscription_id, properties		Creates or updates an authorization rule for a namespace.
delete_authorization_rule	exec	resource_group_name, namespace_name, authorization_rule_name, subscription_id		Deletes a namespace authorization rule.
regenerate_keys	exec	resource_group_name, namespace_name, authorization_rule_name, subscription_id, keyType		Regenerates the primary or secondary connection strings to the namespace.

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
authorization_rule_name	string	The authorization rule name. Required.
namespace_name	string	The namespace name. Required.
resource_group_name	string	Name of the Resource group within the Azure subscription. Required.
subscription_id	string

SELECT examples

list_keys

Primary and secondary connection strings to the namespace.

SELECT
keyName,
primaryConnectionString,
primaryKey,
secondaryConnectionString,
secondaryKey
FROM azure.relay.namespaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND authorization_rule_name = '{{ authorization_rule_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

get

Returns the description for the specified namespace.

SELECT
id,
name,
createdAt,
location,
metricId,
provisioningState,
serviceBusEndpoint,
sku,
tags,
type,
updatedAt
FROM azure.relay.namespaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Lists all the available namespaces within the ResourceGroup.

SELECT
id,
name,
createdAt,
location,
metricId,
provisioningState,
serviceBusEndpoint,
sku,
tags,
type,
updatedAt
FROM azure.relay.namespaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

check_name_availability

Check the specified namespace name availability.

SELECT
message,
nameAvailable,
reason
FROM azure.relay.namespaces
WHERE subscription_id = '{{ subscription_id }}' -- required
;

list

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

SELECT
id,
name,
createdAt,
location,
metricId,
provisioningState,
serviceBusEndpoint,
sku,
tags,
type,
updatedAt
FROM azure.relay.namespaces
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update

Create Azure Relay namespace.

INSERT INTO azure.relay.namespaces (
location,
tags,
sku,
resource_group_name,
namespace_name,
subscription_id
)
SELECT 
'{{ location }}' /* required */,
'{{ tags }}',
'{{ sku }}',
'{{ resource_group_name }}',
'{{ namespace_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
sku,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: namespaces
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the namespaces resource.
  - name: namespace_name
    value: "{{ namespace_name }}"
    description: Required parameter for the namespaces resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the namespaces resource.
  - name: location
    value: "{{ location }}"
    description: |
      Resource location. Required.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: sku
    description: |
      SKU of the namespace.
    value:
      name: "{{ name }}"
      tier: "{{ tier }}"

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 
tags = '{{ tags }}',
sku = '{{ sku }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
sku,
tags,
type;

REPLACE examples

create_or_update

Create Azure Relay namespace.

REPLACE azure.relay.namespaces
SET 
location = '{{ location }}',
tags = '{{ tags }}',
sku = '{{ sku }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
location,
properties,
sku,
tags,
type;

DELETE examples

delete

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

DELETE FROM azure.relay.namespaces
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;

Lifecycle Methods

list_authorization_rules

Authorization rules for a namespace.

EXEC azure.relay.namespaces.list_authorization_rules 
@resource_group_name='{{ resource_group_name }}' --required, 
@namespace_name='{{ namespace_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

get_authorization_rule

Authorization rule for a namespace by name.

EXEC azure.relay.namespaces.get_authorization_rule 
@resource_group_name='{{ resource_group_name }}' --required, 
@namespace_name='{{ namespace_name }}' --required, 
@authorization_rule_name='{{ authorization_rule_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

create_or_update_authorization_rule

Creates or updates an authorization rule for a namespace.

EXEC azure.relay.namespaces.create_or_update_authorization_rule 
@resource_group_name='{{ resource_group_name }}' --required, 
@namespace_name='{{ namespace_name }}' --required, 
@authorization_rule_name='{{ authorization_rule_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"properties": "{{ properties }}"
}'
;

delete_authorization_rule

Deletes a namespace authorization rule.

EXEC azure.relay.namespaces.delete_authorization_rule 
@resource_group_name='{{ resource_group_name }}' --required, 
@namespace_name='{{ namespace_name }}' --required, 
@authorization_rule_name='{{ authorization_rule_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

regenerate_keys

Regenerates the primary or secondary connection strings to the namespace.

EXEC azure.relay.namespaces.regenerate_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@namespace_name='{{ namespace_name }}' --required, 
@authorization_rule_name='{{ authorization_rule_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"keyType": "{{ keyType }}", 
"key": "{{ key }}"
}'
;