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 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.
partnerAuthorization	object	The details of authorized partners.
provisioningState	string	Provisioning state of the partner configuration. 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.
partnerAuthorization	object	The details of authorized partners.
provisioningState	string	Provisioning state of the partner configuration. 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, subscription_id		Get a partner configuration. Get properties of a partner configuration.
list_by_subscription	select	subscription_id	$filter, $top	List partner configurations under an Azure subscription. List all the partner configurations under an Azure subscription.
create_or_update	insert	resource_group_name, subscription_id		Create or update a partner configuration. Synchronously creates or updates a partner configuration with the specified parameters.
update	update	resource_group_name, subscription_id		Update a partner configuration. Synchronously updates a partner configuration with the specified parameters.
create_or_update	replace	resource_group_name, subscription_id		Create or update a partner configuration. Synchronously creates or updates a partner configuration with the specified parameters.
delete	delete	resource_group_name, subscription_id		Delete a partner configuration. Delete existing partner configuration.
list_by_resource_group	exec	resource_group_name, subscription_id		List partner configurations under a resource group. List all the partner configurations under a resource group.
authorize_partner	exec	resource_group_name, subscription_id		Authorize a partner. Authorize a single partner either by partner registration immutable Id or by partner name.
unauthorize_partner	exec	resource_group_name, subscription_id		Unauthorize a partner. 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
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 configuration. Get properties of a partner configuration.

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

list_by_subscription

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

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

INSERT examples

create_or_update

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

INSERT INTO azure.event_grid.partner_configurations (
properties,
tags,
location,
resource_group_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ tags }}',
'{{ location }}',
'{{ resource_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: partner_configurations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the partner_configurations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the partner_configurations resource.
  - name: properties
    description: |
      Properties of the partner configuration.
    value:
      partnerAuthorization:
        defaultMaximumExpirationTimeInDays: {{ defaultMaximumExpirationTimeInDays }}
        authorizedPartnersList:
          - partnerRegistrationImmutableId: "{{ partnerRegistrationImmutableId }}"
            partnerName: "{{ partnerName }}"
            authorizationExpirationTimeInUtc: "{{ authorizationExpirationTimeInUtc }}"
      provisioningState: "{{ provisioningState }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives.

UPDATE examples

update

Update a partner configuration. Synchronously updates a partner configuration with the specified parameters.

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

REPLACE examples

create_or_update

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

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

DELETE examples

delete

Delete a partner configuration. Delete existing partner configuration.

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

Lifecycle Methods

list_by_resource_group

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

EXEC azure.event_grid.partner_configurations.list_by_resource_group 
@resource_group_name='{{ resource_group_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;

authorize_partner

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

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

unauthorize_partner

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

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