Docs Home Pulumi IaC Pulumi ESC Pulumi Insights Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. appplatform
  5. getCustomDomain
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.appplatform.getCustomDomain

Explore with Pulumi AI

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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native

Get the custom domain of one lifecycle application.

Uses Azure REST API version 2024-01-01-preview.

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

Using getCustomDomain

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 getCustomDomain(args: GetCustomDomainArgs, opts?: InvokeOptions): Promise<GetCustomDomainResult>
function getCustomDomainOutput(args: GetCustomDomainOutputArgs, opts?: InvokeOptions): Output<GetCustomDomainResult>
Copy
def get_custom_domain(app_name: Optional[str] = None,
                      domain_name: Optional[str] = None,
                      resource_group_name: Optional[str] = None,
                      service_name: Optional[str] = None,
                      opts: Optional[InvokeOptions] = None) -> GetCustomDomainResult
def get_custom_domain_output(app_name: Optional[pulumi.Input[str]] = None,
                      domain_name: Optional[pulumi.Input[str]] = None,
                      resource_group_name: Optional[pulumi.Input[str]] = None,
                      service_name: Optional[pulumi.Input[str]] = None,
                      opts: Optional[InvokeOptions] = None) -> Output[GetCustomDomainResult]
Copy
func LookupCustomDomain(ctx *Context, args *LookupCustomDomainArgs, opts ...InvokeOption) (*LookupCustomDomainResult, error)
func LookupCustomDomainOutput(ctx *Context, args *LookupCustomDomainOutputArgs, opts ...InvokeOption) LookupCustomDomainResultOutput
Copy

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

public static class GetCustomDomain 
{
    public static Task<GetCustomDomainResult> InvokeAsync(GetCustomDomainArgs args, InvokeOptions? opts = null)
    public static Output<GetCustomDomainResult> Invoke(GetCustomDomainInvokeArgs args, InvokeOptions? opts = null)
}
Copy
public static CompletableFuture<GetCustomDomainResult> getCustomDomain(GetCustomDomainArgs args, InvokeOptions options)
public static Output<GetCustomDomainResult> getCustomDomain(GetCustomDomainArgs args, InvokeOptions options)
Copy
fn::invoke:
  function: azure-native:appplatform:getCustomDomain
  arguments:
    # arguments dictionary
Copy

The following arguments are supported:

AppName
This property is required.
Changes to this property will trigger replacement.
string
The name of the App resource.
DomainName
This property is required.
Changes to this property will trigger replacement.
string
The name of the custom domain resource.
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.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Service resource.
AppName
This property is required.
Changes to this property will trigger replacement.
string
The name of the App resource.
DomainName
This property is required.
Changes to this property will trigger replacement.
string
The name of the custom domain resource.
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.
ServiceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Service resource.
appName
This property is required.
Changes to this property will trigger replacement.
String
The name of the App resource.
domainName
This property is required.
Changes to this property will trigger replacement.
String
The name of the custom domain resource.
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.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Service resource.
appName
This property is required.
Changes to this property will trigger replacement.
string
The name of the App resource.
domainName
This property is required.
Changes to this property will trigger replacement.
string
The name of the custom domain resource.
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.
serviceName
This property is required.
Changes to this property will trigger replacement.
string
The name of the Service resource.
app_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the App resource.
domain_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the custom domain resource.
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.
service_name
This property is required.
Changes to this property will trigger replacement.
str
The name of the Service resource.
appName
This property is required.
Changes to this property will trigger replacement.
String
The name of the App resource.
domainName
This property is required.
Changes to this property will trigger replacement.
String
The name of the custom domain resource.
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.
serviceName
This property is required.
Changes to this property will trigger replacement.
String
The name of the Service resource.

getCustomDomain Result

The following output properties are available:

AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource Id for the resource.
Name string
The name of the resource.
Properties Pulumi.AzureNative.AppPlatform.Outputs.CustomDomainPropertiesResponse
Properties of the custom domain resource.
SystemData Pulumi.AzureNative.AppPlatform.Outputs.SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource.
AzureApiVersion string
The Azure API version of the resource.
Id string
Fully qualified resource Id for the resource.
Name string
The name of the resource.
Properties CustomDomainPropertiesResponse
Properties of the custom domain resource.
SystemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
Type string
The type of the resource.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource Id for the resource.
name String
The name of the resource.
properties CustomDomainPropertiesResponse
Properties of the custom domain resource.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource.
azureApiVersion string
The Azure API version of the resource.
id string
Fully qualified resource Id for the resource.
name string
The name of the resource.
properties CustomDomainPropertiesResponse
Properties of the custom domain resource.
systemData SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type string
The type of the resource.
azure_api_version str
The Azure API version of the resource.
id str
Fully qualified resource Id for the resource.
name str
The name of the resource.
properties CustomDomainPropertiesResponse
Properties of the custom domain resource.
system_data SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
type str
The type of the resource.
azureApiVersion String
The Azure API version of the resource.
id String
Fully qualified resource Id for the resource.
name String
The name of the resource.
properties Property Map
Properties of the custom domain resource.
systemData Property Map
Metadata pertaining to creation and last modification of the resource.
type String
The type of the resource.

Supporting Types

CustomDomainPropertiesResponse

AppName This property is required. string
The app name of domain.
ProvisioningState This property is required. string
Provisioning state of the Domain
CertName string
The bound certificate name of domain.
Thumbprint string
The thumbprint of bound certificate.
AppName This property is required. string
The app name of domain.
ProvisioningState This property is required. string
Provisioning state of the Domain
CertName string
The bound certificate name of domain.
Thumbprint string
The thumbprint of bound certificate.
appName This property is required. String
The app name of domain.
provisioningState This property is required. String
Provisioning state of the Domain
certName String
The bound certificate name of domain.
thumbprint String
The thumbprint of bound certificate.
appName This property is required. string
The app name of domain.
provisioningState This property is required. string
Provisioning state of the Domain
certName string
The bound certificate name of domain.
thumbprint string
The thumbprint of bound certificate.
app_name This property is required. str
The app name of domain.
provisioning_state This property is required. str
Provisioning state of the Domain
cert_name str
The bound certificate name of domain.
thumbprint str
The thumbprint of bound certificate.
appName This property is required. String
The app name of domain.
provisioningState This property is required. String
Provisioning state of the Domain
certName String
The bound certificate name of domain.
thumbprint String
The thumbprint of bound certificate.

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 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 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 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 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 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 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
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.1.0 published on Tuesday, Apr 8, 2025 by Pulumi
pulumi/pulumi-azure-native