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 resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
name	string	The name of the resource.
eventRetentionInDays	integer	Event retention for the namespace topic expressed in days. The property default value is 1 day. Min event retention duration value is 1 day and max event retention duration value is 1 day.
inputSchema	string	This determines the format that is expected for incoming events published to the topic. "CloudEventSchemaV1_0" (CloudEventSchemaV1_0)
provisioningState	string	Provisioning state of the namespace topic. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed", "Deleted", "DeleteFailed", "CreateFailed", and "UpdatedFailed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed, Deleted, DeleteFailed, CreateFailed, UpdatedFailed)
publisherType	string	Publisher type of the namespace topic. "Custom" (Custom)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_namespace

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.
eventRetentionInDays	integer	Event retention for the namespace topic expressed in days. The property default value is 1 day. Min event retention duration value is 1 day and max event retention duration value is 1 day.
inputSchema	string	This determines the format that is expected for incoming events published to the topic. "CloudEventSchemaV1_0" (CloudEventSchemaV1_0)
provisioningState	string	Provisioning state of the namespace topic. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed", "Deleted", "DeleteFailed", "CreateFailed", and "UpdatedFailed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed, Deleted, DeleteFailed, CreateFailed, UpdatedFailed)
publisherType	string	Publisher type of the namespace topic. "Custom" (Custom)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
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, topic_name, subscription_id		Get a namespace topic. Get properties of a namespace topic.
list_by_namespace	select	resource_group_name, namespace_name, subscription_id	$filter, $top	List namespace topics under a namespace. List all the namespace topics under a namespace.
create_or_update	insert	resource_group_name, namespace_name, topic_name, subscription_id		Create a namespace topic. Asynchronously creates a new namespace topic with the specified parameters.
update	update	resource_group_name, namespace_name, topic_name, subscription_id		Update a namespace topic. Asynchronously updates a namespace topic with the specified parameters.
create_or_update	replace	resource_group_name, namespace_name, topic_name, subscription_id		Create a namespace topic. Asynchronously creates a new namespace topic with the specified parameters.
delete	delete	resource_group_name, namespace_name, topic_name, subscription_id		Delete a namespace topic. Delete existing namespace topic.
list_shared_access_keys	exec	resource_group_name, namespace_name, topic_name, subscription_id		List keys for a namespace topic. List the two keys used to publish to a namespace topic.
regenerate_key	exec	resource_group_name, namespace_name, topic_name, subscription_id, keyName		Regenerate key for a namespace topic. 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
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
topic_name	string	Name of the namespace topic. Required.
$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 topic. Get properties of a namespace topic.

SELECT
id,
name,
eventRetentionInDays,
inputSchema,
provisioningState,
publisherType,
systemData,
type
FROM azure.event_grid.namespace_topics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND topic_name = '{{ topic_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_namespace

List namespace topics under a namespace. List all the namespace topics under a namespace.

SELECT
id,
name,
eventRetentionInDays,
inputSchema,
provisioningState,
publisherType,
systemData,
type
FROM azure.event_grid.namespace_topics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Create a namespace topic. Asynchronously creates a new namespace topic with the specified parameters.

INSERT INTO azure.event_grid.namespace_topics (
properties,
resource_group_name,
namespace_name,
topic_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ namespace_name }}',
'{{ topic_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: namespace_topics
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the namespace_topics resource.
  - name: namespace_name
    value: "{{ namespace_name }}"
    description: Required parameter for the namespace_topics resource.
  - name: topic_name
    value: "{{ topic_name }}"
    description: Required parameter for the namespace_topics resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the namespace_topics resource.
  - name: properties
    description: |
      Properties of the namespace topic.
    value:
      provisioningState: "{{ provisioningState }}"
      publisherType: "{{ publisherType }}"
      inputSchema: "{{ inputSchema }}"
      eventRetentionInDays: {{ eventRetentionInDays }}

UPDATE examples

update

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

UPDATE azure.event_grid.namespace_topics
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_name }}' --required
AND topic_name = '{{ topic_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

REPLACE examples

create_or_update

Create a namespace topic. Asynchronously creates a new namespace topic with the specified parameters.

REPLACE azure.event_grid.namespace_topics
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_name }}' --required
AND topic_name = '{{ topic_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a namespace topic. Delete existing namespace topic.

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

Lifecycle Methods

list_shared_access_keys

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

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

regenerate_key

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

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