namespaces

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

Overview

Name	namespaces
Type	Resource
Id	azure.service_bus.namespaces

Fields

vw_namespaces

Name	Datatype	Description
alternate_name	text	field from the properties object
created_at	text	field from the properties object
disable_local_auth	text	field from the properties object
encryption	text	field from the properties object
identity	text	Properties to configure User Assigned Identities for Bring your Own Keys
location	text	The Geo-location where the resource lives
metric_id	text	field from the properties object
minimum_tls_version	text	field from the properties object
namespaceName	text	field from the properties object
premium_messaging_partitions	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
zone_redundant	text	field from the properties object

namespaces

Name	Datatype	Description
identity	object	Properties to configure User Assigned Identities for Bring your Own Keys
location	string	The Geo-location where the resource lives
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	Gets a description for the specified namespace.
list	SELECT	subscriptionId	Gets all the available namespaces within the subscription, irrespective of the resource groups.
list_by_resource_group	SELECT	resourceGroupName, subscriptionId	Gets the available namespaces within a resource group.
create_or_update	INSERT	namespaceName, resourceGroupName, subscriptionId	Creates or updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
delete	DELETE	namespaceName, resourceGroupName, subscriptionId	Deletes an existing namespace. This operation also removes all associated resources under the namespace.
update	UPDATE	namespaceName, resourceGroupName, subscriptionId	Updates a service namespace. Once created, this namespace's resource manifest is immutable. This operation is idempotent.
check_name_availability	EXEC	subscriptionId, data__name	Check the give namespace name availability.
regenerate_keys	EXEC	authorizationRuleName, namespaceName, resourceGroupName, subscriptionId, data__keyType	Regenerates the primary or secondary connection strings for the namespace.

SELECT examples

Gets all the available namespaces within the subscription, irrespective of the resource groups.

vw_namespaces

SELECT
alternate_name,
created_at,
disable_local_auth,
encryption,
identity,
location,
metric_id,
minimum_tls_version,
namespaceName,
premium_messaging_partitions,
private_endpoint_connections,
provisioning_state,
public_network_access,
resourceGroupName,
service_bus_endpoint,
sku,
status,
subscriptionId,
system_data,
tags,
updated_at,
zone_redundant
FROM azure.service_bus.vw_namespaces
WHERE subscriptionId = '{{ subscriptionId }}';

namespaces

SELECT
identity,
location,
properties,
sku,
systemData,
tags
FROM azure.service_bus.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.service_bus.namespaces (
namespaceName,
resourceGroupName,
subscriptionId,
sku,
identity,
properties,
location,
tags
)
SELECT 
'{{ namespaceName }}',
'{{ resourceGroupName }}',
'{{ subscriptionId }}',
'{{ sku }}',
'{{ identity }}',
'{{ properties }}',
'{{ location }}',
'{{ tags }}'
;

Manifest

- name: your_resource_model_name
  props:
    - name: sku
      value:
        - name: name
          value: string
        - name: tier
          value: string
        - name: capacity
          value: integer
    - name: identity
      value:
        - name: principalId
          value: string
        - name: tenantId
          value: string
        - name: type
          value: string
        - name: userAssignedIdentities
          value: object
    - 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: minimumTlsVersion
          value: string
        - 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: zoneRedundant
          value: boolean
        - name: encryption
          value:
            - name: keyVaultProperties
              value:
                - - name: keyIdentifier
                    value: string
                  - name: identity
                    value: string
            - name: keySource
              value: string
            - name: requireInfrastructureEncryption
              value: boolean
        - 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: disableLocalAuth
          value: boolean
        - name: alternateName
          value: string
        - name: publicNetworkAccess
          value: string
        - name: premiumMessagingPartitions
          value: integer
    - name: location
      value: string
    - name: tags
      value: object

UPDATE example

Updates a namespaces resource.

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

DELETE example

Deletes the specified namespaces resource.

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