application_group

Creates, updates, deletes, gets or lists an application_group resource.

Overview

Name	application_group
Type	Resource
Id	azure.event_hub.application_group

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.
clientAppGroupIdentifier	string	The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid).
isEnabled	boolean	Determines if Application Group is allowed to create connection with namespace or not. Once the isEnabled is set to false, all the existing connections of application group gets dropped and no new connections will be allowed.
location	string	The geo-location where the resource lives.
policies	array	List of group policies that define the behavior of application group. The policies can support resource governance scenarios such as limiting ingress or egress traffic.
systemData	object	The system meta data relating to this resource.
type	string	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs".

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.
clientAppGroupIdentifier	string	The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid).
isEnabled	boolean	Determines if Application Group is allowed to create connection with namespace or not. Once the isEnabled is set to false, all the existing connections of application group gets dropped and no new connections will be allowed.
location	string	The geo-location where the resource lives.
policies	array	List of group policies that define the behavior of application group. The policies can support resource governance scenarios such as limiting ingress or egress traffic.
systemData	object	The system meta data relating to this resource.
type	string	The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs".

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, namespace_name, application_group_name, subscription_id		Gets an ApplicationGroup for a Namespace.
list_by_namespace	select	resource_group_name, namespace_name, subscription_id		Gets a list of application groups for a Namespace.
create_or_update_application_group	insert	resource_group_name, namespace_name, application_group_name, subscription_id		Creates or updates an ApplicationGroup for a Namespace.
create_or_update_application_group	replace	resource_group_name, namespace_name, application_group_name, subscription_id		Creates or updates an ApplicationGroup for a Namespace.
delete	delete	resource_group_name, namespace_name, application_group_name, subscription_id		Deletes an ApplicationGroup for a 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
application_group_name	string	The Application Group name. Required.
namespace_name	string	The Namespace name. Required.
resource_group_name	string	Name of the resource group within the azure subscription. Required.
subscription_id	string

SELECT examples

get

Gets an ApplicationGroup for a Namespace.

SELECT
id,
name,
clientAppGroupIdentifier,
isEnabled,
location,
policies,
systemData,
type
FROM azure.event_hub.application_group
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND application_group_name = '{{ application_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_namespace

Gets a list of application groups for a Namespace.

SELECT
id,
name,
clientAppGroupIdentifier,
isEnabled,
location,
policies,
systemData,
type
FROM azure.event_hub.application_group
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND namespace_name = '{{ namespace_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create_or_update_application_group

Creates or updates an ApplicationGroup for a Namespace.

INSERT INTO azure.event_hub.application_group (
properties,
resource_group_name,
namespace_name,
application_group_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ namespace_name }}',
'{{ application_group_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: application_group
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the application_group resource.
  - name: namespace_name
    value: "{{ namespace_name }}"
    description: Required parameter for the application_group resource.
  - name: application_group_name
    value: "{{ application_group_name }}"
    description: Required parameter for the application_group resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the application_group resource.
  - name: properties
    value:
      isEnabled: {{ isEnabled }}
      clientAppGroupIdentifier: "{{ clientAppGroupIdentifier }}"
      policies:
        - name: "{{ name }}"
          type: "{{ type }}"

REPLACE examples

create_or_update_application_group

Creates or updates an ApplicationGroup for a Namespace.

REPLACE azure.event_hub.application_group
SET 
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_name }}' --required
AND application_group_name = '{{ application_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
type;

DELETE examples

delete

Deletes an ApplicationGroup for a Namespace.

DELETE FROM azure.event_hub.application_group
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND namespace_name = '{{ namespace_name }}' --required
AND application_group_name = '{{ application_group_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;