Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. eventhub
  5. getEventHubAuthorizationRule
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.getEventHubAuthorizationRule

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 AuthorizationRule for an Event Hub by rule name. Azure REST API version: 2022-10-01-preview.

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

Using getEventHubAuthorizationRule

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 getEventHubAuthorizationRule(args: GetEventHubAuthorizationRuleArgs, opts?: InvokeOptions): Promise<GetEventHubAuthorizationRuleResult>
function getEventHubAuthorizationRuleOutput(args: GetEventHubAuthorizationRuleOutputArgs, opts?: InvokeOptions): Output<GetEventHubAuthorizationRuleResult>
Copy
def get_event_hub_authorization_rule(authorization_rule_name: Optional[str] = None,
                                     event_hub_name: Optional[str] = None,
                                     namespace_name: Optional[str] = None,
                                     resource_group_name: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetEventHubAuthorizationRuleResult
def get_event_hub_authorization_rule_output(authorization_rule_name: Optional[pulumi.Input[str]] = None,
                                     event_hub_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[GetEventHubAuthorizationRuleResult]
Copy
func LookupEventHubAuthorizationRule(ctx *Context, args *LookupEventHubAuthorizationRuleArgs, opts ...InvokeOption) (*LookupEventHubAuthorizationRuleResult, error)
func LookupEventHubAuthorizationRuleOutput(ctx *Context, args *LookupEventHubAuthorizationRuleOutputArgs, opts ...InvokeOption) LookupEventHubAuthorizationRuleResultOutput
Copy

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

public static class GetEventHubAuthorizationRule 
{
    public static Task<GetEventHubAuthorizationRuleResult> InvokeAsync(GetEventHubAuthorizationRuleArgs args, InvokeOptions? opts = null)
    public static Output<GetEventHubAuthorizationRuleResult> Invoke(GetEventHubAuthorizationRuleInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetEventHubAuthorizationRuleResult> getEventHubAuthorizationRule(GetEventHubAuthorizationRuleArgs args, InvokeOptions options)
public static Output<GetEventHubAuthorizationRuleResult> getEventHubAuthorizationRule(GetEventHubAuthorizationRuleArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:eventhub:getEventHubAuthorizationRule
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AuthorizationRuleName
This property is required.
Changes to this property will trigger replacement.
string
The authorization rule name.
EventHubName
This property is required.
Changes to this property will trigger replacement.
string
The Event Hub 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.
AuthorizationRuleName
This property is required.
Changes to this property will trigger replacement.
string
The authorization rule name.
EventHubName
This property is required.
Changes to this property will trigger replacement.
string
The Event Hub 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.
authorizationRuleName
This property is required.
Changes to this property will trigger replacement.
String
The authorization rule name.
eventHubName
This property is required.
Changes to this property will trigger replacement.
String
The Event Hub 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.
authorizationRuleName
This property is required.
Changes to this property will trigger replacement.
string
The authorization rule name.
eventHubName
This property is required.
Changes to this property will trigger replacement.
string
The Event Hub 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.
authorization_rule_name
This property is required.
Changes to this property will trigger replacement.
str
The authorization rule name.
event_hub_name
This property is required.
Changes to this property will trigger replacement.
str
The Event Hub 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.
authorizationRuleName
This property is required.
Changes to this property will trigger replacement.
String
The authorization rule name.
eventHubName
This property is required.
Changes to this property will trigger replacement.
String
The Event Hub 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.

getEventHubAuthorizationRule Result

The following output properties are available:

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
Rights List<string>
The rights associated with the rule.
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"
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
Rights []string
The rights associated with the rule.
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"
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
rights List<String>
The rights associated with the rule.
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"
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
rights string[]
The rights associated with the rule.
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"
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
rights Sequence[str]
The rights associated with the rule.
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"
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
rights List<String>
The rights associated with the rule.
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"

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.

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