azure-native.eventhub.getEventHubAuthorizationRule
Explore with Pulumi AI
Gets an AuthorizationRule for an Event Hub by rule name.
Uses Azure REST API version 2024-01-01.
Other available API versions: 2018-01-01-preview, 2021-01-01-preview, 2021-06-01-preview, 2021-11-01, 2022-01-01-preview, 2022-10-01-preview, 2023-01-01-preview, 2024-05-01-preview. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native eventhub [ApiVersion]. See the version guide for details.
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>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]func LookupEventHubAuthorizationRule(ctx *Context, args *LookupEventHubAuthorizationRuleArgs, opts ...InvokeOption) (*LookupEventHubAuthorizationRuleResult, error)
func LookupEventHubAuthorizationRuleOutput(ctx *Context, args *LookupEventHubAuthorizationRuleOutputArgs, opts ...InvokeOption) LookupEventHubAuthorizationRuleResultOutput> 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)
}public static CompletableFuture<GetEventHubAuthorizationRuleResult> getEventHubAuthorizationRule(GetEventHubAuthorizationRuleArgs args, InvokeOptions options)
public static Output<GetEventHubAuthorizationRuleResult> getEventHubAuthorizationRule(GetEventHubAuthorizationRuleArgs args, InvokeOptions options)
fn::invoke:
  function: azure-native:eventhub:getEventHubAuthorizationRule
  arguments:
    # arguments dictionaryThe following arguments are supported:
- string
 - The authorization rule name.
 - Event
Hub stringName  - The Event Hub name
 - Namespace
Name string - The Namespace name
 - Resource
Group stringName  - Name of the resource group within the azure subscription.
 
- string
 - The authorization rule name.
 - Event
Hub stringName  - The Event Hub name
 - Namespace
Name string - The Namespace name
 - Resource
Group stringName  - Name of the resource group within the azure subscription.
 
- String
 - The authorization rule name.
 - event
Hub StringName  - The Event Hub name
 - namespace
Name String - The Namespace name
 - resource
Group StringName  - Name of the resource group within the azure subscription.
 
- string
 - The authorization rule name.
 - event
Hub stringName  - The Event Hub name
 - namespace
Name string - The Namespace name
 - resource
Group stringName  - Name of the resource group within the azure subscription.
 
- str
 - The authorization rule name.
 - event_
hub_ strname  - The Event Hub name
 - namespace_
name str - The Namespace name
 - resource_
group_ strname  - Name of the resource group within the azure subscription.
 
- String
 - The authorization rule name.
 - event
Hub StringName  - The Event Hub name
 - namespace
Name String - The Namespace name
 - resource
Group StringName  - Name of the resource group within the azure subscription.
 
getEventHubAuthorizationRule Result
The following output properties are available:
- Azure
Api stringVersion  - The Azure API version of the resource.
 - 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.
 - 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"
 
- Azure
Api stringVersion  - The Azure API version of the resource.
 - 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.
 - 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"
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - 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.
 - 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"
 
- azure
Api stringVersion  - The Azure API version of the resource.
 - 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.
 - 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"
 
- azure_
api_ strversion  - The Azure API version of the resource.
 - 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 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"
 
- azure
Api StringVersion  - The Azure API version of the resource.
 - 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.
 - 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
SystemDataResponse  
- 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.
 
Package Details
- Repository
 - Azure Native pulumi/pulumi-azure-native
 - License
 - Apache-2.0