partner_registrations

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

Overview

Name	partner_registrations
Type	Resource
Id	azure.event_grid.partner_registrations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
location	string	Location of the resource.
properties	object	Properties of the partner registration.
systemData	object	The system metadata relating to Partner Registration resource.
tags	object	Tags of the resource.

list_by_resource_group

Name	Datatype	Description
location	string	Location of the resource.
properties	object	Properties of the partner registration.
systemData	object	The system metadata relating to Partner Registration resource.
tags	object	Tags of the resource.

list_by_subscription

Name	Datatype	Description
location	string	Location of the resource.
properties	object	Properties of the partner registration.
systemData	object	The system metadata relating to Partner Registration resource.
tags	object	Tags of the resource.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	subscriptionId, resourceGroupName, partnerRegistrationName		Gets a partner registration with the specified parameters.
list_by_resource_group	select	subscriptionId, resourceGroupName	$filter, $top	List all the partner registrations under a resource group.
list_by_subscription	select	subscriptionId	$filter, $top	List all the partner registrations under an Azure subscription.
create_or_update	insert	subscriptionId, resourceGroupName, partnerRegistrationName		Creates a new partner registration with the specified parameters.
update	update	subscriptionId, resourceGroupName, partnerRegistrationName		Updates a partner registration with the specified parameters.
delete	delete	subscriptionId, resourceGroupName, partnerRegistrationName		Deletes a partner registration with the specified parameters.

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
partnerRegistrationName	string	Name of the partner registration.
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.
$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

Gets a partner registration with the specified parameters.

SELECT
location,
properties,
systemData,
tags
FROM azure.event_grid.partner_registrations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND partnerRegistrationName = '{{ partnerRegistrationName }}' -- required
;

list_by_resource_group

List all the partner registrations under a resource group.

SELECT
location,
properties,
systemData,
tags
FROM azure.event_grid.partner_registrations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

list_by_subscription

List all the partner registrations under an Azure subscription.

SELECT
location,
properties,
systemData,
tags
FROM azure.event_grid.partner_registrations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Creates a new partner registration with the specified parameters.

INSERT INTO azure.event_grid.partner_registrations (
data__location,
data__tags,
data__properties,
subscriptionId,
resourceGroupName,
partnerRegistrationName
)
SELECT 
'{{ location }}',
'{{ tags }}',
'{{ properties }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}',
'{{ partnerRegistrationName }}'
RETURNING
location,
properties,
systemData,
tags
;

Manifest

# Description fields are for documentation purposes
- name: partner_registrations
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the partner_registrations resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the partner_registrations resource.
    - name: partnerRegistrationName
      value: string
      description: Required parameter for the partner_registrations resource.
    - name: location
      value: string
      description: |
        Location of the resource.
    - name: tags
      value: object
      description: |
        Tags of the resource.
    - name: properties
      value: object
      description: |
        Properties of the partner registration.

UPDATE examples

update

Updates a partner registration with the specified parameters.

UPDATE azure.event_grid.partner_registrations
SET 
data__tags = '{{ tags }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND partnerRegistrationName = '{{ partnerRegistrationName }}' --required;

DELETE examples

delete

Deletes a partner registration with the specified parameters.

DELETE FROM azure.event_grid.partner_registrations
WHERE subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND partnerRegistrationName = '{{ partnerRegistrationName }}' --required
;