1. Packages
  2. Azure Native
  3. API Docs
  4. notificationhubs
  5. getNotificationHubAuthorizationRule
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi

azure-native.notificationhubs.getNotificationHubAuthorizationRule

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi

    Response for POST requests that return single SharedAccessAuthorizationRule.

    Uses Azure REST API version 2023-10-01-preview.

    Other available API versions: 2023-01-01-preview, 2023-09-01. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native notificationhubs [ApiVersion]. See the version guide for details.

    Using getNotificationHubAuthorizationRule

    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 getNotificationHubAuthorizationRule(args: GetNotificationHubAuthorizationRuleArgs, opts?: InvokeOptions): Promise<GetNotificationHubAuthorizationRuleResult>
    function getNotificationHubAuthorizationRuleOutput(args: GetNotificationHubAuthorizationRuleOutputArgs, opts?: InvokeOptions): Output<GetNotificationHubAuthorizationRuleResult>
    def get_notification_hub_authorization_rule(authorization_rule_name: Optional[str] = None,
                                                namespace_name: Optional[str] = None,
                                                notification_hub_name: Optional[str] = None,
                                                resource_group_name: Optional[str] = None,
                                                opts: Optional[InvokeOptions] = None) -> GetNotificationHubAuthorizationRuleResult
    def get_notification_hub_authorization_rule_output(authorization_rule_name: Optional[pulumi.Input[str]] = None,
                                                namespace_name: Optional[pulumi.Input[str]] = None,
                                                notification_hub_name: Optional[pulumi.Input[str]] = None,
                                                resource_group_name: Optional[pulumi.Input[str]] = None,
                                                opts: Optional[InvokeOptions] = None) -> Output[GetNotificationHubAuthorizationRuleResult]
    func LookupNotificationHubAuthorizationRule(ctx *Context, args *LookupNotificationHubAuthorizationRuleArgs, opts ...InvokeOption) (*LookupNotificationHubAuthorizationRuleResult, error)
    func LookupNotificationHubAuthorizationRuleOutput(ctx *Context, args *LookupNotificationHubAuthorizationRuleOutputArgs, opts ...InvokeOption) LookupNotificationHubAuthorizationRuleResultOutput

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

    public static class GetNotificationHubAuthorizationRule 
    {
        public static Task<GetNotificationHubAuthorizationRuleResult> InvokeAsync(GetNotificationHubAuthorizationRuleArgs args, InvokeOptions? opts = null)
        public static Output<GetNotificationHubAuthorizationRuleResult> Invoke(GetNotificationHubAuthorizationRuleInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetNotificationHubAuthorizationRuleResult> getNotificationHubAuthorizationRule(GetNotificationHubAuthorizationRuleArgs args, InvokeOptions options)
    public static Output<GetNotificationHubAuthorizationRuleResult> getNotificationHubAuthorizationRule(GetNotificationHubAuthorizationRuleArgs args, InvokeOptions options)
    
    fn::invoke:
      function: azure-native:notificationhubs:getNotificationHubAuthorizationRule
      arguments:
        # arguments dictionary

    The following arguments are supported:

    AuthorizationRuleName string
    Authorization Rule Name
    NamespaceName string
    Namespace name
    NotificationHubName string
    Notification Hub name
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    AuthorizationRuleName string
    Authorization Rule Name
    NamespaceName string
    Namespace name
    NotificationHubName string
    Notification Hub name
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    authorizationRuleName String
    Authorization Rule Name
    namespaceName String
    Namespace name
    notificationHubName String
    Notification Hub name
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    authorizationRuleName string
    Authorization Rule Name
    namespaceName string
    Namespace name
    notificationHubName string
    Notification Hub name
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    authorization_rule_name str
    Authorization Rule Name
    namespace_name str
    Namespace name
    notification_hub_name str
    Notification Hub name
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    authorizationRuleName String
    Authorization Rule Name
    namespaceName String
    Namespace name
    notificationHubName String
    Notification Hub name
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getNotificationHubAuthorizationRule Result

    The following output properties are available:

    AzureApiVersion string
    The Azure API version of the resource.
    ClaimType string
    Gets a string that describes the claim type
    ClaimValue string
    Gets a string that describes the claim value
    CreatedTime string
    Gets the created time for this rule
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    KeyName string
    Gets a string that describes the authorization rule.
    ModifiedTime string
    Gets the last modified time for this rule
    Name string
    The name of the resource
    Revision int
    Gets the revision number for the rule
    Rights List<string>
    Gets or sets the rights associated with the rule.
    SystemData Pulumi.AzureNative.NotificationHubs.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Location string
    Deprecated - only for compatibility.
    PrimaryKey string
    Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
    SecondaryKey string
    Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
    Tags Dictionary<string, string>
    Deprecated - only for compatibility.
    AzureApiVersion string
    The Azure API version of the resource.
    ClaimType string
    Gets a string that describes the claim type
    ClaimValue string
    Gets a string that describes the claim value
    CreatedTime string
    Gets the created time for this rule
    Id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    KeyName string
    Gets a string that describes the authorization rule.
    ModifiedTime string
    Gets the last modified time for this rule
    Name string
    The name of the resource
    Revision int
    Gets the revision number for the rule
    Rights []string
    Gets or sets the rights associated with the rule.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    Location string
    Deprecated - only for compatibility.
    PrimaryKey string
    Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
    SecondaryKey string
    Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
    Tags map[string]string
    Deprecated - only for compatibility.
    azureApiVersion String
    The Azure API version of the resource.
    claimType String
    Gets a string that describes the claim type
    claimValue String
    Gets a string that describes the claim value
    createdTime String
    Gets the created time for this rule
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    keyName String
    Gets a string that describes the authorization rule.
    modifiedTime String
    Gets the last modified time for this rule
    name String
    The name of the resource
    revision Integer
    Gets the revision number for the rule
    rights List<String>
    Gets or sets the rights associated with the rule.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    location String
    Deprecated - only for compatibility.
    primaryKey String
    Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
    secondaryKey String
    Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
    tags Map<String,String>
    Deprecated - only for compatibility.
    azureApiVersion string
    The Azure API version of the resource.
    claimType string
    Gets a string that describes the claim type
    claimValue string
    Gets a string that describes the claim value
    createdTime string
    Gets the created time for this rule
    id string
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    keyName string
    Gets a string that describes the authorization rule.
    modifiedTime string
    Gets the last modified time for this rule
    name string
    The name of the resource
    revision number
    Gets the revision number for the rule
    rights string[]
    Gets or sets the rights associated with the rule.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    location string
    Deprecated - only for compatibility.
    primaryKey string
    Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
    secondaryKey string
    Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
    tags {[key: string]: string}
    Deprecated - only for compatibility.
    azure_api_version str
    The Azure API version of the resource.
    claim_type str
    Gets a string that describes the claim type
    claim_value str
    Gets a string that describes the claim value
    created_time str
    Gets the created time for this rule
    id str
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    key_name str
    Gets a string that describes the authorization rule.
    modified_time str
    Gets the last modified time for this rule
    name str
    The name of the resource
    revision int
    Gets the revision number for the rule
    rights Sequence[str]
    Gets or sets the rights associated with the rule.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    location str
    Deprecated - only for compatibility.
    primary_key str
    Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
    secondary_key str
    Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
    tags Mapping[str, str]
    Deprecated - only for compatibility.
    azureApiVersion String
    The Azure API version of the resource.
    claimType String
    Gets a string that describes the claim type
    claimValue String
    Gets a string that describes the claim value
    createdTime String
    Gets the created time for this rule
    id String
    Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
    keyName String
    Gets a string that describes the authorization rule.
    modifiedTime String
    Gets the last modified time for this rule
    name String
    The name of the resource
    revision Number
    Gets the revision number for the rule
    rights List<String>
    Gets or sets the rights associated with the rule.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    location String
    Deprecated - only for compatibility.
    primaryKey String
    Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
    secondaryKey String
    Gets a base64-encoded 256-bit primary key for signing and validating the SAS token.
    tags Map<String>
    Deprecated - only for compatibility.

    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 timestamp of resource last modification (UTC)
    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 timestamp of resource last modification (UTC)
    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 timestamp of resource last modification (UTC)
    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 timestamp of resource last modification (UTC)
    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 timestamp of resource last modification (UTC)
    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 timestamp of resource last modification (UTC)
    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 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v2 docs if using the v2 version of this package.
    Azure Native v3.3.0 published on Monday, Apr 28, 2025 by Pulumi