Azure Native v2.89.1, Mar 2 25

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.89.1 published on Sunday, Mar 2, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.webpubsub.getWebPubSub

Explore with Pulumi AI

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.89.1 published on Sunday, Mar 2, 2025 by Pulumi

pulumi/pulumi-azure-native

Using getWebPubSub

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 getWebPubSub(args: GetWebPubSubArgs, opts?: InvokeOptions): Promise<GetWebPubSubResult>
function getWebPubSubOutput(args: GetWebPubSubOutputArgs, opts?: InvokeOptions): Output<GetWebPubSubResult>

def get_web_pub_sub(resource_group_name: Optional[str] = None,
                    resource_name: Optional[str] = None,
                    opts: Optional[InvokeOptions] = None) -> GetWebPubSubResult
def get_web_pub_sub_output(resource_group_name: Optional[pulumi.Input[str]] = None,
                    resource_name: Optional[pulumi.Input[str]] = None,
                    opts: Optional[InvokeOptions] = None) -> Output[GetWebPubSubResult]

func LookupWebPubSub(ctx *Context, args *LookupWebPubSubArgs, opts ...InvokeOption) (*LookupWebPubSubResult, error)
func LookupWebPubSubOutput(ctx *Context, args *LookupWebPubSubOutputArgs, opts ...InvokeOption) LookupWebPubSubResultOutput

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

public static class GetWebPubSub 
{
    public static Task<GetWebPubSubResult> InvokeAsync(GetWebPubSubArgs args, InvokeOptions? opts = null)
    public static Output<GetWebPubSubResult> Invoke(GetWebPubSubInvokeArgs args, InvokeOptions? opts = null)
}

public static CompletableFuture<GetWebPubSubResult> getWebPubSub(GetWebPubSubArgs args, InvokeOptions options)
public static Output<GetWebPubSubResult> getWebPubSub(GetWebPubSubArgs args, InvokeOptions options)

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

The following arguments are supported:

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.

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.

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.

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.

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.

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.

getWebPubSub Result

The following output properties are available:

ExternalIP string: The publicly accessible IP of the resource.
HostName string: FQDN of the service instance.
HostNamePrefix string: Deprecated.
Id string: Fully qualified resource Id for the resource.
Name string: The name of the resource.
PrivateEndpointConnections List<Pulumi.AzureNative.WebPubSub.Outputs.PrivateEndpointConnectionResponse>: Private endpoint connections to the resource.
ProvisioningState string: Provisioning state of the resource.
PublicPort int: The publicly accessible port of the resource which is designed for browser/client side usage.
ServerPort int: The publicly accessible port of the resource which is designed for customer server side usage.
SharedPrivateLinkResources List<Pulumi.AzureNative.WebPubSub.Outputs.SharedPrivateLinkResourceResponse>: The list of shared private link resources.
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"
Version string: Version of the resource. Probably you need the same or higher version of client SDKs.
DisableAadAuth bool: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work.
DisableLocalAuth bool: DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work.
Identity Pulumi.AzureNative.WebPubSub.Outputs.ManagedIdentityResponse: A class represent managed identities used for request and response
LiveTraceConfiguration Pulumi.AzureNative.WebPubSub.Outputs.LiveTraceConfigurationResponse: Live trace configuration of a Microsoft.SignalRService resource.
Location string: The GEO location of the resource. e.g. West US | East US | North Central US | South Central US.
NetworkACLs Pulumi.AzureNative.WebPubSub.Outputs.WebPubSubNetworkACLsResponse: Network ACLs for the resource
PublicNetworkAccess string: Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs.
ResourceLogConfiguration Pulumi.AzureNative.WebPubSub.Outputs.ResourceLogConfigurationResponse: Resource log configuration of a Microsoft.SignalRService resource.
Sku Pulumi.AzureNative.WebPubSub.Outputs.ResourceSkuResponse: The billing information of the resource.
Tags Dictionary<string, string>: Tags of the service which is a list of key value pairs that describe the resource.
Tls Pulumi.AzureNative.WebPubSub.Outputs.WebPubSubTlsSettingsResponse: TLS settings for the resource

ExternalIP string: The publicly accessible IP of the resource.
HostName string: FQDN of the service instance.
HostNamePrefix string: Deprecated.
Id string: Fully qualified resource Id for the resource.
Name string: The name of the resource.
PrivateEndpointConnections []PrivateEndpointConnectionResponse: Private endpoint connections to the resource.
ProvisioningState string: Provisioning state of the resource.
PublicPort int: The publicly accessible port of the resource which is designed for browser/client side usage.
ServerPort int: The publicly accessible port of the resource which is designed for customer server side usage.
SharedPrivateLinkResources []SharedPrivateLinkResourceResponse: The list of shared private link resources.
SystemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
Type string: The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
Version string: Version of the resource. Probably you need the same or higher version of client SDKs.
DisableAadAuth bool: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work.
DisableLocalAuth bool: DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work.
Identity ManagedIdentityResponse: A class represent managed identities used for request and response
LiveTraceConfiguration LiveTraceConfigurationResponse: Live trace configuration of a Microsoft.SignalRService resource.
Location string: The GEO location of the resource. e.g. West US | East US | North Central US | South Central US.
NetworkACLs WebPubSubNetworkACLsResponse: Network ACLs for the resource
PublicNetworkAccess string: Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs.
ResourceLogConfiguration ResourceLogConfigurationResponse: Resource log configuration of a Microsoft.SignalRService resource.
Sku ResourceSkuResponse: The billing information of the resource.
Tags map[string]string: Tags of the service which is a list of key value pairs that describe the resource.
Tls WebPubSubTlsSettingsResponse: TLS settings for the resource

externalIP String: The publicly accessible IP of the resource.
hostName String: FQDN of the service instance.
hostNamePrefix String: Deprecated.
id String: Fully qualified resource Id for the resource.
name String: The name of the resource.
privateEndpointConnections List<PrivateEndpointConnectionResponse>: Private endpoint connections to the resource.
provisioningState String: Provisioning state of the resource.
publicPort Integer: The publicly accessible port of the resource which is designed for browser/client side usage.
serverPort Integer: The publicly accessible port of the resource which is designed for customer server side usage.
sharedPrivateLinkResources List<SharedPrivateLinkResourceResponse>: The list of shared private link resources.
systemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
type String: The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
version String: Version of the resource. Probably you need the same or higher version of client SDKs.
disableAadAuth Boolean: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work.
disableLocalAuth Boolean: DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work.
identity ManagedIdentityResponse: A class represent managed identities used for request and response
liveTraceConfiguration LiveTraceConfigurationResponse: Live trace configuration of a Microsoft.SignalRService resource.
location String: The GEO location of the resource. e.g. West US | East US | North Central US | South Central US.
networkACLs WebPubSubNetworkACLsResponse: Network ACLs for the resource
publicNetworkAccess String: Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs.
resourceLogConfiguration ResourceLogConfigurationResponse: Resource log configuration of a Microsoft.SignalRService resource.
sku ResourceSkuResponse: The billing information of the resource.
tags Map<String,String>: Tags of the service which is a list of key value pairs that describe the resource.
tls WebPubSubTlsSettingsResponse: TLS settings for the resource

externalIP string: The publicly accessible IP of the resource.
hostName string: FQDN of the service instance.
hostNamePrefix string: Deprecated.
id string: Fully qualified resource Id for the resource.
name string: The name of the resource.
privateEndpointConnections PrivateEndpointConnectionResponse[]: Private endpoint connections to the resource.
provisioningState string: Provisioning state of the resource.
publicPort number: The publicly accessible port of the resource which is designed for browser/client side usage.
serverPort number: The publicly accessible port of the resource which is designed for customer server side usage.
sharedPrivateLinkResources SharedPrivateLinkResourceResponse[]: The list of shared private link resources.
systemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
type string: The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
version string: Version of the resource. Probably you need the same or higher version of client SDKs.
disableAadAuth boolean: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work.
disableLocalAuth boolean: DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work.
identity ManagedIdentityResponse: A class represent managed identities used for request and response
liveTraceConfiguration LiveTraceConfigurationResponse: Live trace configuration of a Microsoft.SignalRService resource.
location string: The GEO location of the resource. e.g. West US | East US | North Central US | South Central US.
networkACLs WebPubSubNetworkACLsResponse: Network ACLs for the resource
publicNetworkAccess string: Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs.
resourceLogConfiguration ResourceLogConfigurationResponse: Resource log configuration of a Microsoft.SignalRService resource.
sku ResourceSkuResponse: The billing information of the resource.
tags {[key: string]: string}: Tags of the service which is a list of key value pairs that describe the resource.
tls WebPubSubTlsSettingsResponse: TLS settings for the resource

external_ip str: The publicly accessible IP of the resource.
host_name str: FQDN of the service instance.
host_name_prefix str: Deprecated.
id str: Fully qualified resource Id for the resource.
name str: The name of the resource.
private_endpoint_connections Sequence[PrivateEndpointConnectionResponse]: Private endpoint connections to the resource.
provisioning_state str: Provisioning state of the resource.
public_port int: The publicly accessible port of the resource which is designed for browser/client side usage.
server_port int: The publicly accessible port of the resource which is designed for customer server side usage.
shared_private_link_resources Sequence[SharedPrivateLinkResourceResponse]: The list of shared private link resources.
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"
version str: Version of the resource. Probably you need the same or higher version of client SDKs.
disable_aad_auth bool: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work.
disable_local_auth bool: DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work.
identity ManagedIdentityResponse: A class represent managed identities used for request and response
live_trace_configuration LiveTraceConfigurationResponse: Live trace configuration of a Microsoft.SignalRService resource.
location str: The GEO location of the resource. e.g. West US | East US | North Central US | South Central US.
network_acls WebPubSubNetworkACLsResponse: Network ACLs for the resource
public_network_access str: Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs.
resource_log_configuration ResourceLogConfigurationResponse: Resource log configuration of a Microsoft.SignalRService resource.
sku ResourceSkuResponse: The billing information of the resource.
tags Mapping[str, str]: Tags of the service which is a list of key value pairs that describe the resource.
tls WebPubSubTlsSettingsResponse: TLS settings for the resource

externalIP String: The publicly accessible IP of the resource.
hostName String: FQDN of the service instance.
hostNamePrefix String: Deprecated.
id String: Fully qualified resource Id for the resource.
name String: The name of the resource.
privateEndpointConnections List<Property Map>: Private endpoint connections to the resource.
provisioningState String: Provisioning state of the resource.
publicPort Number: The publicly accessible port of the resource which is designed for browser/client side usage.
serverPort Number: The publicly accessible port of the resource which is designed for customer server side usage.
sharedPrivateLinkResources List<Property Map>: The list of shared private link resources.
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"
version String: Version of the resource. Probably you need the same or higher version of client SDKs.
disableAadAuth Boolean: DisableLocalAuth Enable or disable aad auth When set as true, connection with AuthType=aad won't work.
disableLocalAuth Boolean: DisableLocalAuth Enable or disable local auth with AccessKey When set as true, connection with AccessKey=xxx won't work.
identity Property Map: A class represent managed identities used for request and response
liveTraceConfiguration Property Map: Live trace configuration of a Microsoft.SignalRService resource.
location String: The GEO location of the resource. e.g. West US | East US | North Central US | South Central US.
networkACLs Property Map: Network ACLs for the resource
publicNetworkAccess String: Enable or disable public network access. Default to "Enabled". When it's Enabled, network ACLs still apply. When it's Disabled, public network access is always disabled no matter what you set in network ACLs.
resourceLogConfiguration Property Map: Resource log configuration of a Microsoft.SignalRService resource.
sku Property Map: The billing information of the resource.
tags Map<String>: Tags of the service which is a list of key value pairs that describe the resource.
tls Property Map: TLS settings for the resource

Supporting Types

LiveTraceCategoryResponse

Enabled string: Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive.
Name string: Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive.

Enabled string: Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive.
Name string: Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive.

enabled String: Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive.
name String: Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive.

enabled string: Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive.
name string: Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive.

enabled str: Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive.
name str: Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive.

enabled String: Indicates whether or the live trace category is enabled. Available values: true, false. Case insensitive.
name String: Gets or sets the live trace category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive.

LiveTraceConfigurationResponse

Categories List<Pulumi.AzureNative.WebPubSub.Inputs.LiveTraceCategoryResponse>: Gets or sets the list of category configurations.
Enabled string: Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive.

Categories []LiveTraceCategoryResponse: Gets or sets the list of category configurations.
Enabled string: Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive.

categories List<LiveTraceCategoryResponse>: Gets or sets the list of category configurations.
enabled String: Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive.

categories LiveTraceCategoryResponse[]: Gets or sets the list of category configurations.
enabled string: Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive.

categories Sequence[LiveTraceCategoryResponse]: Gets or sets the list of category configurations.
enabled str: Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive.

categories List<Property Map>: Gets or sets the list of category configurations.
enabled String: Indicates whether or not enable live trace. When it's set to true, live trace client can connect to the service. Otherwise, live trace client can't connect to the service, so that you are unable to receive any log, no matter what you configure in "categories". Available values: true, false. Case insensitive.

ManagedIdentityResponse

PrincipalId string: Get the principal id for the system assigned identity. Only be used in response.
TenantId string: Get the tenant id for the system assigned identity. Only be used in response
Type string: Represents the identity type: systemAssigned, userAssigned, None
UserAssignedIdentities Dictionary<string, Pulumi.AzureNative.WebPubSub.Inputs.UserAssignedIdentityPropertyResponse>: Get or set the user assigned identities

PrincipalId string: Get the principal id for the system assigned identity. Only be used in response.
TenantId string: Get the tenant id for the system assigned identity. Only be used in response
Type string: Represents the identity type: systemAssigned, userAssigned, None
UserAssignedIdentities map[string]UserAssignedIdentityPropertyResponse: Get or set the user assigned identities

principalId String: Get the principal id for the system assigned identity. Only be used in response.
tenantId String: Get the tenant id for the system assigned identity. Only be used in response
type String: Represents the identity type: systemAssigned, userAssigned, None
userAssignedIdentities Map<String,UserAssignedIdentityPropertyResponse>: Get or set the user assigned identities

principalId string: Get the principal id for the system assigned identity. Only be used in response.
tenantId string: Get the tenant id for the system assigned identity. Only be used in response
type string: Represents the identity type: systemAssigned, userAssigned, None
userAssignedIdentities {[key: string]: UserAssignedIdentityPropertyResponse}: Get or set the user assigned identities

principal_id str: Get the principal id for the system assigned identity. Only be used in response.
tenant_id str: Get the tenant id for the system assigned identity. Only be used in response
type str: Represents the identity type: systemAssigned, userAssigned, None
user_assigned_identities Mapping[str, UserAssignedIdentityPropertyResponse]: Get or set the user assigned identities

principalId String: Get the principal id for the system assigned identity. Only be used in response.
tenantId String: Get the tenant id for the system assigned identity. Only be used in response
type String: Represents the identity type: systemAssigned, userAssigned, None
userAssignedIdentities Map<Property Map>: Get or set the user assigned identities

NetworkACLResponse

Allow List<string>: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
Deny List<string>: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

Allow []string: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
Deny []string: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

allow List<String>: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
deny List<String>: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

allow string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
deny string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

allow Sequence[str]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
deny Sequence[str]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

allow List<String>: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
deny List<String>: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

PrivateEndpointACLResponse

Name string: Name of the private endpoint connection
Allow List<string>: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
Deny List<string>: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

Name string: Name of the private endpoint connection
Allow []string: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
Deny []string: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

name String: Name of the private endpoint connection
allow List<String>: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
deny List<String>: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

name string: Name of the private endpoint connection
allow string[]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
deny string[]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

name str: Name of the private endpoint connection
allow Sequence[str]: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
deny Sequence[str]: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

name String: Name of the private endpoint connection
allow List<String>: Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.
deny List<String>: Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.

PrivateEndpointConnectionResponse

GroupIds List<string>: Group IDs
Id string: Fully qualified resource Id for the resource.
Name string: The name of the resource.
ProvisioningState string: Provisioning state of the resource.
SystemData Pulumi.AzureNative.WebPubSub.Inputs.SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
Type string: The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
PrivateEndpoint Pulumi.AzureNative.WebPubSub.Inputs.PrivateEndpointResponse: Private endpoint
PrivateLinkServiceConnectionState Pulumi.AzureNative.WebPubSub.Inputs.PrivateLinkServiceConnectionStateResponse: Connection state of the private endpoint connection

GroupIds []string: Group IDs
Id string: Fully qualified resource Id for the resource.
Name string: The name of the resource.
ProvisioningState string: Provisioning state of the resource.
SystemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
Type string: The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
PrivateEndpoint PrivateEndpointResponse: Private endpoint
PrivateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse: Connection state of the private endpoint connection

groupIds List<String>: Group IDs
id String: Fully qualified resource Id for the resource.
name String: The name of the resource.
provisioningState String: Provisioning state of the resource.
systemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
type String: The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
privateEndpoint PrivateEndpointResponse: Private endpoint
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse: Connection state of the private endpoint connection

groupIds string[]: Group IDs
id string: Fully qualified resource Id for the resource.
name string: The name of the resource.
provisioningState string: Provisioning state of the resource.
systemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
type string: The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
privateEndpoint PrivateEndpointResponse: Private endpoint
privateLinkServiceConnectionState PrivateLinkServiceConnectionStateResponse: Connection state of the private endpoint connection

group_ids Sequence[str]: Group IDs
id str: Fully qualified resource Id for the resource.
name str: The name of the resource.
provisioning_state str: Provisioning state of the resource.
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"
private_endpoint PrivateEndpointResponse: Private endpoint
private_link_service_connection_state PrivateLinkServiceConnectionStateResponse: Connection state of the private endpoint connection

groupIds List<String>: Group IDs
id String: Fully qualified resource Id for the resource.
name String: The name of the resource.
provisioningState String: Provisioning state of the resource.
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"
privateEndpoint Property Map: Private endpoint
privateLinkServiceConnectionState Property Map: Connection state of the private endpoint connection

PrivateEndpointResponse

Id string: Full qualified Id of the private endpoint

Id string: Full qualified Id of the private endpoint

id String: Full qualified Id of the private endpoint

id string: Full qualified Id of the private endpoint

id str: Full qualified Id of the private endpoint

id String: Full qualified Id of the private endpoint

PrivateLinkServiceConnectionStateResponse

ActionsRequired string: A message indicating if changes on the service provider require any updates on the consumer.
Description string: The reason for approval/rejection of the connection.
Status string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

ActionsRequired string: A message indicating if changes on the service provider require any updates on the consumer.
Description string: The reason for approval/rejection of the connection.
Status string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

actionsRequired String: A message indicating if changes on the service provider require any updates on the consumer.
description String: The reason for approval/rejection of the connection.
status String: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

actionsRequired string: A message indicating if changes on the service provider require any updates on the consumer.
description string: The reason for approval/rejection of the connection.
status string: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

actions_required str: A message indicating if changes on the service provider require any updates on the consumer.
description str: The reason for approval/rejection of the connection.
status str: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

actionsRequired String: A message indicating if changes on the service provider require any updates on the consumer.
description String: The reason for approval/rejection of the connection.
status String: Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.

ResourceLogCategoryResponse

Enabled string: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive.
Name string: Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive.

Enabled string: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive.
Name string: Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive.

enabled String: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive.
name String: Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive.

enabled string: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive.
name string: Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive.

enabled str: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive.
name str: Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive.

enabled String: Indicates whether or the resource log category is enabled. Available values: true, false. Case insensitive.
name String: Gets or sets the resource log category's name. Available values: ConnectivityLogs, MessagingLogs. Case insensitive.

ResourceLogConfigurationResponse

Categories List<Pulumi.AzureNative.WebPubSub.Inputs.ResourceLogCategoryResponse>: Gets or sets the list of category configurations.

Categories []ResourceLogCategoryResponse: Gets or sets the list of category configurations.

categories List<ResourceLogCategoryResponse>: Gets or sets the list of category configurations.

categories ResourceLogCategoryResponse[]: Gets or sets the list of category configurations.

categories Sequence[ResourceLogCategoryResponse]: Gets or sets the list of category configurations.

categories List<Property Map>: Gets or sets the list of category configurations.

ResourceSkuResponse

Family string

Not used. Retained for future use.

Name string

The name of the SKU. Required.

Allowed values: Standard_S1, Free_F1, Premium_P1

Size string

Not used. Retained for future use.

Capacity int

Optional, integer. The unit count of the resource. 1 by default.

If present, following values are allowed: Free: 1; Standard: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;

Tier string

Optional tier of this particular SKU. 'Standard' or 'Free'.

Basic is deprecated, use Standard instead.

Family string

Not used. Retained for future use.

Name string

The name of the SKU. Required.

Allowed values: Standard_S1, Free_F1, Premium_P1

Size string

Not used. Retained for future use.

Capacity int

Optional, integer. The unit count of the resource. 1 by default.

If present, following values are allowed: Free: 1; Standard: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;

Tier string

Optional tier of this particular SKU. 'Standard' or 'Free'.

Basic is deprecated, use Standard instead.

family String

Not used. Retained for future use.

name String

The name of the SKU. Required.

Allowed values: Standard_S1, Free_F1, Premium_P1

size String

Not used. Retained for future use.

capacity Integer

Optional, integer. The unit count of the resource. 1 by default.

If present, following values are allowed: Free: 1; Standard: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;

tier String

Optional tier of this particular SKU. 'Standard' or 'Free'.

Basic is deprecated, use Standard instead.

family string

Not used. Retained for future use.

name string

The name of the SKU. Required.

Allowed values: Standard_S1, Free_F1, Premium_P1

size string

Not used. Retained for future use.

capacity number

Optional, integer. The unit count of the resource. 1 by default.

If present, following values are allowed: Free: 1; Standard: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;

tier string

Optional tier of this particular SKU. 'Standard' or 'Free'.

Basic is deprecated, use Standard instead.

family str

Not used. Retained for future use.

name str

The name of the SKU. Required.

Allowed values: Standard_S1, Free_F1, Premium_P1

size str

Not used. Retained for future use.

capacity int

Optional, integer. The unit count of the resource. 1 by default.

If present, following values are allowed: Free: 1; Standard: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;

tier str

Optional tier of this particular SKU. 'Standard' or 'Free'.

Basic is deprecated, use Standard instead.

family String

Not used. Retained for future use.

name String

The name of the SKU. Required.

Allowed values: Standard_S1, Free_F1, Premium_P1

size String

Not used. Retained for future use.

capacity Number

Optional, integer. The unit count of the resource. 1 by default.

If present, following values are allowed: Free: 1; Standard: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100; Premium: 1,2,3,4,5,6,7,8,9,10,20,30,40,50,60,70,80,90,100;

tier String

Optional tier of this particular SKU. 'Standard' or 'Free'.

Basic is deprecated, use Standard instead.

SharedPrivateLinkResourceResponse

GroupId string: The group id from the provider of resource the shared private link resource is for
Id string: Fully qualified resource Id for the resource.
Name string: The name of the resource.
PrivateLinkResourceId string: The resource id of the resource the shared private link resource is for
ProvisioningState string: Provisioning state of the resource.
Status string: Status of the shared private link resource
SystemData Pulumi.AzureNative.WebPubSub.Inputs.SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
Type string: The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
RequestMessage string: The request message for requesting approval of the shared private link resource

GroupId string: The group id from the provider of resource the shared private link resource is for
Id string: Fully qualified resource Id for the resource.
Name string: The name of the resource.
PrivateLinkResourceId string: The resource id of the resource the shared private link resource is for
ProvisioningState string: Provisioning state of the resource.
Status string: Status of the shared private link resource
SystemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
Type string: The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
RequestMessage string: The request message for requesting approval of the shared private link resource

groupId String: The group id from the provider of resource the shared private link resource is for
id String: Fully qualified resource Id for the resource.
name String: The name of the resource.
privateLinkResourceId String: The resource id of the resource the shared private link resource is for
provisioningState String: Provisioning state of the resource.
status String: Status of the shared private link resource
systemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
type String: The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
requestMessage String: The request message for requesting approval of the shared private link resource

groupId string: The group id from the provider of resource the shared private link resource is for
id string: Fully qualified resource Id for the resource.
name string: The name of the resource.
privateLinkResourceId string: The resource id of the resource the shared private link resource is for
provisioningState string: Provisioning state of the resource.
status string: Status of the shared private link resource
systemData SystemDataResponse: Metadata pertaining to creation and last modification of the resource.
type string: The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
requestMessage string: The request message for requesting approval of the shared private link resource

group_id str: The group id from the provider of resource the shared private link resource is for
id str: Fully qualified resource Id for the resource.
name str: The name of the resource.
private_link_resource_id str: The resource id of the resource the shared private link resource is for
provisioning_state str: Provisioning state of the resource.
status str: Status of the shared private link resource
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"
request_message str: The request message for requesting approval of the shared private link resource

groupId String: The group id from the provider of resource the shared private link resource is for
id String: Fully qualified resource Id for the resource.
name String: The name of the resource.
privateLinkResourceId String: The resource id of the resource the shared private link resource is for
provisioningState String: Provisioning state of the resource.
status String: Status of the shared private link resource
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"
requestMessage String: The request message for requesting approval of the shared private link resource

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.

UserAssignedIdentityPropertyResponse

ClientId string: Get the client id for the user assigned identity
PrincipalId string: Get the principal id for the user assigned identity

ClientId string: Get the client id for the user assigned identity
PrincipalId string: Get the principal id for the user assigned identity

clientId String: Get the client id for the user assigned identity
principalId String: Get the principal id for the user assigned identity

clientId string: Get the client id for the user assigned identity
principalId string: Get the principal id for the user assigned identity

client_id str: Get the client id for the user assigned identity
principal_id str: Get the principal id for the user assigned identity

clientId String: Get the client id for the user assigned identity
principalId String: Get the principal id for the user assigned identity

WebPubSubNetworkACLsResponse

DefaultAction string: Azure Networking ACL Action.
PrivateEndpoints List<Pulumi.AzureNative.WebPubSub.Inputs.PrivateEndpointACLResponse>: ACLs for requests from private endpoints
PublicNetwork Pulumi.AzureNative.WebPubSub.Inputs.NetworkACLResponse: Network ACL

DefaultAction string: Azure Networking ACL Action.
PrivateEndpoints []PrivateEndpointACLResponse: ACLs for requests from private endpoints
PublicNetwork NetworkACLResponse: Network ACL

defaultAction String: Azure Networking ACL Action.
privateEndpoints List<PrivateEndpointACLResponse>: ACLs for requests from private endpoints
publicNetwork NetworkACLResponse: Network ACL

defaultAction string: Azure Networking ACL Action.
privateEndpoints PrivateEndpointACLResponse[]: ACLs for requests from private endpoints
publicNetwork NetworkACLResponse: Network ACL

default_action str: Azure Networking ACL Action.
private_endpoints Sequence[PrivateEndpointACLResponse]: ACLs for requests from private endpoints
public_network NetworkACLResponse: Network ACL

defaultAction String: Azure Networking ACL Action.
privateEndpoints List<Property Map>: ACLs for requests from private endpoints
publicNetwork Property Map: Network ACL

WebPubSubTlsSettingsResponse

ClientCertEnabled bool: Request client certificate during TLS handshake if enabled

ClientCertEnabled bool: Request client certificate during TLS handshake if enabled

clientCertEnabled Boolean: Request client certificate during TLS handshake if enabled

clientCertEnabled boolean: Request client certificate during TLS handshake if enabled

client_cert_enabled bool: Request client certificate during TLS handshake if enabled

clientCertEnabled Boolean: Request client certificate during TLS handshake if enabled

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0

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.89.1 published on Sunday, Mar 2, 2025 by Pulumi

pulumi/pulumi-azure-native

azure-native.webpubsub.getWebPubSub

On this page

On this page

Using getWebPubSub

getWebPubSub Result

Supporting Types

LiveTraceCategoryResponse

LiveTraceConfigurationResponse

ManagedIdentityResponse

NetworkACLResponse

PrivateEndpointACLResponse

PrivateEndpointConnectionResponse

PrivateEndpointResponse

PrivateLinkServiceConnectionStateResponse

ResourceLogCategoryResponse

ResourceLogConfigurationResponse

ResourceSkuResponse

SharedPrivateLinkResourceResponse

SystemDataResponse

UserAssignedIdentityPropertyResponse

WebPubSubNetworkACLsResponse

WebPubSubTlsSettingsResponse

Package Details

On this page

On this page