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
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.
location	string	The geo-location where the resource lives. Required.
partnerRegistrationImmutableId	string	The immutableId of the corresponding partner registration. Note: This property is marked for deprecation and is not supported in any future GA API version.
provisioningState	string	Provisioning state of the partner registration. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed)
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.
location	string	The geo-location where the resource lives. Required.
partnerRegistrationImmutableId	string	The immutableId of the corresponding partner registration. Note: This property is marked for deprecation and is not supported in any future GA API version.
provisioningState	string	Provisioning state of the partner registration. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed)
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.
location	string	The geo-location where the resource lives. Required.
partnerRegistrationImmutableId	string	The immutableId of the corresponding partner registration. Note: This property is marked for deprecation and is not supported in any future GA API version.
provisioningState	string	Provisioning state of the partner registration. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed)
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_registration_name, subscription_id		Get a partner registration. Gets a partner registration with the specified parameters.
list_by_resource_group	select	resource_group_name, subscription_id	$filter, $top	List partner registrations under a resource group. List all the partner registrations under a resource group.
list_by_subscription	select	subscription_id	$filter, $top	List partner registrations under an Azure subscription. List all the partner registrations under an Azure subscription.
create_or_update	insert	resource_group_name, partner_registration_name, subscription_id, location		Create a partner registration. Creates a new partner registration with the specified parameters.
update	update	resource_group_name, partner_registration_name, subscription_id		Update a partner registration. Updates a partner registration with the specified parameters.
create_or_update	replace	resource_group_name, partner_registration_name, subscription_id, location		Create a partner registration. Creates a new partner registration with the specified parameters.
delete	delete	resource_group_name, partner_registration_name, subscription_id		Delete a partner registration. 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
partner_registration_name	string	Name of the partner registration. 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 registration. Gets a partner registration with the specified parameters.

SELECT
id,
name,
location,
partnerRegistrationImmutableId,
provisioningState,
systemData,
tags,
type
FROM azure.event_grid.partner_registrations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND partner_registration_name = '{{ partner_registration_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

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

SELECT
id,
name,
location,
partnerRegistrationImmutableId,
provisioningState,
systemData,
tags,
type
FROM azure.event_grid.partner_registrations
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 registrations under an Azure subscription. List all the partner registrations under an Azure subscription.

SELECT
id,
name,
location,
partnerRegistrationImmutableId,
provisioningState,
systemData,
tags,
type
FROM azure.event_grid.partner_registrations
WHERE subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Create a partner registration. Creates a new partner registration with the specified parameters.

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

Manifest

# Description fields are for documentation purposes
- name: partner_registrations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the partner_registrations resource.
  - name: partner_registration_name
    value: "{{ partner_registration_name }}"
    description: Required parameter for the partner_registrations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the partner_registrations 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 registration.
    value:
      provisioningState: "{{ provisioningState }}"
      partnerRegistrationImmutableId: "{{ partnerRegistrationImmutableId }}"

UPDATE examples

update

Update a partner registration. Updates a partner registration with the specified parameters.

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

REPLACE examples

create_or_update

Create a partner registration. Creates a new partner registration with the specified parameters.

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

DELETE examples

delete

Delete a partner registration. Deletes a partner registration with the specified parameters.

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