1. Packages
  2. Zscaler Internet Access (ZIA)
  3. API Docs
  4. getDomainProfile
Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler
Schema (JSON)
zscaler/pulumi-zia

zia.getDomainProfile

zia logo
Viewing docs for pulumi-resource-zia v1.3.8
published on Friday, Mar 13, 2026 by Zscaler
Schema (JSON)
zscaler/pulumi-zia

    Use this data source to look up a domain profile by ID or profile name.

    Using getDomainProfile

    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 getDomainProfile(args: GetDomainProfileArgs, opts?: InvokeOptions): Promise<GetDomainProfileResult>
function getDomainProfileOutput(args: GetDomainProfileOutputArgs, opts?: InvokeOptions): Output<GetDomainProfileResult>
    def get_domain_profile(profile_id: Optional[int] = None,
                       profile_name: Optional[str] = None,
                       opts: Optional[InvokeOptions] = None) -> GetDomainProfileResult
def get_domain_profile_output(profile_id: Optional[pulumi.Input[int]] = None,
                       profile_name: Optional[pulumi.Input[str]] = None,
                       opts: Optional[InvokeOptions] = None) -> Output[GetDomainProfileResult]
    func GetDomainProfile(ctx *Context, args *GetDomainProfileArgs, opts ...InvokeOption) (*GetDomainProfileResult, error)
func GetDomainProfileOutput(ctx *Context, args *GetDomainProfileOutputArgs, opts ...InvokeOption) GetDomainProfileResultOutput

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

    public static class GetDomainProfile 
{
    public static Task<GetDomainProfileResult> InvokeAsync(GetDomainProfileArgs args, InvokeOptions? opts = null)
    public static Output<GetDomainProfileResult> Invoke(GetDomainProfileInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDomainProfileResult> getDomainProfile(GetDomainProfileArgs args, InvokeOptions options)
public static Output<GetDomainProfileResult> getDomainProfile(GetDomainProfileArgs args, InvokeOptions options)

    fn::invoke:
  function: zia:getDomainProfile
  arguments:
    # arguments dictionary

    The following arguments are supported:

    ProfileId int
    The ID of the domain profile to look up.
    ProfileName string
    The name of the domain profile to look up.
    ProfileId int
    The ID of the domain profile to look up.
    ProfileName string
    The name of the domain profile to look up.
    profileId Integer
    The ID of the domain profile to look up.
    profileName String
    The name of the domain profile to look up.
    profileId number
    The ID of the domain profile to look up.
    profileName string
    The name of the domain profile to look up.
    profile_id int
    The ID of the domain profile to look up.
    profile_name str
    The name of the domain profile to look up.
    profileId Number
    The ID of the domain profile to look up.
    profileName String
    The name of the domain profile to look up.

    getDomainProfile Result

    The following output properties are available:

    CustomDomains List<string>
    The list of custom domains in the profile.
    Description string
    The description of the domain profile.
    IncludeCompanyDomains bool
    Whether company domains are included.
    IncludeSubdomains bool
    Whether subdomains are included.
    PredefinedEmailDomains List<string>
    The list of predefined email domains in the profile.
    ProfileId int
    The ID of the domain profile.
    ProfileName string
    The name of the domain profile.
    CustomDomains []string
    The list of custom domains in the profile.
    Description string
    The description of the domain profile.
    IncludeCompanyDomains bool
    Whether company domains are included.
    IncludeSubdomains bool
    Whether subdomains are included.
    PredefinedEmailDomains []string
    The list of predefined email domains in the profile.
    ProfileId int
    The ID of the domain profile.
    ProfileName string
    The name of the domain profile.
    customDomains List<String>
    The list of custom domains in the profile.
    description String
    The description of the domain profile.
    includeCompanyDomains Boolean
    Whether company domains are included.
    includeSubdomains Boolean
    Whether subdomains are included.
    predefinedEmailDomains List<String>
    The list of predefined email domains in the profile.
    profileId Integer
    The ID of the domain profile.
    profileName String
    The name of the domain profile.
    customDomains string[]
    The list of custom domains in the profile.
    description string
    The description of the domain profile.
    includeCompanyDomains boolean
    Whether company domains are included.
    includeSubdomains boolean
    Whether subdomains are included.
    predefinedEmailDomains string[]
    The list of predefined email domains in the profile.
    profileId number
    The ID of the domain profile.
    profileName string
    The name of the domain profile.
    custom_domains Sequence[str]
    The list of custom domains in the profile.
    description str
    The description of the domain profile.
    include_company_domains bool
    Whether company domains are included.
    include_subdomains bool
    Whether subdomains are included.
    predefined_email_domains Sequence[str]
    The list of predefined email domains in the profile.
    profile_id int
    The ID of the domain profile.
    profile_name str
    The name of the domain profile.
    customDomains List<String>
    The list of custom domains in the profile.
    description String
    The description of the domain profile.
    includeCompanyDomains Boolean
    Whether company domains are included.
    includeSubdomains Boolean
    Whether subdomains are included.
    predefinedEmailDomains List<String>
    The list of predefined email domains in the profile.
    profileId Number
    The ID of the domain profile.
    profileName String
    The name of the domain profile.

    Package Details

    Repository
    zia zscaler/pulumi-zia
    License
    zia logo
    Viewing docs for pulumi-resource-zia v1.3.8
    published on Friday, Mar 13, 2026 by Zscaler
    Schema (JSON)
    zscaler/pulumi-zia
      Try Pulumi Cloud free. Your team will thank you.