Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v2
  3. API Docs
  4. webpubsub
  5. getWebPubSubCustomDomain
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native-v2.webpubsub.getWebPubSubCustomDomain

Explore with Pulumi AI

These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native

Get a custom domain. 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, 2024-03-01, 2024-04-01-preview, 2024-08-01-preview, 2024-10-01-preview.

Using getWebPubSubCustomDomain

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 getWebPubSubCustomDomain(args: GetWebPubSubCustomDomainArgs, opts?: InvokeOptions): Promise<GetWebPubSubCustomDomainResult>
function getWebPubSubCustomDomainOutput(args: GetWebPubSubCustomDomainOutputArgs, opts?: InvokeOptions): Output<GetWebPubSubCustomDomainResult>
Copy
def get_web_pub_sub_custom_domain(name: Optional[str] = None,
                                  resource_group_name: Optional[str] = None,
                                  resource_name: Optional[str] = None,
                                  opts: Optional[InvokeOptions] = None) -> GetWebPubSubCustomDomainResult
def get_web_pub_sub_custom_domain_output(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[GetWebPubSubCustomDomainResult]
Copy
func LookupWebPubSubCustomDomain(ctx *Context, args *LookupWebPubSubCustomDomainArgs, opts ...InvokeOption) (*LookupWebPubSubCustomDomainResult, error)
func LookupWebPubSubCustomDomainOutput(ctx *Context, args *LookupWebPubSubCustomDomainOutputArgs, opts ...InvokeOption) LookupWebPubSubCustomDomainResultOutput
Copy

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

public static class GetWebPubSubCustomDomain 
{
    public static Task<GetWebPubSubCustomDomainResult> InvokeAsync(GetWebPubSubCustomDomainArgs args, InvokeOptions? opts = null)
    public static Output<GetWebPubSubCustomDomainResult> Invoke(GetWebPubSubCustomDomainInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetWebPubSubCustomDomainResult> getWebPubSubCustomDomain(GetWebPubSubCustomDomainArgs args, InvokeOptions options)
public static Output<GetWebPubSubCustomDomainResult> getWebPubSubCustomDomain(GetWebPubSubCustomDomainArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:webpubsub:getWebPubSubCustomDomain
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

Name
This property is required.
Changes to this property will trigger replacement.
string
Custom domain name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource.
Name
This property is required.
Changes to this property will trigger replacement.
string
Custom domain name.
ResourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource.
name
This property is required.
Changes to this property will trigger replacement.
String
Custom domain name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource.
name
This property is required.
Changes to this property will trigger replacement.
string
Custom domain name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
string
The name of the resource.
name
This property is required.
Changes to this property will trigger replacement.
str
Custom domain name.
resource_group_name
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
str
The name of the resource.
name
This property is required.
Changes to this property will trigger replacement.
String
Custom domain name.
resourceGroupName
This property is required.
Changes to this property will trigger replacement.
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
This property is required.
Changes to this property will trigger replacement.
String
The name of the resource.

getWebPubSubCustomDomain Result

The following output properties are available:

CustomCertificate Pulumi.AzureNative.WebPubSub.Outputs.ResourceReferenceResponse
Reference to a resource.
DomainName string
The custom domain name.
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.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource - e.g. "Microsoft.SignalRService/SignalR"
CustomCertificate ResourceReferenceResponse
Reference to a resource.
DomainName string
The custom domain name.
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"
customCertificate ResourceReferenceResponse
Reference to a resource.
domainName String
The custom domain name.
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"
customCertificate ResourceReferenceResponse
Reference to a resource.
domainName string
The custom domain name.
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"
custom_certificate ResourceReferenceResponse
Reference to a resource.
domain_name str
The custom domain name.
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"
customCertificate Property Map
Reference to a resource.
domainName String
The custom domain name.
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"

Supporting Types

ResourceReferenceResponse

Id string
Resource ID.
Id string
Resource ID.
id String
Resource ID.
id string
Resource ID.
id str
Resource ID.
id String
Resource ID.

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-v2 pulumi/pulumi-azure-native
License
Apache-2.0
These are the docs for Azure Native v2. We recommenend using the latest version, Azure Native v3.
Azure Native v2 v2.90.0 published on Thursday, Mar 27, 2025 by Pulumi
pulumi/pulumi-azure-native