namespace_topics

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

Overview

Name	namespace_topics
Type	Resource
Id	azure.event_grid.namespace_topics

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified identifier of the resource.
name	string	Name of the resource.
properties	object	Properties of the namespace topic.
systemData	object	The system metadata relating to namespace topic resource.
type	string	Type of the resource.

list_by_namespace

Name	Datatype	Description
id	string	Fully qualified identifier of the resource.
name	string	Name of the resource.
properties	object	Properties of the namespace topic.
systemData	object	The system metadata relating to namespace topic resource.
type	string	Type of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, namespaceName, topicName		Get properties of a namespace topic.
list_by_namespace	select	subscriptionId, resourceGroupName, namespaceName	$filter, $top	List all the namespace topics under a namespace.
create_or_update	insert	subscriptionId, resourceGroupName, namespaceName, topicName		Asynchronously creates a new namespace topic with the specified parameters.
update	update	subscriptionId, resourceGroupName, namespaceName, topicName		Asynchronously updates a namespace topic with the specified parameters.
delete	delete	subscriptionId, resourceGroupName, namespaceName, topicName		Delete existing namespace topic.
regenerate_key	exec	subscriptionId, resourceGroupName, namespaceName, topicName, keyName		Regenerate a shared access key for a namespace topic.

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
namespaceName	string	Name of the namespace.
resourceGroupName	string	The name of the resource group within the user's subscription.
subscriptionId	string	Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
topicName	string	Name of the topic.
$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'.
$top	integer (int32)	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.

SELECT examples

get

Get properties of a namespace topic.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.event_grid.namespace_topics
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND namespaceName = '{{ namespaceName }}' -- required
AND topicName = '{{ topicName }}' -- required
;

list_by_namespace

List all the namespace topics under a namespace.

SELECT
id,
name,
properties,
systemData,
type
FROM azure.event_grid.namespace_topics
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND namespaceName = '{{ namespaceName }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Asynchronously creates a new namespace topic with the specified parameters.

INSERT INTO azure.event_grid.namespace_topics (
data__properties,
subscriptionId,
resourceGroupName,
namespaceName,
topicName
)
SELECT 
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ namespaceName }}',
'{{ topicName }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: namespace_topics
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the namespace_topics resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the namespace_topics resource.
    - name: namespaceName
      value: string
      description: Required parameter for the namespace_topics resource.
    - name: topicName
      value: string
      description: Required parameter for the namespace_topics resource.
    - name: properties
      value: object
      description: |
        Properties of the namespace topic.

UPDATE examples

update

Asynchronously updates a namespace topic with the specified parameters.

UPDATE azure.event_grid.namespace_topics
SET 
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND namespaceName = '{{ namespaceName }}' --required
AND topicName = '{{ topicName }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete existing namespace topic.

DELETE FROM azure.event_grid.namespace_topics
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND namespaceName = '{{ namespaceName }}' --required
AND topicName = '{{ topicName }}' --required
;

Lifecycle Methods

regenerate_key

Regenerate a shared access key for a namespace topic.

EXEC azure.event_grid.namespace_topics.regenerate_key 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@namespaceName='{{ namespaceName }}' --required, 
@topicName='{{ topicName }}' --required 
@@json=
'{
"keyName": "{{ keyName }}"
}'
;