partner_topics

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

Overview

Name	partner_topics
Type	Resource
Id	azure.event_grid.partner_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.
activationState	string	Activation state of the partner topic. Known values are: "NeverActivated", "Activated", and "Deactivated". (NeverActivated, Activated, Deactivated)
eventTypeInfo	object	Event Type information from the corresponding event channel.
expirationTimeIfNotActivatedUtc	string (date-time)	Expiration time of the partner topic. If this timer expires while the partner topic is still never activated, the partner topic and corresponding event channel are deleted.
identity	object	Identity information for the Partner Topic resource.
location	string	The geo-location where the resource lives. Required.
messageForActivation	string	Context or helpful message that can be used during the approval process by the subscriber.
partnerRegistrationImmutableId	string	The immutableId of the corresponding partner registration.
partnerTopicFriendlyDescription	string	Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer.
provisioningState	string	Provisioning state of the partner topic. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed", and "IdleDueToMirroredChannelResourceDeletion". (Creating, Updating, Deleting, Succeeded, Canceled, Failed, IdleDueToMirroredChannelResourceDeletion)
source	string	Source associated with this partner topic. This represents a unique partner resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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.
activationState	string	Activation state of the partner topic. Known values are: "NeverActivated", "Activated", and "Deactivated". (NeverActivated, Activated, Deactivated)
eventTypeInfo	object	Event Type information from the corresponding event channel.
expirationTimeIfNotActivatedUtc	string (date-time)	Expiration time of the partner topic. If this timer expires while the partner topic is still never activated, the partner topic and corresponding event channel are deleted.
identity	object	Identity information for the Partner Topic resource.
location	string	The geo-location where the resource lives. Required.
messageForActivation	string	Context or helpful message that can be used during the approval process by the subscriber.
partnerRegistrationImmutableId	string	The immutableId of the corresponding partner registration.
partnerTopicFriendlyDescription	string	Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer.
provisioningState	string	Provisioning state of the partner topic. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed", and "IdleDueToMirroredChannelResourceDeletion". (Creating, Updating, Deleting, Succeeded, Canceled, Failed, IdleDueToMirroredChannelResourceDeletion)
source	string	Source associated with this partner topic. This represents a unique partner resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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.
activationState	string	Activation state of the partner topic. Known values are: "NeverActivated", "Activated", and "Deactivated". (NeverActivated, Activated, Deactivated)
eventTypeInfo	object	Event Type information from the corresponding event channel.
expirationTimeIfNotActivatedUtc	string (date-time)	Expiration time of the partner topic. If this timer expires while the partner topic is still never activated, the partner topic and corresponding event channel are deleted.
identity	object	Identity information for the Partner Topic resource.
location	string	The geo-location where the resource lives. Required.
messageForActivation	string	Context or helpful message that can be used during the approval process by the subscriber.
partnerRegistrationImmutableId	string	The immutableId of the corresponding partner registration.
partnerTopicFriendlyDescription	string	Friendly description about the topic. This can be set by the publisher/partner to show custom description for the customer partner topic. This will be helpful to remove any ambiguity of the origin of creation of the partner topic for the customer.
provisioningState	string	Provisioning state of the partner topic. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed", and "IdleDueToMirroredChannelResourceDeletion". (Creating, Updating, Deleting, Succeeded, Canceled, Failed, IdleDueToMirroredChannelResourceDeletion)
source	string	Source associated with this partner topic. This represents a unique partner resource.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
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, partner_topic_name, subscription_id		Get a partner topic. Get properties of a partner topic.
list_by_resource_group	select	resource_group_name, subscription_id	$filter, $top	List partner topics under a resource group. List all the partner topics under a resource group.
list_by_subscription	select	subscription_id	$filter, $top	List partner topics under an Azure subscription. List all the partner topics under an Azure subscription.
create_or_update	insert	resource_group_name, partner_topic_name, subscription_id, location		Create a partner topic. Asynchronously creates a new partner topic with the specified parameters.
update	update	resource_group_name, partner_topic_name, subscription_id		Update a partner topic. Asynchronously updates a partner topic with the specified parameters.
create_or_update	replace	resource_group_name, partner_topic_name, subscription_id, location		Create a partner topic. Asynchronously creates a new partner topic with the specified parameters.
delete	delete	resource_group_name, partner_topic_name, subscription_id		Delete a partner topic. Delete existing partner topic.
activate	exec	resource_group_name, partner_topic_name, subscription_id		Activate a partner topic. Activate a newly created partner topic.
deactivate	exec	resource_group_name, partner_topic_name, subscription_id		Deactivate a partner topic. Deactivate specific partner 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
partner_topic_name	string	Name of the partner topic. 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 partner topic. Get properties of a partner topic.

SELECT
id,
name,
activationState,
eventTypeInfo,
expirationTimeIfNotActivatedUtc,
identity,
location,
messageForActivation,
partnerRegistrationImmutableId,
partnerTopicFriendlyDescription,
provisioningState,
source,
systemData,
tags,
type
FROM azure.event_grid.partner_topics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND partner_topic_name = '{{ partner_topic_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List partner topics under a resource group. List all the partner topics under a resource group.

SELECT
id,
name,
activationState,
eventTypeInfo,
expirationTimeIfNotActivatedUtc,
identity,
location,
messageForActivation,
partnerRegistrationImmutableId,
partnerTopicFriendlyDescription,
provisioningState,
source,
systemData,
tags,
type
FROM azure.event_grid.partner_topics
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

list_by_subscription

List partner topics under an Azure subscription. List all the partner topics under an Azure subscription.

SELECT
id,
name,
activationState,
eventTypeInfo,
expirationTimeIfNotActivatedUtc,
identity,
location,
messageForActivation,
partnerRegistrationImmutableId,
partnerTopicFriendlyDescription,
provisioningState,
source,
systemData,
tags,
type
FROM azure.event_grid.partner_topics
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

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

INSERT INTO azure.event_grid.partner_topics (
tags,
location,
properties,
identity,
resource_group_name,
partner_topic_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ identity }}',
'{{ resource_group_name }}',
'{{ partner_topic_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: partner_topics
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the partner_topics resource.
  - name: partner_topic_name
    value: "{{ partner_topic_name }}"
    description: Required parameter for the partner_topics resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the partner_topics 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 Partner Topic.
    value:
      partnerRegistrationImmutableId: "{{ partnerRegistrationImmutableId }}"
      source: "{{ source }}"
      eventTypeInfo:
        kind: "{{ kind }}"
        inlineEventTypes: "{{ inlineEventTypes }}"
      expirationTimeIfNotActivatedUtc: "{{ expirationTimeIfNotActivatedUtc }}"
      provisioningState: "{{ provisioningState }}"
      activationState: "{{ activationState }}"
      partnerTopicFriendlyDescription: "{{ partnerTopicFriendlyDescription }}"
      messageForActivation: "{{ messageForActivation }}"
  - name: identity
    description: |
      Identity information for the Partner Topic resource.
    value:
      type: "{{ type }}"
      principalId: "{{ principalId }}"
      tenantId: "{{ tenantId }}"
      userAssignedIdentities: "{{ userAssignedIdentities }}"

UPDATE examples

update

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

UPDATE azure.event_grid.partner_topics
SET 
tags = '{{ tags }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND partner_topic_name = '{{ partner_topic_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

REPLACE examples

create_or_update

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

REPLACE azure.event_grid.partner_topics
SET 
tags = '{{ tags }}',
location = '{{ location }}',
properties = '{{ properties }}',
identity = '{{ identity }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND partner_topic_name = '{{ partner_topic_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND location = '{{ location }}' --required
RETURNING
id,
name,
identity,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a partner topic. Delete existing partner topic.

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

Lifecycle Methods

activate

Activate a partner topic. Activate a newly created partner topic.

EXEC azure.event_grid.partner_topics.activate 
@resource_group_name='{{ resource_group_name }}' --required, 
@partner_topic_name='{{ partner_topic_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

deactivate

Deactivate a partner topic. Deactivate specific partner topic.

EXEC azure.event_grid.partner_topics.deactivate 
@resource_group_name='{{ resource_group_name }}' --required, 
@partner_topic_name='{{ partner_topic_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;