namespaces

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

Overview

Name	namespaces
Type	Resource
Id	azure.event_grid.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	Identity information for the Namespace resource.
inboundIpRules	array	This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.
isZoneRedundant	boolean	This is an optional property and it allows the user to specify if the namespace resource supports zone-redundancy capability or not. If this property is not specified explicitly by the user, its default value depends on the following conditions: a. For Availability Zones enabled regions - The default property value would be true. b. For non-Availability Zones enabled regions - The default property value would be false. Once specified, this property cannot be updated.
location	string	The geo-location where the resource lives. Required.
minimumTlsVersionAllowed	string	Minimum TLS version of the publisher allowed to publish to this namespace. Only TLS version 1.2 is supported. Known values are: "1.0", "1.1", and "1.2". (1.0, 1.1, 1.2)
privateEndpointConnections	array	List of private endpoint connections.
provisioningState	string	Provisioning state of the namespace resource. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed", "Deleted", "DeleteFailed", "CreateFailed", and "UpdatedFailed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed, Deleted, DeleteFailed, CreateFailed, UpdatedFailed)
publicNetworkAccess	string	This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring . Known values are: "Enabled", "Disabled", and "SecuredByPerimeter". (Enabled, Disabled, SecuredByPerimeter)
sku	object	Represents available Sku pricing tiers.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
topicSpacesConfiguration	object	Topic spaces configuration information for the namespace resource.
topicsConfiguration	object	Topics configuration information for the namespace resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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	Identity information for the Namespace resource.
inboundIpRules	array	This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.
isZoneRedundant	boolean	This is an optional property and it allows the user to specify if the namespace resource supports zone-redundancy capability or not. If this property is not specified explicitly by the user, its default value depends on the following conditions: a. For Availability Zones enabled regions - The default property value would be true. b. For non-Availability Zones enabled regions - The default property value would be false. Once specified, this property cannot be updated.
location	string	The geo-location where the resource lives. Required.
minimumTlsVersionAllowed	string	Minimum TLS version of the publisher allowed to publish to this namespace. Only TLS version 1.2 is supported. Known values are: "1.0", "1.1", and "1.2". (1.0, 1.1, 1.2)
privateEndpointConnections	array	List of private endpoint connections.
provisioningState	string	Provisioning state of the namespace resource. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed", "Deleted", "DeleteFailed", "CreateFailed", and "UpdatedFailed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed, Deleted, DeleteFailed, CreateFailed, UpdatedFailed)
publicNetworkAccess	string	This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring . Known values are: "Enabled", "Disabled", and "SecuredByPerimeter". (Enabled, Disabled, SecuredByPerimeter)
sku	object	Represents available Sku pricing tiers.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
topicSpacesConfiguration	object	Topic spaces configuration information for the namespace resource.
topicsConfiguration	object	Topics configuration information for the namespace resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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	Identity information for the Namespace resource.
inboundIpRules	array	This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.
isZoneRedundant	boolean	This is an optional property and it allows the user to specify if the namespace resource supports zone-redundancy capability or not. If this property is not specified explicitly by the user, its default value depends on the following conditions: a. For Availability Zones enabled regions - The default property value would be true. b. For non-Availability Zones enabled regions - The default property value would be false. Once specified, this property cannot be updated.
location	string	The geo-location where the resource lives. Required.
minimumTlsVersionAllowed	string	Minimum TLS version of the publisher allowed to publish to this namespace. Only TLS version 1.2 is supported. Known values are: "1.0", "1.1", and "1.2". (1.0, 1.1, 1.2)
privateEndpointConnections	array	List of private endpoint connections.
provisioningState	string	Provisioning state of the namespace resource. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed", "Deleted", "DeleteFailed", "CreateFailed", and "UpdatedFailed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed, Deleted, DeleteFailed, CreateFailed, UpdatedFailed)
publicNetworkAccess	string	This determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring . Known values are: "Enabled", "Disabled", and "SecuredByPerimeter". (Enabled, Disabled, SecuredByPerimeter)
sku	object	Represents available Sku pricing tiers.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
topicSpacesConfiguration	object	Topic spaces configuration information for the namespace resource.
topicsConfiguration	object	Topics configuration information for the namespace resource.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

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. Get properties of a namespace.
list_by_resource_group	select	resource_group_name, subscription_id	$filter, $top	List namespaces under a resource group. List all the namespaces under a resource group.
list_by_subscription	select	subscription_id	$filter, $top	List namespaces under an Azure subscription. List all the namespaces under an Azure subscription.
create_or_update	insert	resource_group_name, namespace_name, subscription_id, location		Create or update a namespace. Asynchronously creates or updates a new namespace with the specified parameters.
update	update	resource_group_name, namespace_name, subscription_id		Update a namespace. Asynchronously updates a namespace with the specified parameters.
create_or_update	replace	resource_group_name, namespace_name, subscription_id, location		Create or update a namespace. Asynchronously creates or updates a new namespace with the specified parameters.
delete	delete	resource_group_name, namespace_name, subscription_id		Delete a namespace. Delete existing namespace.
list_shared_access_keys	exec	resource_group_name, namespace_name, subscription_id		List keys for a namespace. List the two keys used to publish to a namespace.
regenerate_key	exec	resource_group_name, namespace_name, subscription_id, keyName		Regenerate key for a namespace. Regenerate a shared access key for a namespace.
validate_custom_domain_ownership	exec	resource_group_name, namespace_name, subscription_id		Validate ownership for all custom domains in a namespace. Performs ownership validation via checking TXT records for all custom domains in a 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	Name of the namespace. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
$filter	string	The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'. Default value is None.
$top	integer	The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page. Default value is None.

SELECT examples

get

Get a namespace. Get properties of a namespace.

SELECT
id,
name,
identity,
inboundIpRules,
isZoneRedundant,
location,
minimumTlsVersionAllowed,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
systemData,
tags,
topicSpacesConfiguration,
topicsConfiguration,
type
FROM azure.event_grid.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 namespaces under a resource group. List all the namespaces under a resource group.

SELECT
id,
name,
identity,
inboundIpRules,
isZoneRedundant,
location,
minimumTlsVersionAllowed,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
systemData,
tags,
topicSpacesConfiguration,
topicsConfiguration,
type
FROM azure.event_grid.namespaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

list_by_subscription

List namespaces under an Azure subscription. List all the namespaces under an Azure subscription.

SELECT
id,
name,
identity,
inboundIpRules,
isZoneRedundant,
location,
minimumTlsVersionAllowed,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
sku,
systemData,
tags,
topicSpacesConfiguration,
topicsConfiguration,
type
FROM azure.event_grid.namespaces
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Create or update a namespace. Asynchronously creates or updates a new namespace with the specified parameters.

INSERT INTO azure.event_grid.namespaces (
tags,
location,
properties,
sku,
identity,
resource_group_name,
namespace_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ sku }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ namespace_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
sku,
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: |
      Properties of the Namespace resource.
    value:
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          systemData:
            createdBy: "{{ createdBy }}"
            createdByType: "{{ createdByType }}"
            createdAt: "{{ createdAt }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            lastModifiedByType: "{{ lastModifiedByType }}"
            lastModifiedAt: "{{ lastModifiedAt }}"
          properties:
            privateEndpoint:
              id: "{{ id }}"
            groupIds:
              - "{{ groupIds }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
            provisioningState: "{{ provisioningState }}"
      provisioningState: "{{ provisioningState }}"
      topicsConfiguration:
        hostname: "{{ hostname }}"
        customDomains:
          - fullyQualifiedDomainName: "{{ fullyQualifiedDomainName }}"
            validationState: "{{ validationState }}"
            identity:
              type: "{{ type }}"
              userAssignedIdentity: "{{ userAssignedIdentity }}"
            certificateUrl: "{{ certificateUrl }}"
            expectedTxtRecordName: "{{ expectedTxtRecordName }}"
            expectedTxtRecordValue: "{{ expectedTxtRecordValue }}"
      topicSpacesConfiguration:
        state: "{{ state }}"
        routeTopicResourceId: "{{ routeTopicResourceId }}"
        hostname: "{{ hostname }}"
        routingEnrichments:
          static:
            - key: "{{ key }}"
              valueType: "{{ valueType }}"
          dynamic:
            - key: "{{ key }}"
              value: "{{ value }}"
        clientAuthentication:
          alternativeAuthenticationNameSources:
            - "{{ alternativeAuthenticationNameSources }}"
          customJwtAuthentication:
            tokenIssuer: "{{ tokenIssuer }}"
            issuerCertificates:
              - certificateUrl: "{{ certificateUrl }}"
                identity:
                  type: "{{ type }}"
                  userAssignedIdentity: "{{ userAssignedIdentity }}"
            encodedIssuerCertificates:
              - kid: "{{ kid }}"
                encodedCertificate: "{{ encodedCertificate }}"
          webhookAuthentication:
            identity:
              type: "{{ type }}"
              userAssignedIdentity: "{{ userAssignedIdentity }}"
            endpointUrl: "{{ endpointUrl }}"
            endpointBaseUrl: "{{ endpointBaseUrl }}"
            azureActiveDirectoryApplicationIdOrUri: "{{ azureActiveDirectoryApplicationIdOrUri }}"
            azureActiveDirectoryTenantId: "{{ azureActiveDirectoryTenantId }}"
        maximumSessionExpiryInHours: {{ maximumSessionExpiryInHours }}
        maximumClientSessionsPerAuthenticationName: {{ maximumClientSessionsPerAuthenticationName }}
        routingIdentityInfo:
          type: "{{ type }}"
          userAssignedIdentity: "{{ userAssignedIdentity }}"
        customDomains:
          - fullyQualifiedDomainName: "{{ fullyQualifiedDomainName }}"
            validationState: "{{ validationState }}"
            identity:
              type: "{{ type }}"
              userAssignedIdentity: "{{ userAssignedIdentity }}"
            certificateUrl: "{{ certificateUrl }}"
            expectedTxtRecordName: "{{ expectedTxtRecordName }}"
            expectedTxtRecordValue: "{{ expectedTxtRecordValue }}"
      isZoneRedundant: {{ isZoneRedundant }}
      publicNetworkAccess: "{{ publicNetworkAccess }}"
      inboundIpRules:
        - ipMask: "{{ ipMask }}"
          action: "{{ action }}"
      minimumTlsVersionAllowed: "{{ minimumTlsVersionAllowed }}"
  - name: sku
    description: |
      Represents available Sku pricing tiers.
    value:
      name: "{{ name }}"
      capacity: {{ capacity }}
  - name: identity
    description: |
      Identity information for the Namespace resource.
    value:
      type: "{{ type }}"
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

Update a namespace. Asynchronously updates a namespace with the specified parameters.

UPDATE azure.event_grid.namespaces
SET 
tags = '{{ tags }}',
identity = '{{ identity }}',
sku = '{{ sku }}',
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,
sku,
systemData,
tags,
type;

REPLACE examples

create_or_update

Create or update a namespace. Asynchronously creates or updates a new namespace with the specified parameters.

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

DELETE examples

delete

Delete a namespace. Delete existing namespace.

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

Lifecycle Methods

list_shared_access_keys

List keys for a namespace. List the two keys used to publish to a namespace.

EXEC azure.event_grid.namespaces.list_shared_access_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@namespace_name='{{ namespace_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

regenerate_key

Regenerate key for a namespace. Regenerate a shared access key for a namespace.

EXEC azure.event_grid.namespaces.regenerate_key 
@resource_group_name='{{ resource_group_name }}' --required, 
@namespace_name='{{ namespace_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required 
@@json=
'{
"keyName": "{{ keyName }}"
}'
;

validate_custom_domain_ownership

Validate ownership for all custom domains in a namespace. Performs ownership validation via checking TXT records for all custom domains in a namespace.

EXEC azure.event_grid.namespaces.validate_custom_domain_ownership 
@resource_group_name='{{ resource_group_name }}' --required, 
@namespace_name='{{ namespace_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;