Skip to main content

partner_namespaces

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

Overview​

Namepartner_namespaces
TypeResource
Idazure.event_grid.partner_namespaces

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringFully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}.
namestringThe name of the resource.
disableLocalAuthbooleanThis boolean is used to enable or disable local auth. Default value is false. When the property is set to true, only Microsoft Entra ID token will be used to authenticate if user is allowed to publish to the partner namespace.
endpointstringEndpoint for the partner namespace.
inboundIpRulesarrayThis can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.
locationstringThe geo-location where the resource lives. Required.
minimumTlsVersionAllowedstringMinimum TLS version of the publisher allowed to publish to this partner namespace. Known values are: "1.0", "1.1", and "1.2". (1.0, 1.1, 1.2)
partnerRegistrationFullyQualifiedIdstringThe fully qualified ARM Id of the partner registration that should be associated with this partner namespace. This takes the following format: /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/partnerRegistrations/{partnerRegistrationName}.
partnerTopicRoutingModestringThis determines if events published to this partner namespace should use the source attribute in the event payload or use the channel name in the header when matching to the partner topic. If none is specified, source attribute routing will be used to match the partner topic. Known values are: "SourceEventAttribute" and "ChannelNameHeader". (SourceEventAttribute, ChannelNameHeader)
privateEndpointConnectionsarrayList of private endpoint connections.
provisioningStatestringProvisioning state of the partner namespace. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", and "Failed". (Creating, Updating, Deleting, Succeeded, Canceled, Failed)
publicNetworkAccessstringThis determines if traffic is allowed over public network. By default it is enabled. You can further restrict to specific IPs by configuring . Known values are: "Enabled", "Disabled", and "SecuredByPerimeter". (Enabled, Disabled, SecuredByPerimeter)
systemDataobjectAzure Resource Manager metadata containing createdBy and modifiedBy information.
tagsobjectResource tags.
typestringThe type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectresource_group_name, partner_namespace_name, subscription_idGet a partner namespace. Get properties of a partner namespace.
list_by_resource_groupselectresource_group_name, subscription_id$filter, $topList partner namespaces under a resource group. List all the partner namespaces under a resource group.
list_by_subscriptionselectsubscription_id$filter, $topList partner namespaces under an Azure subscription. List all the partner namespaces under an Azure subscription.
create_or_updateinsertresource_group_name, partner_namespace_name, subscription_id, locationCreate a partner namespace. Asynchronously creates a new partner namespace with the specified parameters.
updateupdateresource_group_name, partner_namespace_name, subscription_idUpdate a partner namespace. Asynchronously updates a partner namespace with the specified parameters.
create_or_updatereplaceresource_group_name, partner_namespace_name, subscription_id, locationCreate a partner namespace. Asynchronously creates a new partner namespace with the specified parameters.
deletedeleteresource_group_name, partner_namespace_name, subscription_idDelete a partner namespace. Delete existing partner namespace.
list_shared_access_keysexecresource_group_name, partner_namespace_name, subscription_idList keys for a partner namespace. List the two keys used to publish to a partner namespace.
regenerate_keyexecresource_group_name, partner_namespace_name, subscription_id, keyNameRegenerate key for a partner namespace. 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.

NameDatatypeDescription
partner_namespace_namestringName of the partner namespace. Required.
resource_group_namestringThe name of the resource group. The name is case insensitive. Required.
subscription_idstring
$filterstringThe 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.
$topintegerThe 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 a partner namespace. Get properties of a partner namespace.

SELECT
id,
name,
disableLocalAuth,
endpoint,
inboundIpRules,
location,
minimumTlsVersionAllowed,
partnerRegistrationFullyQualifiedId,
partnerTopicRoutingMode,
privateEndpointConnections,
provisioningState,
publicNetworkAccess,
systemData,
tags,
type
FROM azure.event_grid.partner_namespaces
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND partner_namespace_name = '{{ partner_namespace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples​

Create a partner namespace. Asynchronously creates a new partner namespace with the specified parameters.

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

UPDATE examples​

Update a partner namespace. Asynchronously updates a partner namespace with the specified parameters.

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

REPLACE examples​

Create a partner namespace. Asynchronously creates a new partner namespace with the specified parameters.

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

DELETE examples​

Delete a partner namespace. Delete existing partner namespace.

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

Lifecycle Methods​

List keys for a partner namespace. List the two keys used to publish to a partner namespace.

EXEC azure.event_grid.partner_namespaces.list_shared_access_keys 
@resource_group_name='{{ resource_group_name }}' --required, 
@partner_namespace_name='{{ partner_namespace_name }}' --required, 
@subscription_id='{{ subscription_id }}' --required
;