partner_configurations

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

Overview

Name	partner_configurations
Type	Resource
Id	azure.event_grid.partner_configurations

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.
location	string	Location of the resource.
properties	object	Properties of the partner configuration.
systemData	object	The system metadata relating to partner configuration resource.
tags	object	Tags of the resource.
type	string	Type of the resource.

list_by_resource_group

Name	Datatype	Description
id	string	Fully qualified identifier of the resource.
name	string	Name of the resource.
location	string	Location of the resource.
properties	object	Properties of the partner configuration.
systemData	object	The system metadata relating to partner configuration resource.
tags	object	Tags of the resource.
type	string	Type of the resource.

list_by_subscription

Name	Datatype	Description
id	string	Fully qualified identifier of the resource.
name	string	Name of the resource.
location	string	Location of the resource.
properties	object	Properties of the partner configuration.
systemData	object	The system metadata relating to partner configuration resource.
tags	object	Tags of the 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		Get properties of a partner configuration.
list_by_resource_group	select	subscriptionId, resourceGroupName		List all the partner configurations under a resource group.
list_by_subscription	select	subscriptionId	$filter, $top	List all the partner configurations under an Azure subscription.
create_or_update	insert	subscriptionId, resourceGroupName		Synchronously creates or updates a partner configuration with the specified parameters.
update	update	subscriptionId, resourceGroupName		Synchronously updates a partner configuration with the specified parameters.
delete	delete	subscriptionId, resourceGroupName		Delete existing partner configuration.
authorize_partner	exec	subscriptionId, resourceGroupName		Authorize a single partner either by partner registration immutable Id or by partner name.
unauthorize_partner	exec	subscriptionId, resourceGroupName		Unauthorize a single partner either by partner registration immutable Id or by partner name.

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
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

Get properties of a partner configuration.

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure.event_grid.partner_configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_resource_group

List all the partner configurations under a resource group.

SELECT
id,
name,
location,
properties,
systemData,
tags,
type
FROM azure.event_grid.partner_configurations
WHERE subscriptionId = '{{ subscriptionId }}' -- required
AND resourceGroupName = '{{ resourceGroupName }}' -- required
;

list_by_subscription

List all the partner configurations under an Azure subscription.

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

INSERT examples

create_or_update

Synchronously creates or updates a partner configuration with the specified parameters.

INSERT INTO azure.event_grid.partner_configurations (
data__properties,
data__location,
data__tags,
subscriptionId,
resourceGroupName
)
SELECT 
'{{ properties }}',
'{{ location }}',
'{{ tags }}',
'{{ subscriptionId }}',
'{{ resourceGroupName }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

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

UPDATE examples

update

Synchronously updates a partner configuration with the specified parameters.

UPDATE azure.event_grid.partner_configurations
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete existing partner configuration.

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

Lifecycle Methods

authorize_partner

Authorize a single partner either by partner registration immutable Id or by partner name.

EXEC azure.event_grid.partner_configurations.authorize_partner 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required 
@@json=
'{
"partnerRegistrationImmutableId": "{{ partnerRegistrationImmutableId }}", 
"partnerName": "{{ partnerName }}", 
"authorizationExpirationTimeInUtc": "{{ authorizationExpirationTimeInUtc }}"
}'
;

unauthorize_partner

Unauthorize a single partner either by partner registration immutable Id or by partner name.

EXEC azure.event_grid.partner_configurations.unauthorize_partner 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required 
@@json=
'{
"partnerRegistrationImmutableId": "{{ partnerRegistrationImmutableId }}", 
"partnerName": "{{ partnerName }}", 
"authorizationExpirationTimeInUtc": "{{ authorizationExpirationTimeInUtc }}"
}'
;