Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native v1
  3. API Docs
  4. communication
  5. getDomain
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

azure-native.communication.getDomain

Explore with Pulumi AI

azure-native-v1 logo
These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
pulumi/pulumi-azure-native

    Get the Domains resource and its properties. API Version: 2021-10-01-preview.

    Using getDomain

    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 getDomain(args: GetDomainArgs, opts?: InvokeOptions): Promise<GetDomainResult>
function getDomainOutput(args: GetDomainOutputArgs, opts?: InvokeOptions): Output<GetDomainResult>
    def get_domain(domain_name: Optional[str] = None,
               email_service_name: Optional[str] = None,
               resource_group_name: Optional[str] = None,
               opts: Optional[InvokeOptions] = None) -> GetDomainResult
def get_domain_output(domain_name: Optional[pulumi.Input[str]] = None,
               email_service_name: Optional[pulumi.Input[str]] = None,
               resource_group_name: Optional[pulumi.Input[str]] = None,
               opts: Optional[InvokeOptions] = None) -> Output[GetDomainResult]
    func LookupDomain(ctx *Context, args *LookupDomainArgs, opts ...InvokeOption) (*LookupDomainResult, error)
func LookupDomainOutput(ctx *Context, args *LookupDomainOutputArgs, opts ...InvokeOption) LookupDomainResultOutput

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

    public static class GetDomain 
{
    public static Task<GetDomainResult> InvokeAsync(GetDomainArgs args, InvokeOptions? opts = null)
    public static Output<GetDomainResult> Invoke(GetDomainInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetDomainResult> getDomain(GetDomainArgs args, InvokeOptions options)
// Output-based functions aren't available in Java yet

    fn::invoke:
  function: azure-native:communication:getDomain
  arguments:
    # arguments dictionary

    The following arguments are supported:

    DomainName string
    The name of the Domains resource.
    EmailServiceName string
    The name of the EmailService resource.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    DomainName string
    The name of the Domains resource.
    EmailServiceName string
    The name of the EmailService resource.
    ResourceGroupName string
    The name of the resource group. The name is case insensitive.
    domainName String
    The name of the Domains resource.
    emailServiceName String
    The name of the EmailService resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.
    domainName string
    The name of the Domains resource.
    emailServiceName string
    The name of the EmailService resource.
    resourceGroupName string
    The name of the resource group. The name is case insensitive.
    domain_name str
    The name of the Domains resource.
    email_service_name str
    The name of the EmailService resource.
    resource_group_name str
    The name of the resource group. The name is case insensitive.
    domainName String
    The name of the Domains resource.
    emailServiceName String
    The name of the EmailService resource.
    resourceGroupName String
    The name of the resource group. The name is case insensitive.

    getDomain Result

    The following output properties are available:

    DataLocation string
    The location where the Domains resource data is stored at rest.
    DomainManagement string
    Describes how a Domains resource is being managed.
    FromSenderDomain string
    P2 sender domain that is displayed to the email recipients [RFC 5322].
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    MailFromSenderDomain string
    P1 sender domain that is present on the email envelope [RFC 5321].
    Name string
    The name of the resource
    ProvisioningState string
    Provisioning state of the resource.
    SystemData Pulumi.AzureNative.Communication.Outputs.SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    VerificationRecords Pulumi.AzureNative.Communication.Outputs.DomainPropertiesResponseVerificationRecords
    List of DnsRecord
    VerificationStates Pulumi.AzureNative.Communication.Outputs.DomainPropertiesResponseVerificationStates
    List of VerificationStatusRecord
    Tags Dictionary<string, string>
    Resource tags.
    UserEngagementTracking string
    Describes whether user engagement tracking is enabled or disabled.
    ValidSenderUsernames Dictionary<string, string>
    Collection of valid sender usernames. This is a key-value pair where key=username and value=display name.
    DataLocation string
    The location where the Domains resource data is stored at rest.
    DomainManagement string
    Describes how a Domains resource is being managed.
    FromSenderDomain string
    P2 sender domain that is displayed to the email recipients [RFC 5322].
    Id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    Location string
    The geo-location where the resource lives
    MailFromSenderDomain string
    P1 sender domain that is present on the email envelope [RFC 5321].
    Name string
    The name of the resource
    ProvisioningState string
    Provisioning state of the resource.
    SystemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    Type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    VerificationRecords DomainPropertiesResponseVerificationRecords
    List of DnsRecord
    VerificationStates DomainPropertiesResponseVerificationStates
    List of VerificationStatusRecord
    Tags map[string]string
    Resource tags.
    UserEngagementTracking string
    Describes whether user engagement tracking is enabled or disabled.
    ValidSenderUsernames map[string]string
    Collection of valid sender usernames. This is a key-value pair where key=username and value=display name.
    dataLocation String
    The location where the Domains resource data is stored at rest.
    domainManagement String
    Describes how a Domains resource is being managed.
    fromSenderDomain String
    P2 sender domain that is displayed to the email recipients [RFC 5322].
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    mailFromSenderDomain String
    P1 sender domain that is present on the email envelope [RFC 5321].
    name String
    The name of the resource
    provisioningState String
    Provisioning state of the resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    verificationRecords DomainPropertiesResponseVerificationRecords
    List of DnsRecord
    verificationStates DomainPropertiesResponseVerificationStates
    List of VerificationStatusRecord
    tags Map<String,String>
    Resource tags.
    userEngagementTracking String
    Describes whether user engagement tracking is enabled or disabled.
    validSenderUsernames Map<String,String>
    Collection of valid sender usernames. This is a key-value pair where key=username and value=display name.
    dataLocation string
    The location where the Domains resource data is stored at rest.
    domainManagement string
    Describes how a Domains resource is being managed.
    fromSenderDomain string
    P2 sender domain that is displayed to the email recipients [RFC 5322].
    id string
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location string
    The geo-location where the resource lives
    mailFromSenderDomain string
    P1 sender domain that is present on the email envelope [RFC 5321].
    name string
    The name of the resource
    provisioningState string
    Provisioning state of the resource.
    systemData SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type string
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    verificationRecords DomainPropertiesResponseVerificationRecords
    List of DnsRecord
    verificationStates DomainPropertiesResponseVerificationStates
    List of VerificationStatusRecord
    tags {[key: string]: string}
    Resource tags.
    userEngagementTracking string
    Describes whether user engagement tracking is enabled or disabled.
    validSenderUsernames {[key: string]: string}
    Collection of valid sender usernames. This is a key-value pair where key=username and value=display name.
    data_location str
    The location where the Domains resource data is stored at rest.
    domain_management str
    Describes how a Domains resource is being managed.
    from_sender_domain str
    P2 sender domain that is displayed to the email recipients [RFC 5322].
    id str
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location str
    The geo-location where the resource lives
    mail_from_sender_domain str
    P1 sender domain that is present on the email envelope [RFC 5321].
    name str
    The name of the resource
    provisioning_state str
    Provisioning state of the resource.
    system_data SystemDataResponse
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type str
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    verification_records DomainPropertiesResponseVerificationRecords
    List of DnsRecord
    verification_states DomainPropertiesResponseVerificationStates
    List of VerificationStatusRecord
    tags Mapping[str, str]
    Resource tags.
    user_engagement_tracking str
    Describes whether user engagement tracking is enabled or disabled.
    valid_sender_usernames Mapping[str, str]
    Collection of valid sender usernames. This is a key-value pair where key=username and value=display name.
    dataLocation String
    The location where the Domains resource data is stored at rest.
    domainManagement String
    Describes how a Domains resource is being managed.
    fromSenderDomain String
    P2 sender domain that is displayed to the email recipients [RFC 5322].
    id String
    Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
    location String
    The geo-location where the resource lives
    mailFromSenderDomain String
    P1 sender domain that is present on the email envelope [RFC 5321].
    name String
    The name of the resource
    provisioningState String
    Provisioning state of the resource.
    systemData Property Map
    Azure Resource Manager metadata containing createdBy and modifiedBy information.
    type String
    The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
    verificationRecords Property Map
    List of DnsRecord
    verificationStates Property Map
    List of VerificationStatusRecord
    tags Map<String>
    Resource tags.
    userEngagementTracking String
    Describes whether user engagement tracking is enabled or disabled.
    validSenderUsernames Map<String>
    Collection of valid sender usernames. This is a key-value pair where key=username and value=display name.

    Supporting Types

    DnsRecordResponse

    Name string
    Name of the DNS record.
    Ttl int
    Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec.
    Type string
    Type of the DNS record. Example: TXT
    Value string
    Value of the DNS record.
    Name string
    Name of the DNS record.
    Ttl int
    Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec.
    Type string
    Type of the DNS record. Example: TXT
    Value string
    Value of the DNS record.
    name String
    Name of the DNS record.
    ttl Integer
    Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec.
    type String
    Type of the DNS record. Example: TXT
    value String
    Value of the DNS record.
    name string
    Name of the DNS record.
    ttl number
    Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec.
    type string
    Type of the DNS record. Example: TXT
    value string
    Value of the DNS record.
    name str
    Name of the DNS record.
    ttl int
    Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec.
    type str
    Type of the DNS record. Example: TXT
    value str
    Value of the DNS record.
    name String
    Name of the DNS record.
    ttl Number
    Represents an expiry time in seconds to represent how long this entry can be cached by the resolver, default = 3600sec.
    type String
    Type of the DNS record. Example: TXT
    value String
    Value of the DNS record.

    DomainPropertiesResponseVerificationRecords

    DKIM Pulumi.AzureNative.Communication.Inputs.DnsRecordResponse
    A class that represents a VerificationStatus record.
    DKIM2 Pulumi.AzureNative.Communication.Inputs.DnsRecordResponse
    A class that represents a VerificationStatus record.
    DMARC Pulumi.AzureNative.Communication.Inputs.DnsRecordResponse
    A class that represents a VerificationStatus record.
    Domain Pulumi.AzureNative.Communication.Inputs.DnsRecordResponse
    A class that represents a VerificationStatus record.
    SPF Pulumi.AzureNative.Communication.Inputs.DnsRecordResponse
    A class that represents a VerificationStatus record.
    DKIM DnsRecordResponse
    A class that represents a VerificationStatus record.
    DKIM2 DnsRecordResponse
    A class that represents a VerificationStatus record.
    DMARC DnsRecordResponse
    A class that represents a VerificationStatus record.
    Domain DnsRecordResponse
    A class that represents a VerificationStatus record.
    SPF DnsRecordResponse
    A class that represents a VerificationStatus record.
    dKIM DnsRecordResponse
    A class that represents a VerificationStatus record.
    dKIM2 DnsRecordResponse
    A class that represents a VerificationStatus record.
    dMARC DnsRecordResponse
    A class that represents a VerificationStatus record.
    domain DnsRecordResponse
    A class that represents a VerificationStatus record.
    sPF DnsRecordResponse
    A class that represents a VerificationStatus record.
    dKIM DnsRecordResponse
    A class that represents a VerificationStatus record.
    dKIM2 DnsRecordResponse
    A class that represents a VerificationStatus record.
    dMARC DnsRecordResponse
    A class that represents a VerificationStatus record.
    domain DnsRecordResponse
    A class that represents a VerificationStatus record.
    sPF DnsRecordResponse
    A class that represents a VerificationStatus record.
    d_kim DnsRecordResponse
    A class that represents a VerificationStatus record.
    d_kim2 DnsRecordResponse
    A class that represents a VerificationStatus record.
    d_marc DnsRecordResponse
    A class that represents a VerificationStatus record.
    domain DnsRecordResponse
    A class that represents a VerificationStatus record.
    s_pf DnsRecordResponse
    A class that represents a VerificationStatus record.
    dKIM Property Map
    A class that represents a VerificationStatus record.
    dKIM2 Property Map
    A class that represents a VerificationStatus record.
    dMARC Property Map
    A class that represents a VerificationStatus record.
    domain Property Map
    A class that represents a VerificationStatus record.
    sPF Property Map
    A class that represents a VerificationStatus record.

    DomainPropertiesResponseVerificationStates

    DKIM Pulumi.AzureNative.Communication.Inputs.VerificationStatusRecordResponse
    A class that represents a VerificationStatus record.
    DKIM2 Pulumi.AzureNative.Communication.Inputs.VerificationStatusRecordResponse
    A class that represents a VerificationStatus record.
    DMARC Pulumi.AzureNative.Communication.Inputs.VerificationStatusRecordResponse
    A class that represents a VerificationStatus record.
    Domain Pulumi.AzureNative.Communication.Inputs.VerificationStatusRecordResponse
    A class that represents a VerificationStatus record.
    SPF Pulumi.AzureNative.Communication.Inputs.VerificationStatusRecordResponse
    A class that represents a VerificationStatus record.
    DKIM VerificationStatusRecordResponse
    A class that represents a VerificationStatus record.
    DKIM2 VerificationStatusRecordResponse
    A class that represents a VerificationStatus record.
    DMARC VerificationStatusRecordResponse
    A class that represents a VerificationStatus record.
    Domain VerificationStatusRecordResponse
    A class that represents a VerificationStatus record.
    SPF VerificationStatusRecordResponse
    A class that represents a VerificationStatus record.
    dKIM VerificationStatusRecordResponse
    A class that represents a VerificationStatus record.
    dKIM2 VerificationStatusRecordResponse
    A class that represents a VerificationStatus record.
    dMARC VerificationStatusRecordResponse
    A class that represents a VerificationStatus record.
    domain VerificationStatusRecordResponse
    A class that represents a VerificationStatus record.
    sPF VerificationStatusRecordResponse
    A class that represents a VerificationStatus record.
    dKIM VerificationStatusRecordResponse
    A class that represents a VerificationStatus record.
    dKIM2 VerificationStatusRecordResponse
    A class that represents a VerificationStatus record.
    dMARC VerificationStatusRecordResponse
    A class that represents a VerificationStatus record.
    domain VerificationStatusRecordResponse
    A class that represents a VerificationStatus record.
    sPF VerificationStatusRecordResponse
    A class that represents a VerificationStatus record.
    d_kim VerificationStatusRecordResponse
    A class that represents a VerificationStatus record.
    d_kim2 VerificationStatusRecordResponse
    A class that represents a VerificationStatus record.
    d_marc VerificationStatusRecordResponse
    A class that represents a VerificationStatus record.
    domain VerificationStatusRecordResponse
    A class that represents a VerificationStatus record.
    s_pf VerificationStatusRecordResponse
    A class that represents a VerificationStatus record.
    dKIM Property Map
    A class that represents a VerificationStatus record.
    dKIM2 Property Map
    A class that represents a VerificationStatus record.
    dMARC Property Map
    A class that represents a VerificationStatus record.
    domain Property Map
    A class that represents a VerificationStatus record.
    sPF Property Map
    A class that represents a VerificationStatus record.

    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.

    VerificationStatusRecordResponse

    ErrorCode string
    Error code. This property will only be present if the status is UnableToVerify.
    Status string
    Status of the verification operation.
    ErrorCode string
    Error code. This property will only be present if the status is UnableToVerify.
    Status string
    Status of the verification operation.
    errorCode String
    Error code. This property will only be present if the status is UnableToVerify.
    status String
    Status of the verification operation.
    errorCode string
    Error code. This property will only be present if the status is UnableToVerify.
    status string
    Status of the verification operation.
    error_code str
    Error code. This property will only be present if the status is UnableToVerify.
    status str
    Status of the verification operation.
    errorCode String
    Error code. This property will only be present if the status is UnableToVerify.
    status String
    Status of the verification operation.

    Package Details

    Repository
    azure-native-v1 pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native-v1 logo
    These are the docs for Azure Native v1. We recommenend using the latest version, Azure Native v2.
    Azure Native v1 v1.104.0 published on Thursday, Jul 6, 2023 by Pulumi
    pulumi/pulumi-azure-native