Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. eventhub
  5. getApplicationGroup
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.eventhub.getApplicationGroup

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Gets an ApplicationGroup for a Namespace. Azure REST API version: 2022-10-01-preview.

Other available API versions: 2023-01-01-preview, 2024-01-01, 2024-05-01-preview.

Using getApplicationGroup

Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

function getApplicationGroup(args: GetApplicationGroupArgs, opts?: InvokeOptions): Promise<GetApplicationGroupResult>
function getApplicationGroupOutput(args: GetApplicationGroupOutputArgs, opts?: InvokeOptions): Output<GetApplicationGroupResult>
Copy
def get_application_group(application_group_name: Optional[str] = None,
                          namespace_name: Optional[str] = None,
                          resource_group_name: Optional[str] = None,
                          opts: Optional[InvokeOptions] = None) -> GetApplicationGroupResult
def get_application_group_output(application_group_name: Optional[pulumi.Input[str]] = None,
                          namespace_name: Optional[pulumi.Input[str]] = None,
                          resource_group_name: Optional[pulumi.Input[str]] = None,
                          opts: Optional[InvokeOptions] = None) -> Output[GetApplicationGroupResult]
Copy
func LookupApplicationGroup(ctx *Context, args *LookupApplicationGroupArgs, opts ...InvokeOption) (*LookupApplicationGroupResult, error)
func LookupApplicationGroupOutput(ctx *Context, args *LookupApplicationGroupOutputArgs, opts ...InvokeOption) LookupApplicationGroupResultOutput
Copy

> Note: This function is named LookupApplicationGroup in the Go SDK.

public static class GetApplicationGroup 
{
    public static Task<GetApplicationGroupResult> InvokeAsync(GetApplicationGroupArgs args, InvokeOptions? opts = null)
    public static Output<GetApplicationGroupResult> Invoke(GetApplicationGroupInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetApplicationGroupResult> getApplicationGroup(GetApplicationGroupArgs args, InvokeOptions options)
public static Output<GetApplicationGroupResult> getApplicationGroup(GetApplicationGroupArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:eventhub:getApplicationGroup
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

ApplicationGroupName
This property is required.
Changes to this property will trigger replacement.
string
The Application Group name
NamespaceName
This property is required.
Changes to this property will trigger replacement.
string
The Namespace name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group within the azure subscription.
ApplicationGroupName
This property is required.
Changes to this property will trigger replacement.
string
The Application Group name
NamespaceName
This property is required.
Changes to this property will trigger replacement.
string
The Namespace name
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group within the azure subscription.
applicationGroupName
This property is required.
Changes to this property will trigger replacement.
String
The Application Group name
namespaceName
This property is required.
Changes to this property will trigger replacement.
String
The Namespace name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group within the azure subscription.
applicationGroupName
This property is required.
Changes to this property will trigger replacement.
string
The Application Group name
namespaceName
This property is required.
Changes to this property will trigger replacement.
string
The Namespace name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
string
Name of the resource group within the azure subscription.
application_group_name
This property is required.
Changes to this property will trigger replacement.
str
The Application Group name
namespace_name
This property is required.
Changes to this property will trigger replacement.
str
The Namespace name
resource_group_name
This property is required.
Changes to this property will trigger replacement.
str
Name of the resource group within the azure subscription.
applicationGroupName
This property is required.
Changes to this property will trigger replacement.
String
The Application Group name
namespaceName
This property is required.
Changes to this property will trigger replacement.
String
The Namespace name
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
String
Name of the resource group within the azure subscription.

getApplicationGroup Result

The following output properties are available:

ClientAppGroupIdentifier string
The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid)
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
SystemData Pulumi.AzureNative.EventHub.Outputs.SystemDataResponse
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"
IsEnabled bool
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
Policies List<Pulumi.AzureNative.EventHub.Outputs.ThrottlingPolicyResponse>
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.
ClientAppGroupIdentifier string
The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid)
Id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
Location string
The geo-location where the resource lives
Name string
The name of the resource
SystemData SystemDataResponse
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"
IsEnabled bool
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
Policies []ThrottlingPolicyResponse
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.
clientAppGroupIdentifier String
The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid)
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
systemData SystemDataResponse
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"
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
policies List<ThrottlingPolicyResponse>
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.
clientAppGroupIdentifier string
The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid)
id string
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location string
The geo-location where the resource lives
name string
The name of the resource
systemData SystemDataResponse
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"
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
policies ThrottlingPolicyResponse[]
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.
client_app_group_identifier str
The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid)
id str
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location str
The geo-location where the resource lives
name str
The name of the resource
system_data SystemDataResponse
The system meta data relating to this resource.
type str
The type of the resource. E.g. "Microsoft.EventHub/Namespaces" or "Microsoft.EventHub/Namespaces/EventHubs"
is_enabled bool
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
policies Sequence[ThrottlingPolicyResponse]
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.
clientAppGroupIdentifier String
The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid)
id String
Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
location String
The geo-location where the resource lives
name String
The name of the resource
systemData Property Map
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"
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
policies List<Property Map>
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.

Supporting Types

SystemDataResponse

CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The type of identity that last modified the resource.
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
CreatedAt string
The timestamp of resource creation (UTC).
CreatedBy string
The identity that created the resource.
CreatedByType string
The type of identity that created the resource.
LastModifiedAt string
The type of identity that last modified the resource.
LastModifiedBy string
The identity that last modified the resource.
LastModifiedByType string
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The type of identity that last modified the resource.
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.
createdAt string
The timestamp of resource creation (UTC).
createdBy string
The identity that created the resource.
createdByType string
The type of identity that created the resource.
lastModifiedAt string
The type of identity that last modified the resource.
lastModifiedBy string
The identity that last modified the resource.
lastModifiedByType string
The type of identity that last modified the resource.
created_at str
The timestamp of resource creation (UTC).
created_by str
The identity that created the resource.
created_by_type str
The type of identity that created the resource.
last_modified_at str
The type of identity that last modified the resource.
last_modified_by str
The identity that last modified the resource.
last_modified_by_type str
The type of identity that last modified the resource.
createdAt String
The timestamp of resource creation (UTC).
createdBy String
The identity that created the resource.
createdByType String
The type of identity that created the resource.
lastModifiedAt String
The type of identity that last modified the resource.
lastModifiedBy String
The identity that last modified the resource.
lastModifiedByType String
The type of identity that last modified the resource.

ThrottlingPolicyResponse

MetricId This property is required. string
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
Name This property is required. string
The Name of this policy
RateLimitThreshold This property is required. double
The Threshold limit above which the application group will be throttled.Rate limit is always per second.
MetricId This property is required. string
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
Name This property is required. string
The Name of this policy
RateLimitThreshold This property is required. float64
The Threshold limit above which the application group will be throttled.Rate limit is always per second.
metricId This property is required. String
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
name This property is required. String
The Name of this policy
rateLimitThreshold This property is required. Double
The Threshold limit above which the application group will be throttled.Rate limit is always per second.
metricId This property is required. string
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
name This property is required. string
The Name of this policy
rateLimitThreshold This property is required. number
The Threshold limit above which the application group will be throttled.Rate limit is always per second.
metric_id This property is required. str
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
name This property is required. str
The Name of this policy
rate_limit_threshold This property is required. float
The Threshold limit above which the application group will be throttled.Rate limit is always per second.
metricId This property is required. String
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
name This property is required. String
The Name of this policy
rateLimitThreshold This property is required. Number
The Threshold limit above which the application group will be throttled.Rate limit is always per second.

Package Details

Repository
azure-native-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native