azure-native-v2.eventhub.ApplicationGroup
Explore with Pulumi AI
The Application Group object Azure REST API version: 2022-10-01-preview. Prior API version in Azure Native 1.x: 2022-01-01-preview.
Other available API versions: 2023-01-01-preview, 2024-01-01, 2024-05-01-preview.
Create ApplicationGroup Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new ApplicationGroup(name: string, args: ApplicationGroupArgs, opts?: CustomResourceOptions);
@overload
def ApplicationGroup(resource_name: str,
args: ApplicationGroupArgs,
opts: Optional[ResourceOptions] = None)
@overload
def ApplicationGroup(resource_name: str,
opts: Optional[ResourceOptions] = None,
client_app_group_identifier: Optional[str] = None,
namespace_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
application_group_name: Optional[str] = None,
is_enabled: Optional[bool] = None,
policies: Optional[Sequence[ThrottlingPolicyArgs]] = None)
func NewApplicationGroup(ctx *Context, name string, args ApplicationGroupArgs, opts ...ResourceOption) (*ApplicationGroup, error)
public ApplicationGroup(string name, ApplicationGroupArgs args, CustomResourceOptions? opts = null)
public ApplicationGroup(String name, ApplicationGroupArgs args)
public ApplicationGroup(String name, ApplicationGroupArgs args, CustomResourceOptions options)
type: azure-native:eventhub:ApplicationGroup
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
Parameters
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ApplicationGroupArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
This property is required. str - The unique name of the resource.
- args
This property is required. ApplicationGroupArgs - The arguments to resource properties.
- opts ResourceOptions
- Bag of options to control resource's behavior.
- ctx Context
- Context object for the current deployment.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ApplicationGroupArgs - The arguments to resource properties.
- opts ResourceOption
- Bag of options to control resource's behavior.
- name
This property is required. string - The unique name of the resource.
- args
This property is required. ApplicationGroupArgs - The arguments to resource properties.
- opts CustomResourceOptions
- Bag of options to control resource's behavior.
- name
This property is required. String - The unique name of the resource.
- args
This property is required. ApplicationGroupArgs - The arguments to resource properties.
- options CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var azure_nativeApplicationGroupResource = new AzureNative.Eventhub.ApplicationGroup("azure-nativeApplicationGroupResource", new()
{
ClientAppGroupIdentifier = "string",
NamespaceName = "string",
ResourceGroupName = "string",
ApplicationGroupName = "string",
IsEnabled = false,
Policies = new[]
{
{
{ "metricId", "string" },
{ "name", "string" },
{ "rateLimitThreshold", 0 },
{ "type", "ThrottlingPolicy" },
},
},
});
example, err := eventhub.NewApplicationGroup(ctx, "azure-nativeApplicationGroupResource", &eventhub.ApplicationGroupArgs{
ClientAppGroupIdentifier: "string",
NamespaceName: "string",
ResourceGroupName: "string",
ApplicationGroupName: "string",
IsEnabled: false,
Policies: []map[string]interface{}{
map[string]interface{}{
"metricId": "string",
"name": "string",
"rateLimitThreshold": 0,
"type": "ThrottlingPolicy",
},
},
})
var azure_nativeApplicationGroupResource = new ApplicationGroup("azure-nativeApplicationGroupResource", ApplicationGroupArgs.builder()
.clientAppGroupIdentifier("string")
.namespaceName("string")
.resourceGroupName("string")
.applicationGroupName("string")
.isEnabled(false)
.policies(%!v(PANIC=Format method: runtime error: invalid memory address or nil pointer dereference))
.build());
azure_native_application_group_resource = azure_native.eventhub.ApplicationGroup("azure-nativeApplicationGroupResource",
client_app_group_identifier=string,
namespace_name=string,
resource_group_name=string,
application_group_name=string,
is_enabled=False,
policies=[{
metricId: string,
name: string,
rateLimitThreshold: 0,
type: ThrottlingPolicy,
}])
const azure_nativeApplicationGroupResource = new azure_native.eventhub.ApplicationGroup("azure-nativeApplicationGroupResource", {
clientAppGroupIdentifier: "string",
namespaceName: "string",
resourceGroupName: "string",
applicationGroupName: "string",
isEnabled: false,
policies: [{
metricId: "string",
name: "string",
rateLimitThreshold: 0,
type: "ThrottlingPolicy",
}],
});
type: azure-native:eventhub:ApplicationGroup
properties:
applicationGroupName: string
clientAppGroupIdentifier: string
isEnabled: false
namespaceName: string
policies:
- metricId: string
name: string
rateLimitThreshold: 0
type: ThrottlingPolicy
resourceGroupName: string
ApplicationGroup Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
Inputs
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The ApplicationGroup resource accepts the following input properties:
- Client
App Group Identifier This property is required. string - The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid)
- Namespace
Name This property is required. Changes to this property will trigger replacement.
- The Namespace name
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of the resource group within the azure subscription.
- Application
Group Name Changes to this property will trigger replacement.
- The Application Group name
- 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
List<Pulumi.
Azure Native. Event Hub. Inputs. Throttling Policy> - 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 This property is required. string - The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid)
- Namespace
Name This property is required. Changes to this property will trigger replacement.
- The Namespace name
- Resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of the resource group within the azure subscription.
- Application
Group Name Changes to this property will trigger replacement.
- The Application Group name
- 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
[]Throttling
Policy Args - 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 This property is required. String - The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid)
- namespace
Name This property is required. Changes to this property will trigger replacement.
- The Namespace name
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of the resource group within the azure subscription.
- application
Group Name Changes to this property will trigger replacement.
- The Application Group name
- is
Enabled 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<Throttling
Policy> - 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 This property is required. string - The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid)
- namespace
Name This property is required. Changes to this property will trigger replacement.
- The Namespace name
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of the resource group within the azure subscription.
- application
Group Name Changes to this property will trigger replacement.
- The Application Group name
- is
Enabled 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
Throttling
Policy[] - 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 This property is required. str - The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid)
- namespace_
name This property is required. Changes to this property will trigger replacement.
- The Namespace name
- resource_
group_ name This property is required. Changes to this property will trigger replacement.
- Name of the resource group within the azure subscription.
- application_
group_ name Changes to this property will trigger replacement.
- The Application Group name
- 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[Throttling
Policy Args] - 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 This property is required. String - The Unique identifier for application group.Supports SAS(SASKeyName=KeyName) or AAD(AADAppID=Guid)
- namespace
Name This property is required. Changes to this property will trigger replacement.
- The Namespace name
- resource
Group Name This property is required. Changes to this property will trigger replacement.
- Name of the resource group within the azure subscription.
- application
Group Name Changes to this property will trigger replacement.
- The Application Group name
- is
Enabled 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.
Outputs
All input properties are implicitly available as output properties. Additionally, the ApplicationGroup resource produces the following output properties:
- Id string
- The provider-assigned unique ID for this managed resource.
- Location string
- The geo-location where the resource lives
- Name string
- The name of the resource
- System
Data Pulumi.Azure Native. Event Hub. Outputs. System Data Response - 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"
- Id string
- The provider-assigned unique ID for this managed resource.
- Location string
- The geo-location where the resource lives
- Name string
- The name of the resource
- System
Data SystemData Response - 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"
- id String
- The provider-assigned unique ID for this managed resource.
- location String
- The geo-location where the resource lives
- name String
- The name of the resource
- system
Data SystemData Response - 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"
- id string
- The provider-assigned unique ID for this managed resource.
- location string
- The geo-location where the resource lives
- name string
- The name of the resource
- system
Data SystemData Response - 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"
- id str
- The provider-assigned unique ID for this managed resource.
- location str
- The geo-location where the resource lives
- name str
- The name of the resource
- system_
data SystemData Response - 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"
- id String
- The provider-assigned unique ID for this managed resource.
- location String
- The geo-location where the resource lives
- name String
- The name of the resource
- system
Data 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"
Supporting Types
MetricId, MetricIdArgs
- Incoming
Bytes - IncomingBytes
- Outgoing
Bytes - OutgoingBytes
- Incoming
Messages - IncomingMessages
- Outgoing
Messages - OutgoingMessages
- Metric
Id Incoming Bytes - IncomingBytes
- Metric
Id Outgoing Bytes - OutgoingBytes
- Metric
Id Incoming Messages - IncomingMessages
- Metric
Id Outgoing Messages - OutgoingMessages
- Incoming
Bytes - IncomingBytes
- Outgoing
Bytes - OutgoingBytes
- Incoming
Messages - IncomingMessages
- Outgoing
Messages - OutgoingMessages
- Incoming
Bytes - IncomingBytes
- Outgoing
Bytes - OutgoingBytes
- Incoming
Messages - IncomingMessages
- Outgoing
Messages - OutgoingMessages
- INCOMING_BYTES
- IncomingBytes
- OUTGOING_BYTES
- OutgoingBytes
- INCOMING_MESSAGES
- IncomingMessages
- OUTGOING_MESSAGES
- OutgoingMessages
- "Incoming
Bytes" - IncomingBytes
- "Outgoing
Bytes" - OutgoingBytes
- "Incoming
Messages" - IncomingMessages
- "Outgoing
Messages" - OutgoingMessages
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The type of identity that last modified the resource.
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The type of identity that last modified the resource.
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The type of identity that last modified the resource.
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The type of identity that last modified the resource.
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The type of identity that last modified the resource.
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The type of identity that last modified the resource.
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
ThrottlingPolicy, ThrottlingPolicyArgs
- Metric
Id This property is required. string | Pulumi.Azure Native. Event Hub. Metric Id - 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
- Rate
Limit Threshold This property is required. double - The Threshold limit above which the application group will be throttled.Rate limit is always per second.
- Metric
Id This property is required. string | 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
- Name
This property is required. string - The Name of this policy
- Rate
Limit Threshold This property is required. float64 - The Threshold limit above which the application group will be throttled.Rate limit is always per second.
- metric
Id This property is required. String | 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
- name
This property is required. String - The Name of this policy
- rate
Limit Threshold This property is required. Double - The Threshold limit above which the application group will be throttled.Rate limit is always per second.
- metric
Id This property is required. string | 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
- name
This property is required. string - The Name of this policy
- rate
Limit Threshold 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 | 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
- 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.
- metric
Id This property is required. String | "IncomingBytes" | "Outgoing Bytes" | "Incoming Messages" | "Outgoing Messages" - 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
- rate
Limit Threshold This property is required. Number - The Threshold limit above which the application group will be throttled.Rate limit is always per second.
ThrottlingPolicyResponse, ThrottlingPolicyResponseArgs
- Metric
Id 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
- Rate
Limit Threshold This property is required. double - The Threshold limit above which the application group will be throttled.Rate limit is always per second.
- Metric
Id 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
- Rate
Limit Threshold This property is required. float64 - The Threshold limit above which the application group will be throttled.Rate limit is always per second.
- metric
Id 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
- rate
Limit Threshold This property is required. Double - The Threshold limit above which the application group will be throttled.Rate limit is always per second.
- metric
Id 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
- rate
Limit Threshold 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.
- metric
Id 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
- rate
Limit Threshold This property is required. Number - The Threshold limit above which the application group will be throttled.Rate limit is always per second.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:eventhub:ApplicationGroup appGroup1 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/namespaces/{namespaceName}/applicationGroups/{applicationGroupName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- azure-native-v2 pulumi/pulumi-azure-native
- License
- Apache-2.0