namespaces

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

Overview

Name	namespaces
Type	Resource
Id	azure.device_registry.namespaces

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.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
messaging	object	Assigned and unassigned messaging endpoints.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uuid	string	Globally unique, immutable, non-reusable ID.

list_by_resource_group

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.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
messaging	object	Assigned and unassigned messaging endpoints.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uuid	string	Globally unique, immutable, non-reusable ID.

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.
identity	object	The managed service identities assigned to this resource.
location	string	The geo-location where the resource lives. Required.
messaging	object	Assigned and unassigned messaging endpoints.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Accepted", and "Deleting". (Succeeded, Failed, Canceled, Accepted, Deleting)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
uuid	string	Globally unique, immutable, non-reusable ID.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, namespace_name, subscription_id		Get a Namespace.
list_by_resource_group	select	resource_group_name, subscription_id		List Namespace resources by resource group.
list_by_subscription	select	subscription_id		List Namespace resources by subscription ID.
create_or_replace	insert	resource_group_name, namespace_name, subscription_id, location		Create a Namespace.
update	update	resource_group_name, namespace_name, subscription_id		Update a Namespace.
create_or_replace	replace	resource_group_name, namespace_name, subscription_id, location		Create a Namespace.
delete	delete	resource_group_name, namespace_name, subscription_id		Delete a Namespace.
migrate	exec	resource_group_name, namespace_name, subscription_id		Migrate the resources into 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
namespace_name	string	The name of the namespace. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string

SELECT examples

get

Get a Namespace.

SELECT
id,
name,
identity,
location,
messaging,
provisioningState,
systemData,
tags,
type,
uuid
FROM azure.device_registry.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

List Namespace resources by resource group.

SELECT
id,
name,
identity,
location,
messaging,
provisioningState,
systemData,
tags,
type,
uuid
FROM azure.device_registry.namespaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List Namespace resources by subscription ID.

SELECT
id,
name,
identity,
location,
messaging,
provisioningState,
systemData,
tags,
type,
uuid
FROM azure.device_registry.namespaces
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_replace

Create a Namespace.

INSERT INTO azure.device_registry.namespaces (
tags,
location,
properties,
identity,
resource_group_name,
namespace_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ namespace_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
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: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      uuid: "{{ uuid }}"
      messaging:
        endpoints: "{{ endpoints }}"
      provisioningState: "{{ provisioningState }}"
  - name: identity
    description: |
      The managed service identities assigned to this resource.
    value:
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      type: "{{ type }}"

UPDATE examples

update

Update a Namespace.

UPDATE azure.device_registry.namespaces
SET 
identity = '{{ identity }}',
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_replace

Create a Namespace.

REPLACE azure.device_registry.namespaces
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
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,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a Namespace.

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

Lifecycle Methods

migrate

Migrate the resources into Namespace.

EXEC azure.device_registry.namespaces.migrate 
@resource_group_name='{{ resource_group_name }}' --required, 
@namespace_name='{{ namespace_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"scope": "{{ scope }}", 
"resourceIds": "{{ resourceIds }}"
}'
;