Microsoft.EventHub namespaces/applicationGroups 2024-01-01
Bicep resource definition
The namespaces/applicationGroups resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.EventHub/namespaces/applicationGroups resource, add the following Bicep to your template.
resource symbolicname 'Microsoft.EventHub/namespaces/applicationGroups@2024-01-01' = {
name: 'string'
parent: resourceSymbolicName
properties: {
clientAppGroupIdentifier: 'string'
isEnabled: bool
policies: [
{
name: 'string'
type: 'string'
// For remaining properties, see ApplicationGroupPolicy objects
}
]
}
}
ApplicationGroupPolicy objects
Set the type property to specify the type of object.
For ThrottlingPolicy, use:
type: 'ThrottlingPolicy'
metricId: 'string'
rateLimitThreshold: int
Property values
namespaces/applicationGroups
| Name | Description | Value |
|---|---|---|
| name | The resource name See how to set names and types for child resources in Bicep. |
string (required) |
| parent | In Bicep, you can specify the parent resource for a child resource. You only need to add this property when the child resource is declared outside of the parent resource. For more information, see Child resource outside parent resource. |
Symbolic name for resource of type: namespaces |
| properties | ApplicationGroupProperties |
ApplicationGroupProperties
| Name | Description | Value |
|---|---|---|
| clientAppGroupIdentifier | The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid) | string (required) |
| isEnabled | 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 | bool |
| policies | 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. | ApplicationGroupPolicy[] |
ApplicationGroupPolicy
| Name | Description | Value |
|---|---|---|
| name | The Name of this policy | string (required) |
| type | Set the object type | ThrottlingPolicy (required) |
ThrottlingPolicy
| Name | Description | Value |
|---|---|---|
| type | Application Group Policy types | 'ThrottlingPolicy' (required) |
| metricId | Metric Id on which the throttle limit should be set, MetricId can be discovered by hovering over Metric in the Metrics section of Event Hub Namespace inside Azure Portal | 'IncomingBytes' 'IncomingMessages' 'OutgoingBytes' 'OutgoingMessages' (required) |
| rateLimitThreshold | The Threshold limit above which the application group will be throttled.Rate limit is always per second. | int (required) |
ARM template resource definition
The namespaces/applicationGroups resource type can be deployed with operations that target:
- Resource groups - See resource group deployment commands
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.EventHub/namespaces/applicationGroups resource, add the following JSON to your template.
{
"type": "Microsoft.EventHub/namespaces/applicationGroups",
"apiVersion": "2024-01-01",
"name": "string",
"properties": {
"clientAppGroupIdentifier": "string",
"isEnabled": "bool",
"policies": [
{
"name": "string",
"type": "string"
// For remaining properties, see ApplicationGroupPolicy objects
}
]
}
}
ApplicationGroupPolicy objects
Set the type property to specify the type of object.
For ThrottlingPolicy, use:
"type": "ThrottlingPolicy",
"metricId": "string",
"rateLimitThreshold": "int"
Property values
namespaces/applicationGroups
| Name | Description | Value |
|---|---|---|
| type | The resource type | 'Microsoft.EventHub/namespaces/applicationGroups' |
| apiVersion | The resource api version | '2024-01-01' |
| name | The resource name See how to set names and types for child resources in JSON ARM templates. |
string (required) |
| properties | ApplicationGroupProperties |
ApplicationGroupProperties
| Name | Description | Value |
|---|---|---|
| clientAppGroupIdentifier | The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid) | string (required) |
| isEnabled | 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 | bool |
| policies | 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. | ApplicationGroupPolicy[] |
ApplicationGroupPolicy
| Name | Description | Value |
|---|---|---|
| name | The Name of this policy | string (required) |
| type | Set the object type | ThrottlingPolicy (required) |
ThrottlingPolicy
| Name | Description | Value |
|---|---|---|
| type | Application Group Policy types | 'ThrottlingPolicy' (required) |
| metricId | Metric Id on which the throttle limit should be set, MetricId can be discovered by hovering over Metric in the Metrics section of Event Hub Namespace inside Azure Portal | 'IncomingBytes' 'IncomingMessages' 'OutgoingBytes' 'OutgoingMessages' (required) |
| rateLimitThreshold | The Threshold limit above which the application group will be throttled.Rate limit is always per second. | int (required) |
Terraform (AzAPI provider) resource definition
The namespaces/applicationGroups resource type can be deployed with operations that target:
- Resource groups
For a list of changed properties in each API version, see change log.
Resource format
To create a Microsoft.EventHub/namespaces/applicationGroups resource, add the following Terraform to your template.
resource "azapi_resource" "symbolicname" {
type = "Microsoft.EventHub/namespaces/applicationGroups@2024-01-01"
name = "string"
parent_id = "string"
body = jsonencode({
properties = {
clientAppGroupIdentifier = "string"
isEnabled = bool
policies = [
{
name = "string"
type = "string"
// For remaining properties, see ApplicationGroupPolicy objects
}
]
}
})
}
ApplicationGroupPolicy objects
Set the type property to specify the type of object.
For ThrottlingPolicy, use:
type = "ThrottlingPolicy"
metricId = "string"
rateLimitThreshold = int
Property values
namespaces/applicationGroups
| Name | Description | Value |
|---|---|---|
| type | The resource type | "Microsoft.EventHub/namespaces/applicationGroups@2024-01-01" |
| name | The resource name | string (required) |
| parent_id | The ID of the resource that is the parent for this resource. | ID for resource of type: namespaces |
| properties | ApplicationGroupProperties |
ApplicationGroupProperties
| Name | Description | Value |
|---|---|---|
| clientAppGroupIdentifier | The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid) | string (required) |
| isEnabled | 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 | bool |
| policies | 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. | ApplicationGroupPolicy[] |
ApplicationGroupPolicy
| Name | Description | Value |
|---|---|---|
| name | The Name of this policy | string (required) |
| type | Set the object type | ThrottlingPolicy (required) |
ThrottlingPolicy
| Name | Description | Value |
|---|---|---|
| type | Application Group Policy types | "ThrottlingPolicy" (required) |
| metricId | Metric Id on which the throttle limit should be set, MetricId can be discovered by hovering over Metric in the Metrics section of Event Hub Namespace inside Azure Portal | "IncomingBytes" "IncomingMessages" "OutgoingBytes" "OutgoingMessages" (required) |
| rateLimitThreshold | The Threshold limit above which the application group will be throttled.Rate limit is always per second. | int (required) |