namespaces

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

Overview

Name	namespaces
Type	Resource
Id	azure.notification_hubs.namespaces

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Represents namespace properties.
sku	object	The resource model definition representing SKU
tags	object	Resource tags.

list

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Represents namespace properties.
sku	object	The resource model definition representing SKU
tags	object	Resource tags.

list_all

Name	Datatype	Description
location	string	The geo-location where the resource lives
properties	object	Represents namespace properties.
sku	object	The resource model definition representing SKU
tags	object	Resource tags.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, namespaceName
list	select	subscriptionId, resourceGroupName	$skipToken, $top
list_all	select	subscriptionId	$skipToken, $top
create_or_update	insert	subscriptionId, resourceGroupName, namespaceName, data__location, data__sku
update	update	subscriptionId, resourceGroupName, namespaceName
delete	delete	subscriptionId, resourceGroupName, namespaceName
check_availability	exec	subscriptionId, name
regenerate_keys	exec	subscriptionId, resourceGroupName, namespaceName, authorizationRuleName, policyKey

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	Authorization Rule Name
namespaceName	string	Namespace name
resourceGroupName	string	The name of the resource group. The name is case insensitive.
subscriptionId	string (uuid)	The ID of the target subscription. The value must be an UUID.
$skipToken	string	Skip token for subsequent requests.
$top	integer (int32)	Maximum number of results to return.

SELECT examples

get

Success

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

list

Success

SELECT
location,
properties,
sku,
tags
FROM azure.notification_hubs.namespaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND $skipToken = '{{ $skipToken }}'
AND $top = '{{ $top }}'
;

list_all

Success

SELECT
location,
properties,
sku,
tags
FROM azure.notification_hubs.namespaces
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $skipToken = '{{ $skipToken }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

No description available.

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

Manifest

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

UPDATE examples

update

No description available.

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

DELETE examples

delete

No description available.

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

Lifecycle Methods

check_availability

Success

EXEC azure.notification_hubs.namespaces.check_availability 
@subscriptionId='{{ subscriptionId }}' --required 
@@json=
'{
"name": "{{ name }}", 
"location": "{{ location }}", 
"tags": "{{ tags }}", 
"isAvailiable": {{ isAvailiable }}, 
"sku": "{{ sku }}"
}'
;

regenerate_keys

Success

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