Azure Native v1.102.0, May 2 23

azure-native.communication.Domain

Explore with Pulumi AI

A class representing a Domains resource. API Version: 2021-10-01-preview.

Example Usage

Create or update Domains resource

using System.Collections.Generic;
using Pulumi;
using AzureNative = Pulumi.AzureNative;

return await Deployment.RunAsync(() => 
{
    var domain = new AzureNative.Communication.Domain("domain", new()
    {
        DomainManagement = "CustomerManaged",
        DomainName = "mydomain.com",
        EmailServiceName = "MyEmailServiceResource",
        Location = "Global",
        ResourceGroupName = "MyResourceGroup",
    });

});

package main

import (
	communication "github.com/pulumi/pulumi-azure-native/sdk/go/azure/communication"
	"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)

func main() {
	pulumi.Run(func(ctx *pulumi.Context) error {
		_, err := communication.NewDomain(ctx, "domain", &communication.DomainArgs{
			DomainManagement:  pulumi.String("CustomerManaged"),
			DomainName:        pulumi.String("mydomain.com"),
			EmailServiceName:  pulumi.String("MyEmailServiceResource"),
			Location:          pulumi.String("Global"),
			ResourceGroupName: pulumi.String("MyResourceGroup"),
		})
		if err != nil {
			return err
		}
		return nil
	})
}

package generated_program;

import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.communication.Domain;
import com.pulumi.azurenative.communication.DomainArgs;
import java.util.List;
import java.util.ArrayList;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;

public class App {
    public static void main(String[] args) {
        Pulumi.run(App::stack);
    }

    public static void stack(Context ctx) {
        var domain = new Domain("domain", DomainArgs.builder()        
            .domainManagement("CustomerManaged")
            .domainName("mydomain.com")
            .emailServiceName("MyEmailServiceResource")
            .location("Global")
            .resourceGroupName("MyResourceGroup")
            .build());

    }
}

import pulumi
import pulumi_azure_native as azure_native

domain = azure_native.communication.Domain("domain",
    domain_management="CustomerManaged",
    domain_name="mydomain.com",
    email_service_name="MyEmailServiceResource",
    location="Global",
    resource_group_name="MyResourceGroup")

import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";

const domain = new azure_native.communication.Domain("domain", {
    domainManagement: "CustomerManaged",
    domainName: "mydomain.com",
    emailServiceName: "MyEmailServiceResource",
    location: "Global",
    resourceGroupName: "MyResourceGroup",
});

resources:
  domain:
    type: azure-native:communication:Domain
    properties:
      domainManagement: CustomerManaged
      domainName: mydomain.com
      emailServiceName: MyEmailServiceResource
      location: Global
      resourceGroupName: MyResourceGroup

Create Domain Resource

new Domain(name: string, args: DomainArgs, opts?: CustomResourceOptions);

@overload
def Domain(resource_name: str,
           opts: Optional[ResourceOptions] = None,
           domain_management: Optional[Union[str, DomainManagement]] = None,
           domain_name: Optional[str] = None,
           email_service_name: Optional[str] = None,
           location: Optional[str] = None,
           resource_group_name: Optional[str] = None,
           tags: Optional[Mapping[str, str]] = None,
           user_engagement_tracking: Optional[Union[str, UserEngagementTracking]] = None,
           valid_sender_usernames: Optional[Mapping[str, str]] = None)
@overload
def Domain(resource_name: str,
           args: DomainArgs,
           opts: Optional[ResourceOptions] = None)

func NewDomain(ctx *Context, name string, args DomainArgs, opts ...ResourceOption) (*Domain, error)

public Domain(string name, DomainArgs args, CustomResourceOptions? opts = null)

public Domain(String name, DomainArgs args)
public Domain(String name, DomainArgs args, CustomResourceOptions options)

type: azure-native:communication:Domain
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DomainArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
args DomainArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args DomainArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args DomainArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

name String: The unique name of the resource.
args DomainArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

Domain Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.

Inputs

The Domain resource accepts the following input properties:

DomainManagement string | Pulumi.AzureNative.Communication.DomainManagement: Describes how a Domains resource is being managed.
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.
Location string: The geo-location where the resource lives
Tags Dictionary<string, string>: Resource tags.
UserEngagementTracking string | Pulumi.AzureNative.Communication.UserEngagementTracking: 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.

DomainManagement string | DomainManagement: Describes how a Domains resource is being managed.
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.
Location string: The geo-location where the resource lives
Tags map[string]string: Resource tags.
UserEngagementTracking string | UserEngagementTracking: 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.

domainManagement String | DomainManagement: Describes how a Domains resource is being managed.
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.
location String: The geo-location where the resource lives
tags Map<String,String>: Resource tags.
userEngagementTracking String | UserEngagementTracking: 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.

domainManagement string | DomainManagement: Describes how a Domains resource is being managed.
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.
location string: The geo-location where the resource lives
tags {[key: string]: string}: Resource tags.
userEngagementTracking string | UserEngagementTracking: 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.

domain_management str | DomainManagement: Describes how a Domains resource is being managed.
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.
domain_name str: The name of the Domains resource.
location str: The geo-location where the resource lives
tags Mapping[str, str]: Resource tags.
user_engagement_tracking str | UserEngagementTracking: 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.

domainManagement String | "AzureManaged" | "CustomerManaged" | "CustomerManagedInExchangeOnline": Describes how a Domains resource is being managed.
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.
location String: The geo-location where the resource lives
tags Map<String>: Resource tags.
userEngagementTracking String | "Disabled" | "Enabled": 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.

Outputs

All input properties are implicitly available as output properties. Additionally, the Domain resource produces the following output properties:

DataLocation string: The location where the Domains resource data is stored at rest.
FromSenderDomain string: P2 sender domain that is displayed to the email recipients [RFC 5322].
Id string: The provider-assigned unique ID for this managed resource.
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

DataLocation string: The location where the Domains resource data is stored at rest.
FromSenderDomain string: P2 sender domain that is displayed to the email recipients [RFC 5322].
Id string: The provider-assigned unique ID for this managed resource.
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

dataLocation String: The location where the Domains resource data is stored at rest.
fromSenderDomain String: P2 sender domain that is displayed to the email recipients [RFC 5322].
id String: The provider-assigned unique ID for this managed resource.
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

dataLocation string: The location where the Domains resource data is stored at rest.
fromSenderDomain string: P2 sender domain that is displayed to the email recipients [RFC 5322].
id string: The provider-assigned unique ID for this managed resource.
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

data_location str: The location where the Domains resource data is stored at rest.
from_sender_domain str: P2 sender domain that is displayed to the email recipients [RFC 5322].
id str: The provider-assigned unique ID for this managed resource.
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

dataLocation String: The location where the Domains resource data is stored at rest.
fromSenderDomain String: P2 sender domain that is displayed to the email recipients [RFC 5322].
id String: The provider-assigned unique ID for this managed resource.
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

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.

DomainManagement

AzureManaged: AzureManaged
CustomerManaged: CustomerManaged
CustomerManagedInExchangeOnline: CustomerManagedInExchangeOnline

DomainManagementAzureManaged: AzureManaged
DomainManagementCustomerManaged: CustomerManaged
DomainManagementCustomerManagedInExchangeOnline: CustomerManagedInExchangeOnline

AzureManaged: AzureManaged
CustomerManaged: CustomerManaged
CustomerManagedInExchangeOnline: CustomerManagedInExchangeOnline

AzureManaged: AzureManaged
CustomerManaged: CustomerManaged
CustomerManagedInExchangeOnline: CustomerManagedInExchangeOnline

AZURE_MANAGED: AzureManaged
CUSTOMER_MANAGED: CustomerManaged
CUSTOMER_MANAGED_IN_EXCHANGE_ONLINE: CustomerManagedInExchangeOnline

"AzureManaged": AzureManaged
"CustomerManaged": CustomerManaged
"CustomerManagedInExchangeOnline": CustomerManagedInExchangeOnline

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.

UserEngagementTracking

Disabled: Disabled
Enabled: Enabled

UserEngagementTrackingDisabled: Disabled
UserEngagementTrackingEnabled: Enabled

Disabled: Disabled
Enabled: Enabled

Disabled: Disabled
Enabled: Enabled

DISABLED: Disabled
ENABLED: Enabled

"Disabled": Disabled
"Enabled": Enabled

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.

Import

An existing resource can be imported using its type token, name, and identifier, e.g.

$ pulumi import azure-native:communication:Domain mydomain.com /subscriptions/12345/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/EmailServices/MyEmailServiceResource/Domains/mydomain.com

Package Details

Repository: Azure Native pulumi/pulumi-azure-native
License: Apache-2.0