Docs Packages
  1. Packages
  2. Azure Native
  3. API Docs
  4. webpubsub
  5. getWebPubSubHub
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure-native

azure-native.webpubsub.getWebPubSubHub

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi
pulumi/pulumi-azure-native

    Get a hub setting. Azure REST API version: 2023-02-01.

    Other available API versions: 2023-03-01-preview, 2023-06-01-preview, 2023-08-01-preview, 2024-01-01-preview.

    Using getWebPubSubHub

    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 getWebPubSubHub(args: GetWebPubSubHubArgs, opts?: InvokeOptions): Promise<GetWebPubSubHubResult>
function getWebPubSubHubOutput(args: GetWebPubSubHubOutputArgs, opts?: InvokeOptions): Output<GetWebPubSubHubResult>
    def get_web_pub_sub_hub(hub_name: Optional[str] = None,
                        resource_group_name: Optional[str] = None,
                        resource_name: Optional[str] = None,
                        opts: Optional[InvokeOptions] = None) -> GetWebPubSubHubResult
def get_web_pub_sub_hub_output(hub_name: Optional[pulumi.Input[str]] = None,
                        resource_group_name: Optional[pulumi.Input[str]] = None,
                        resource_name: Optional[pulumi.Input[str]] = None,
                        opts: Optional[InvokeOptions] = None) -> Output[GetWebPubSubHubResult]
    func LookupWebPubSubHub(ctx *Context, args *LookupWebPubSubHubArgs, opts ...InvokeOption) (*LookupWebPubSubHubResult, error)
func LookupWebPubSubHubOutput(ctx *Context, args *LookupWebPubSubHubOutputArgs, opts ...InvokeOption) LookupWebPubSubHubResultOutput

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

    public static class GetWebPubSubHub 
{
    public static Task<GetWebPubSubHubResult> InvokeAsync(GetWebPubSubHubArgs args, InvokeOptions? opts = null)
    public static Output<GetWebPubSubHubResult> Invoke(GetWebPubSubHubInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetWebPubSubHubResult> getWebPubSubHub(GetWebPubSubHubArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:webpubsub:getWebPubSubHub
  arguments:
    # arguments dictionary

    The following arguments are supported:

    HubName string
    The hub name.
    ResourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    ResourceName string
    The name of the resource.
    HubName string
    The hub name.
    ResourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    ResourceName string
    The name of the resource.
    hubName String
    The hub name.
    resourceGroupName String
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    resourceName String
    The name of the resource.
    hubName string
    The hub name.
    resourceGroupName string
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    resourceName string
    The name of the resource.
    hub_name str
    The hub name.
    resource_group_name str
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    resource_name str
    The name of the resource.
    hubName String
    The hub name.
    resourceGroupName String
    The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.
    resourceName String
    The name of the resource.

    getWebPubSubHub Result

    The following output properties are available:

    Id string
    Fully qualified resource Id for the resource.
    Name string
    The name of the resource.
    Properties Pulumi.AzureNative.WebPubSub.Outputs.WebPubSubHubPropertiesResponse
    Properties of a hub.
    SystemData Pulumi.AzureNative.WebPubSub.Outputs.SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
    Id string
    Fully qualified resource Id for the resource.
    Name string
    The name of the resource.
    Properties WebPubSubHubPropertiesResponse
    Properties of a hub.
    SystemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
    id String
    Fully qualified resource Id for the resource.
    name String
    The name of the resource.
    properties WebPubSubHubPropertiesResponse
    Properties of a hub.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type String
    The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
    id string
    Fully qualified resource Id for the resource.
    name string
    The name of the resource.
    properties WebPubSubHubPropertiesResponse
    Properties of a hub.
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type string
    The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
    id str
    Fully qualified resource Id for the resource.
    name str
    The name of the resource.
    properties WebPubSubHubPropertiesResponse
    Properties of a hub.
    system_data SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type str
    The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
    id String
    Fully qualified resource Id for the resource.
    name String
    The name of the resource.
    properties Property Map
    Properties of a hub.
    systemData Property Map
    Metadata pertaining to creation and last modification of the resource.
    type String
    The type of the resource - e.g. "Microsoft.SignalRService/SignalR"

    Supporting Types

    EventHandlerResponse

    UrlTemplate string
    Gets or sets the EventHandler URL template. You can use a predefined parameter {hub} and {event} inside the template, the value of the EventHandler URL is dynamically calculated when the client request comes in. For example, UrlTemplate can be http://example.com/api/{hub}/{event}. The host part can't contains parameters.
    Auth Pulumi.AzureNative.WebPubSub.Inputs.UpstreamAuthSettingsResponse
    Upstream auth settings. If not set, no auth is used for upstream messages.
    SystemEvents List<string>
    Gets or sets the list of system events.
    UserEventPattern string
    Gets or sets the matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1"
    UrlTemplate string
    Gets or sets the EventHandler URL template. You can use a predefined parameter {hub} and {event} inside the template, the value of the EventHandler URL is dynamically calculated when the client request comes in. For example, UrlTemplate can be http://example.com/api/{hub}/{event}. The host part can't contains parameters.
    Auth UpstreamAuthSettingsResponse
    Upstream auth settings. If not set, no auth is used for upstream messages.
    SystemEvents []string
    Gets or sets the list of system events.
    UserEventPattern string
    Gets or sets the matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1"
    urlTemplate String
    Gets or sets the EventHandler URL template. You can use a predefined parameter {hub} and {event} inside the template, the value of the EventHandler URL is dynamically calculated when the client request comes in. For example, UrlTemplate can be http://example.com/api/{hub}/{event}. The host part can't contains parameters.
    auth UpstreamAuthSettingsResponse
    Upstream auth settings. If not set, no auth is used for upstream messages.
    systemEvents List<String>
    Gets or sets the list of system events.
    userEventPattern String
    Gets or sets the matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1"
    urlTemplate string
    Gets or sets the EventHandler URL template. You can use a predefined parameter {hub} and {event} inside the template, the value of the EventHandler URL is dynamically calculated when the client request comes in. For example, UrlTemplate can be http://example.com/api/{hub}/{event}. The host part can't contains parameters.
    auth UpstreamAuthSettingsResponse
    Upstream auth settings. If not set, no auth is used for upstream messages.
    systemEvents string[]
    Gets or sets the list of system events.
    userEventPattern string
    Gets or sets the matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1"
    url_template str
    Gets or sets the EventHandler URL template. You can use a predefined parameter {hub} and {event} inside the template, the value of the EventHandler URL is dynamically calculated when the client request comes in. For example, UrlTemplate can be http://example.com/api/{hub}/{event}. The host part can't contains parameters.
    auth UpstreamAuthSettingsResponse
    Upstream auth settings. If not set, no auth is used for upstream messages.
    system_events Sequence[str]
    Gets or sets the list of system events.
    user_event_pattern str
    Gets or sets the matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1"
    urlTemplate String
    Gets or sets the EventHandler URL template. You can use a predefined parameter {hub} and {event} inside the template, the value of the EventHandler URL is dynamically calculated when the client request comes in. For example, UrlTemplate can be http://example.com/api/{hub}/{event}. The host part can't contains parameters.
    auth Property Map
    Upstream auth settings. If not set, no auth is used for upstream messages.
    systemEvents List<String>
    Gets or sets the list of system events.
    userEventPattern String
    Gets or sets the matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches event "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1"

    EventHubEndpointResponse

    EventHubName string
    The name of the Event Hub.
    FullyQualifiedNamespace string
    The fully qualified namespace name of the Event Hub resource. For example, "example.servicebus.windows.net".
    EventHubName string
    The name of the Event Hub.
    FullyQualifiedNamespace string
    The fully qualified namespace name of the Event Hub resource. For example, "example.servicebus.windows.net".
    eventHubName String
    The name of the Event Hub.
    fullyQualifiedNamespace String
    The fully qualified namespace name of the Event Hub resource. For example, "example.servicebus.windows.net".
    eventHubName string
    The name of the Event Hub.
    fullyQualifiedNamespace string
    The fully qualified namespace name of the Event Hub resource. For example, "example.servicebus.windows.net".
    event_hub_name str
    The name of the Event Hub.
    fully_qualified_namespace str
    The fully qualified namespace name of the Event Hub resource. For example, "example.servicebus.windows.net".
    eventHubName String
    The name of the Event Hub.
    fullyQualifiedNamespace String
    The fully qualified namespace name of the Event Hub resource. For example, "example.servicebus.windows.net".

    EventListenerResponse

    Endpoint Pulumi.AzureNative.WebPubSub.Inputs.EventHubEndpointResponse
    An endpoint specifying where Web PubSub should send events to.
    Filter Pulumi.AzureNative.WebPubSub.Inputs.EventNameFilterResponse
    A base class for event filter which determines whether an event should be sent to an event listener.
    Endpoint EventHubEndpointResponse
    An endpoint specifying where Web PubSub should send events to.
    Filter EventNameFilterResponse
    A base class for event filter which determines whether an event should be sent to an event listener.
    endpoint EventHubEndpointResponse
    An endpoint specifying where Web PubSub should send events to.
    filter EventNameFilterResponse
    A base class for event filter which determines whether an event should be sent to an event listener.
    endpoint EventHubEndpointResponse
    An endpoint specifying where Web PubSub should send events to.
    filter EventNameFilterResponse
    A base class for event filter which determines whether an event should be sent to an event listener.
    endpoint EventHubEndpointResponse
    An endpoint specifying where Web PubSub should send events to.
    filter EventNameFilterResponse
    A base class for event filter which determines whether an event should be sent to an event listener.
    endpoint Property Map
    An endpoint specifying where Web PubSub should send events to.
    filter Property Map
    A base class for event filter which determines whether an event should be sent to an event listener.

    EventNameFilterResponse

    SystemEvents List<string>
    Gets or sets a list of system events. Supported events: "connected" and "disconnected". Blocking event "connect" is not supported because it requires a response.
    UserEventPattern string
    Gets or sets a matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches events "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1"
    SystemEvents []string
    Gets or sets a list of system events. Supported events: "connected" and "disconnected". Blocking event "connect" is not supported because it requires a response.
    UserEventPattern string
    Gets or sets a matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches events "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1"
    systemEvents List<String>
    Gets or sets a list of system events. Supported events: "connected" and "disconnected". Blocking event "connect" is not supported because it requires a response.
    userEventPattern String
    Gets or sets a matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches events "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1"
    systemEvents string[]
    Gets or sets a list of system events. Supported events: "connected" and "disconnected". Blocking event "connect" is not supported because it requires a response.
    userEventPattern string
    Gets or sets a matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches events "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1"
    system_events Sequence[str]
    Gets or sets a list of system events. Supported events: "connected" and "disconnected". Blocking event "connect" is not supported because it requires a response.
    user_event_pattern str
    Gets or sets a matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches events "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1"
    systemEvents List<String>
    Gets or sets a list of system events. Supported events: "connected" and "disconnected". Blocking event "connect" is not supported because it requires a response.
    userEventPattern String
    Gets or sets a matching pattern for event names. There are 3 kinds of patterns supported: 1. "*", it matches any event name 2. Combine multiple events with ",", for example "event1,event2", it matches events "event1" and "event2" 3. A single event name, for example, "event1", it matches "event1"

    ManagedIdentitySettingsResponse

    Resource string
    The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token.
    Resource string
    The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token.
    resource String
    The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token.
    resource string
    The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token.
    resource str
    The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token.
    resource String
    The Resource indicating the App ID URI of the target resource. It also appears in the aud (audience) claim of the issued token.

    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.

    UpstreamAuthSettingsResponse

    ManagedIdentity Pulumi.AzureNative.WebPubSub.Inputs.ManagedIdentitySettingsResponse
    Managed identity settings for upstream.
    Type string
    Upstream auth type enum.
    ManagedIdentity ManagedIdentitySettingsResponse
    Managed identity settings for upstream.
    Type string
    Upstream auth type enum.
    managedIdentity ManagedIdentitySettingsResponse
    Managed identity settings for upstream.
    type String
    Upstream auth type enum.
    managedIdentity ManagedIdentitySettingsResponse
    Managed identity settings for upstream.
    type string
    Upstream auth type enum.
    managed_identity ManagedIdentitySettingsResponse
    Managed identity settings for upstream.
    type str
    Upstream auth type enum.
    managedIdentity Property Map
    Managed identity settings for upstream.
    type String
    Upstream auth type enum.

    WebPubSubHubPropertiesResponse

    AnonymousConnectPolicy string
    The settings for configuring if anonymous connections are allowed for this hub: "allow" or "deny". Default to "deny".
    EventHandlers List<Pulumi.AzureNative.WebPubSub.Inputs.EventHandlerResponse>
    Event handler of a hub.
    EventListeners List<Pulumi.AzureNative.WebPubSub.Inputs.EventListenerResponse>
    Event listener settings for forwarding your client events to listeners. Event listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients. One event can be sent to multiple listeners, as long as it matches the filters in those listeners. The order of the array elements doesn't matter. Maximum count of event listeners among all hubs is 10.
    AnonymousConnectPolicy string
    The settings for configuring if anonymous connections are allowed for this hub: "allow" or "deny". Default to "deny".
    EventHandlers []EventHandlerResponse
    Event handler of a hub.
    EventListeners []EventListenerResponse
    Event listener settings for forwarding your client events to listeners. Event listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients. One event can be sent to multiple listeners, as long as it matches the filters in those listeners. The order of the array elements doesn't matter. Maximum count of event listeners among all hubs is 10.
    anonymousConnectPolicy String
    The settings for configuring if anonymous connections are allowed for this hub: "allow" or "deny". Default to "deny".
    eventHandlers List<EventHandlerResponse>
    Event handler of a hub.
    eventListeners List<EventListenerResponse>
    Event listener settings for forwarding your client events to listeners. Event listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients. One event can be sent to multiple listeners, as long as it matches the filters in those listeners. The order of the array elements doesn't matter. Maximum count of event listeners among all hubs is 10.
    anonymousConnectPolicy string
    The settings for configuring if anonymous connections are allowed for this hub: "allow" or "deny". Default to "deny".
    eventHandlers EventHandlerResponse[]
    Event handler of a hub.
    eventListeners EventListenerResponse[]
    Event listener settings for forwarding your client events to listeners. Event listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients. One event can be sent to multiple listeners, as long as it matches the filters in those listeners. The order of the array elements doesn't matter. Maximum count of event listeners among all hubs is 10.
    anonymous_connect_policy str
    The settings for configuring if anonymous connections are allowed for this hub: "allow" or "deny". Default to "deny".
    event_handlers Sequence[EventHandlerResponse]
    Event handler of a hub.
    event_listeners Sequence[EventListenerResponse]
    Event listener settings for forwarding your client events to listeners. Event listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients. One event can be sent to multiple listeners, as long as it matches the filters in those listeners. The order of the array elements doesn't matter. Maximum count of event listeners among all hubs is 10.
    anonymousConnectPolicy String
    The settings for configuring if anonymous connections are allowed for this hub: "allow" or "deny". Default to "deny".
    eventHandlers List<Property Map>
    Event handler of a hub.
    eventListeners List<Property Map>
    Event listener settings for forwarding your client events to listeners. Event listener is transparent to Web PubSub clients, and it doesn't return any result to clients nor interrupt the lifetime of clients. One event can be sent to multiple listeners, as long as it matches the filters in those listeners. The order of the array elements doesn't matter. Maximum count of event listeners among all hubs is 10.

    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 v1 docs if using the v1 version of this package.
    Azure Native v2.38.0 published on Monday, Apr 22, 2024 by Pulumi
    pulumi/pulumi-azure-native