partner_namespaces

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

Overview

Name	partner_namespaces
Type	Resource
Id	azure.event_grid.partner_namespaces

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 Namespace.
systemData	object	The system metadata relating to Partner Namespace 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 Namespace.
systemData	object	The system metadata relating to Partner Namespace 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 Namespace.
systemData	object	The system metadata relating to Partner Namespace 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, partnerNamespaceName		Get properties of a partner namespace.
list_by_resource_group	select	subscriptionId, resourceGroupName	$filter, $top	List all the partner namespaces under a resource group.
list_by_subscription	select	subscriptionId	$filter, $top	List all the partner namespaces under an Azure subscription.
create_or_update	insert	subscriptionId, resourceGroupName, partnerNamespaceName		Asynchronously creates a new partner namespace with the specified parameters.
update	update	subscriptionId, resourceGroupName, partnerNamespaceName		Asynchronously updates a partner namespace with the specified parameters.
delete	delete	subscriptionId, resourceGroupName, partnerNamespaceName		Delete existing partner namespace.
regenerate_key	exec	subscriptionId, resourceGroupName, partnerNamespaceName, keyName		Regenerate a shared access key for a partner namespace.

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
partnerNamespaceName	string	Name of the partner namespace.
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 namespace.

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

list_by_resource_group

List all the partner namespaces under a resource group.

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

list_by_subscription

List all the partner namespaces under an Azure subscription.

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

INSERT examples

create_or_update

Asynchronously creates a new partner namespace with the specified parameters.

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

Manifest

# Description fields are for documentation purposes
- name: partner_namespaces
  props:
    - name: subscriptionId
      value: string
      description: Required parameter for the partner_namespaces resource.
    - name: resourceGroupName
      value: string
      description: Required parameter for the partner_namespaces resource.
    - name: partnerNamespaceName
      value: string
      description: Required parameter for the partner_namespaces 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 Namespace.

UPDATE examples

update

Asynchronously updates a partner namespace with the specified parameters.

UPDATE azure.event_grid.partner_namespaces
SET 
data__tags = '{{ tags }}',
data__properties = '{{ properties }}'
WHERE 
subscriptionId = '{{ subscriptionId }}' --required
AND resourceGroupName = '{{ resourceGroupName }}' --required
AND partnerNamespaceName = '{{ partnerNamespaceName }}' --required;

DELETE examples

delete

Delete existing partner namespace.

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

Lifecycle Methods

regenerate_key

Regenerate a shared access key for a partner namespace.

EXEC azure.event_grid.partner_namespaces.regenerate_key 
@subscriptionId='{{ subscriptionId }}' --required, 
@resourceGroupName='{{ resourceGroupName }}' --required, 
@partnerNamespaceName='{{ partnerNamespaceName }}' --required 
@@json=
'{
"keyName": "{{ keyName }}"
}'
;