namespaces

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

Overview

Name	namespaces
Type	Resource
Id	azure.event_hubs.namespaces

Fields

The following fields are returned by SELECT queries:

get

Namespace returned successfully.

Name	Datatype	Description
identity	object	Properties of BYOK Identity description
location	string	Resource location.
properties		Namespace properties supplied for create namespace operation.
sku	object	Properties of sku resource
systemData	object	The system meta data relating to this resource.
tags	object	Resource tags.

list_by_resource_group

Namespaces returned successfully.

Name	Datatype	Description
identity	object	Properties of BYOK Identity description
location	string	Resource location.
properties		Namespace properties supplied for create namespace operation.
sku	object	Properties of sku resource
systemData	object	The system meta data relating to this resource.
tags	object	Resource tags.

list

Namespaces returned successfully.

Name	Datatype	Description
identity	object	Properties of BYOK Identity description
location	string	Resource location.
properties		Namespace properties supplied for create namespace operation.
sku	object	Properties of sku resource
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		Gets the description of the specified namespace.
list_by_resource_group	select	resourceGroupName, subscriptionId		Lists the available Namespaces within a resource group.
list	select	subscriptionId		Lists all the available Namespaces within a subscription, irrespective of the resource groups.
create_or_update	insert	resourceGroupName, namespaceName, subscriptionId, data__location		Creates or updates a namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
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.
check_name_availability	exec	subscriptionId, name		Check the give Namespace name availability.
regenerate_keys	exec	resourceGroupName, namespaceName, authorizationRuleName, subscriptionId, keyType		Regenerates the primary or secondary connection strings for the specified 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
authorizationRuleName	string	The authorization rule name.
namespaceName	string	The Namespace name
resourceGroupName	string	Name of the resource group within the azure subscription.
subscriptionId	string	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

SELECT examples

get

Gets the description of the specified namespace.

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

list_by_resource_group

Lists the available Namespaces within a resource group.

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

list

Lists all the available Namespaces within a subscription, irrespective of the resource groups.

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

INSERT examples

create_or_update

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

INSERT INTO azure.event_hubs.namespaces (
data__sku,
data__identity,
data__properties,
data__location,
data__tags,
resourceGroupName,
namespaceName,
subscriptionId
)
SELECT 
'{{ sku }}',
'{{ identity }}',
'{{ properties }}',
'{{ location }}' /* required */,
'{{ tags }}',
'{{ resourceGroupName }}',
'{{ namespaceName }}',
'{{ subscriptionId }}'
RETURNING
identity,
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: |
        Properties of sku resource
    - name: identity
      value: object
      description: |
        Properties of BYOK Identity description
    - name: properties
      value: string
      description: |
        Namespace properties supplied for create namespace operation.
    - name: location
      value: string
      description: |
        Resource location.
    - name: tags
      value: object
      description: |
        Resource tags.

UPDATE examples

update

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

UPDATE azure.event_hubs.namespaces
SET 
data__sku = '{{ sku }}',
data__identity = '{{ identity }}',
data__properties = '{{ properties }}',
data__location = '{{ location }}',
data__tags = '{{ tags }}'
WHERE 
resourceGroupName = '{{ resourceGroupName }}' --required
AND namespaceName = '{{ namespaceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
RETURNING
identity,
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.event_hubs.namespaces
WHERE resourceGroupName = '{{ resourceGroupName }}' --required
AND namespaceName = '{{ namespaceName }}' --required
AND subscriptionId = '{{ subscriptionId }}' --required
;

Lifecycle Methods

check_name_availability

Check the give Namespace name availability.

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

regenerate_keys

Regenerates the primary or secondary connection strings for the specified Namespace.

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