permission_bindings

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

Overview

Name	permission_bindings
Type	Resource
Id	azure.event_grid.permission_bindings

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.
clientGroupName	string	The name of the client group resource that the permission is bound to. The client group needs to be a resource under the same namespace the permission binding is a part of.
description	string	Description for the Permission Binding resource.
permission	string	The allowed permission. Known values are: "Publisher" and "Subscriber". (Publisher, Subscriber)
provisioningState	string	Provisioning state of the PermissionBinding resource. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed", and "Deleted". (Creating, Updating, Deleting, Succeeded, Canceled, Failed, Deleted)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
topicSpaceName	string	The name of the Topic Space resource that the permission is bound to. The Topic space needs to be a resource under the same namespace the permission binding is a part of.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".

list_by_namespace

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.
clientGroupName	string	The name of the client group resource that the permission is bound to. The client group needs to be a resource under the same namespace the permission binding is a part of.
description	string	Description for the Permission Binding resource.
permission	string	The allowed permission. Known values are: "Publisher" and "Subscriber". (Publisher, Subscriber)
provisioningState	string	Provisioning state of the PermissionBinding resource. Known values are: "Creating", "Updating", "Deleting", "Succeeded", "Canceled", "Failed", and "Deleted". (Creating, Updating, Deleting, Succeeded, Canceled, Failed, Deleted)
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
topicSpaceName	string	The name of the Topic Space resource that the permission is bound to. The Topic space needs to be a resource under the same namespace the permission binding is a part of.
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, namespace_name, permission_binding_name, subscription_id		Get a permission binding. Get properties of a permission binding.
list_by_namespace	select	resource_group_name, namespace_name, subscription_id	$filter, $top	List all permission bindings under a namespace. Get all the permission bindings under a namespace.
create_or_update	insert	resource_group_name, namespace_name, permission_binding_name, subscription_id		Create or update a permission binding. Create or update a permission binding with the specified parameters.
create_or_update	replace	resource_group_name, namespace_name, permission_binding_name, subscription_id		Create or update a permission binding. Create or update a permission binding with the specified parameters.
delete	delete	resource_group_name, namespace_name, permission_binding_name, subscription_id		Delete a permission binding. Delete an existing permission binding.

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
namespace_name	string	Name of the namespace. Required.
permission_binding_name	string	Name of the permission binding. 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 permission binding. Get properties of a permission binding.

SELECT
id,
name,
clientGroupName,
description,
permission,
provisioningState,
systemData,
topicSpaceName,
type
FROM azure.event_grid.permission_bindings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND permission_binding_name = '{{ permission_binding_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_namespace

List all permission bindings under a namespace. Get all the permission bindings under a namespace.

SELECT
id,
name,
clientGroupName,
description,
permission,
provisioningState,
systemData,
topicSpaceName,
type
FROM azure.event_grid.permission_bindings
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
AND $filter = '{{ $filter }}'
AND $top = '{{ $top }}'
;

INSERT examples

create_or_update

Create or update a permission binding. Create or update a permission binding with the specified parameters.

INSERT INTO azure.event_grid.permission_bindings (
properties,
resource_group_name,
namespace_name,
permission_binding_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ namespace_name }}',
'{{ permission_binding_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: permission_bindings
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the permission_bindings resource.
  - name: namespace_name
    value: "{{ namespace_name }}"
    description: Required parameter for the permission_bindings resource.
  - name: permission_binding_name
    value: "{{ permission_binding_name }}"
    description: Required parameter for the permission_bindings resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the permission_bindings resource.
  - name: properties
    description: |
      The properties of permission binding.
    value:
      description: "{{ description }}"
      topicSpaceName: "{{ topicSpaceName }}"
      permission: "{{ permission }}"
      clientGroupName: "{{ clientGroupName }}"
      provisioningState: "{{ provisioningState }}"

REPLACE examples

create_or_update

Create or update a permission binding. Create or update a permission binding with the specified parameters.

REPLACE azure.event_grid.permission_bindings
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_name }}' --required
AND permission_binding_name = '{{ permission_binding_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
properties,
systemData,
type;

DELETE examples

delete

Delete a permission binding. Delete an existing permission binding.

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