namespaces

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

Overview

Name	namespaces
Type	Resource
Id	azure.relay.namespaces

Fields

vw_namespaces

Name	Datatype	Description
created_at	text	field from the properties object
location	text	Resource location.
metric_id	text	field from the properties object
namespaceName	text	field from the properties object
private_endpoint_connections	text	field from the properties object
provisioning_state	text	field from the properties object
public_network_access	text	field from the properties object
resourceGroupName	text	field from the properties object
service_bus_endpoint	text	field from the properties object
sku	text	SKU of the namespace.
status	text	field from the properties object
subscriptionId	text	field from the properties object
system_data	text	field from the properties object
tags	text	Resource tags.
updated_at	text	field from the properties object

namespaces

Name	Datatype	Description
location	string	Resource location.
properties	object	Properties of the namespace.
sku	object	SKU of the namespace.
systemData	object	Metadata pertaining to creation and last modification of the resource.
tags	object	Resource tags.

Methods

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

SELECT examples

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

vw_namespaces

SELECT
created_at,
location,
metric_id,
namespaceName,
private_endpoint_connections,
provisioning_state,
public_network_access,
resourceGroupName,
service_bus_endpoint,
sku,
status,
subscriptionId,
system_data,
tags,
updated_at
FROM azure.relay.vw_namespaces
WHERE subscriptionId = '{{ subscriptionId }}';

namespaces

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

INSERT example

Use the following StackQL query and manifest file to create a new namespaces resource.

All Properties

/*+ create */
INSERT INTO azure.relay.namespaces (
namespaceName,
resourceGroupName,
subscriptionId,
sku,
properties,
location,
tags
)
SELECT 
'{{ namespaceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ sku }}',
'{{ properties }}',
'{{ location }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: string
    - name: systemData
      value:
        - name: createdBy
          value: string
        - name: createdByType
          value: string
        - name: createdAt
          value: string
        - name: lastModifiedBy
          value: string
        - name: lastModifiedByType
          value: string
        - name: lastModifiedAt
          value: string
    - name: properties
      value:
        - name: provisioningState
          value: string
        - name: status
          value: string
        - name: createdAt
          value: string
        - name: updatedAt
          value: string
        - name: serviceBusEndpoint
          value: string
        - name: metricId
          value: string
        - name: privateEndpointConnections
          value:
            - - name: id
                value: string
              - name: name
                value: string
              - name: type
                value: string
              - name: location
                value: string
              - name: properties
                value:
                  - name: privateEndpoint
                    value:
                      - name: id
                        value: string
                  - name: privateLinkServiceConnectionState
                    value:
                      - name: status
                        value: string
                      - name: description
                        value: string
                  - name: provisioningState
                    value: string
        - name: publicNetworkAccess
          value: string
    - name: location
      value: string
    - name: tags
      value: object

UPDATE example

Updates a namespaces resource.

/*+ update */
UPDATE azure.relay.namespaces
SET 
sku = '{{ sku }}',
properties = '{{ properties }}',
tags = '{{ tags }}'
WHERE 
namespaceName = '{{ namespaceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';

DELETE example

Deletes the specified namespaces resource.

/*+ delete */
DELETE FROM azure.relay.namespaces
WHERE namespaceName = '{{ namespaceName }}'
AND resourceGroupName = '{{ resourceGroupName }}'
AND subscriptionId = '{{ subscriptionId }}';