1. Packages
  2. Azure Native
  3. API Docs
  4. appplatform
  5. getApiPortalCustomDomain
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.29.0 published on Friday, Feb 16, 2024 by Pulumi

azure-native.appplatform.getApiPortalCustomDomain

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.29.0 published on Friday, Feb 16, 2024 by Pulumi

    Get the API portal custom domain. Azure REST API version: 2023-05-01-preview.

    Other available API versions: 2023-07-01-preview, 2023-09-01-preview, 2023-11-01-preview, 2023-12-01, 2024-01-01-preview.

    Using getApiPortalCustomDomain

    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 getApiPortalCustomDomain(args: GetApiPortalCustomDomainArgs, opts?: InvokeOptions): Promise<GetApiPortalCustomDomainResult>
    function getApiPortalCustomDomainOutput(args: GetApiPortalCustomDomainOutputArgs, opts?: InvokeOptions): Output<GetApiPortalCustomDomainResult>
    def get_api_portal_custom_domain(api_portal_name: Optional[str] = None,
                                     domain_name: Optional[str] = None,
                                     resource_group_name: Optional[str] = None,
                                     service_name: Optional[str] = None,
                                     opts: Optional[InvokeOptions] = None) -> GetApiPortalCustomDomainResult
    def get_api_portal_custom_domain_output(api_portal_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[GetApiPortalCustomDomainResult]
    func LookupApiPortalCustomDomain(ctx *Context, args *LookupApiPortalCustomDomainArgs, opts ...InvokeOption) (*LookupApiPortalCustomDomainResult, error)
    func LookupApiPortalCustomDomainOutput(ctx *Context, args *LookupApiPortalCustomDomainOutputArgs, opts ...InvokeOption) LookupApiPortalCustomDomainResultOutput

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

    public static class GetApiPortalCustomDomain 
    {
        public static Task<GetApiPortalCustomDomainResult> InvokeAsync(GetApiPortalCustomDomainArgs args, InvokeOptions? opts = null)
        public static Output<GetApiPortalCustomDomainResult> Invoke(GetApiPortalCustomDomainInvokeArgs args, InvokeOptions? opts = null)
    }
    public static CompletableFuture<GetApiPortalCustomDomainResult> getApiPortalCustomDomain(GetApiPortalCustomDomainArgs args, InvokeOptions options)
    // Output-based functions aren't available in Java yet
    
    fn::invoke:
      function: azure-native:appplatform:getApiPortalCustomDomain
      arguments:
        # arguments dictionary

    The following arguments are supported:

    ApiPortalName string
    The name of API portal.
    DomainName string
    The name of the API portal custom domain.
    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.
    ServiceName string
    The name of the Service resource.
    ApiPortalName string
    The name of API portal.
    DomainName string
    The name of the API portal custom domain.
    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.
    ServiceName string
    The name of the Service resource.
    apiPortalName String
    The name of API portal.
    domainName String
    The name of the API portal custom domain.
    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.
    serviceName String
    The name of the Service resource.
    apiPortalName string
    The name of API portal.
    domainName string
    The name of the API portal custom domain.
    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.
    serviceName string
    The name of the Service resource.
    api_portal_name str
    The name of API portal.
    domain_name str
    The name of the API portal custom domain.
    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.
    service_name str
    The name of the Service resource.
    apiPortalName String
    The name of API portal.
    domainName String
    The name of the API portal custom domain.
    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.
    serviceName String
    The name of the Service resource.

    getApiPortalCustomDomain 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.AppPlatform.Outputs.ApiPortalCustomDomainPropertiesResponse
    The properties of custom domain for API portal
    SystemData Pulumi.AzureNative.AppPlatform.Outputs.SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The type of the resource.
    Id string
    Fully qualified resource Id for the resource.
    Name string
    The name of the resource.
    Properties ApiPortalCustomDomainPropertiesResponse
    The properties of custom domain for API portal
    SystemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    Type string
    The type of the resource.
    id String
    Fully qualified resource Id for the resource.
    name String
    The name of the resource.
    properties ApiPortalCustomDomainPropertiesResponse
    The properties of custom domain for API portal
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type String
    The type of the resource.
    id string
    Fully qualified resource Id for the resource.
    name string
    The name of the resource.
    properties ApiPortalCustomDomainPropertiesResponse
    The properties of custom domain for API portal
    systemData SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type string
    The type of the resource.
    id str
    Fully qualified resource Id for the resource.
    name str
    The name of the resource.
    properties ApiPortalCustomDomainPropertiesResponse
    The properties of custom domain for API portal
    system_data SystemDataResponse
    Metadata pertaining to creation and last modification of the resource.
    type str
    The type of the resource.
    id String
    Fully qualified resource Id for the resource.
    name String
    The name of the resource.
    properties Property Map
    The properties of custom domain for API portal
    systemData Property Map
    Metadata pertaining to creation and last modification of the resource.
    type String
    The type of the resource.

    Supporting Types

    ApiPortalCustomDomainPropertiesResponse

    Thumbprint string
    The thumbprint of bound certificate.
    Thumbprint string
    The thumbprint of bound certificate.
    thumbprint String
    The thumbprint of bound certificate.
    thumbprint string
    The thumbprint of bound certificate.
    thumbprint str
    The thumbprint of bound certificate.
    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
    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.29.0 published on Friday, Feb 16, 2024 by Pulumi