azure-native.communication.Domain
Explore with Pulumi AI
A class representing a Domains resource. Azure REST API version: 2023-03-31. Prior API version in Azure Native 1.x: 2021-10-01-preview.
Other available API versions: 2022-07-01-preview, 2023-04-01, 2023-04-01-preview, 2023-06-01-preview.
Note: If domainManagement
is set to AzureManaged
, then domainName
is required.
Example Usage
Create or update Domains resource
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var domain = new AzureNative.Communication.Domain("domain", new()
{
DomainManagement = AzureNative.Communication.DomainManagement.CustomerManaged,
DomainName = "mydomain.com",
EmailServiceName = "MyEmailServiceResource",
Location = "Global",
ResourceGroupName = "MyResourceGroup",
});
});
package main
import (
communication "github.com/pulumi/pulumi-azure-native-sdk/communication/v2"
"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(communication.DomainManagementCustomerManaged),
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=azure_native.communication.DomainManagement.CUSTOMER_MANAGED,
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: azure_native.communication.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
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
new Domain(name: string, args: DomainArgs, opts?: CustomResourceOptions);
@overload
def Domain(resource_name: str,
args: DomainArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Domain(resource_name: str,
opts: Optional[ResourceOptions] = None,
domain_management: Optional[Union[str, DomainManagement]] = None,
email_service_name: Optional[str] = None,
resource_group_name: Optional[str] = None,
domain_name: Optional[str] = None,
location: Optional[str] = None,
tags: Optional[Mapping[str, str]] = None,
user_engagement_tracking: Optional[Union[str, UserEngagementTracking]] = 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.
Parameters
- 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.
Constructor example
The following reference example uses placeholder values for all input properties.
var domainResource = new AzureNative.Communication.Domain("domainResource", new()
{
DomainManagement = "string",
EmailServiceName = "string",
ResourceGroupName = "string",
DomainName = "string",
Location = "string",
Tags =
{
{ "string", "string" },
},
UserEngagementTracking = "string",
});
example, err := communication.NewDomain(ctx, "domainResource", &communication.DomainArgs{
DomainManagement: pulumi.String("string"),
EmailServiceName: pulumi.String("string"),
ResourceGroupName: pulumi.String("string"),
DomainName: pulumi.String("string"),
Location: pulumi.String("string"),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
UserEngagementTracking: pulumi.String("string"),
})
var domainResource = new Domain("domainResource", DomainArgs.builder()
.domainManagement("string")
.emailServiceName("string")
.resourceGroupName("string")
.domainName("string")
.location("string")
.tags(Map.of("string", "string"))
.userEngagementTracking("string")
.build());
domain_resource = azure_native.communication.Domain("domainResource",
domain_management="string",
email_service_name="string",
resource_group_name="string",
domain_name="string",
location="string",
tags={
"string": "string",
},
user_engagement_tracking="string")
const domainResource = new azure_native.communication.Domain("domainResource", {
domainManagement: "string",
emailServiceName: "string",
resourceGroupName: "string",
domainName: "string",
location: "string",
tags: {
string: "string",
},
userEngagementTracking: "string",
});
type: azure-native:communication:Domain
properties:
domainManagement: string
domainName: string
emailServiceName: string
location: string
resourceGroupName: string
tags:
string: string
userEngagementTracking: string
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
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Domain resource accepts the following input properties:
- Domain
Management string | Pulumi.Azure Native. Communication. Domain Management - Describes how a Domains resource is being managed.
- Email
Service stringName - The name of the EmailService resource.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Domain
Name string - The name of the Domains resource.
- Location string
- The geo-location where the resource lives
- Dictionary<string, string>
- Resource tags.
- User
Engagement string | Pulumi.Tracking Azure Native. Communication. User Engagement Tracking - Describes whether user engagement tracking is enabled or disabled.
- Domain
Management string | DomainManagement - Describes how a Domains resource is being managed.
- Email
Service stringName - The name of the EmailService resource.
- Resource
Group stringName - The name of the resource group. The name is case insensitive.
- Domain
Name string - The name of the Domains resource.
- Location string
- The geo-location where the resource lives
- map[string]string
- Resource tags.
- User
Engagement string | UserTracking Engagement Tracking - Describes whether user engagement tracking is enabled or disabled.
- domain
Management String | DomainManagement - Describes how a Domains resource is being managed.
- email
Service StringName - The name of the EmailService resource.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- domain
Name String - The name of the Domains resource.
- location String
- The geo-location where the resource lives
- Map<String,String>
- Resource tags.
- user
Engagement String | UserTracking Engagement Tracking - Describes whether user engagement tracking is enabled or disabled.
- domain
Management string | DomainManagement - Describes how a Domains resource is being managed.
- email
Service stringName - The name of the EmailService resource.
- resource
Group stringName - The name of the resource group. The name is case insensitive.
- domain
Name string - The name of the Domains resource.
- location string
- The geo-location where the resource lives
- {[key: string]: string}
- Resource tags.
- user
Engagement string | UserTracking Engagement Tracking - Describes whether user engagement tracking is enabled or disabled.
- domain_
management str | DomainManagement - Describes how a Domains resource is being managed.
- email_
service_ strname - The name of the EmailService resource.
- resource_
group_ strname - 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
- Mapping[str, str]
- Resource tags.
- user_
engagement_ str | Usertracking Engagement Tracking - Describes whether user engagement tracking is enabled or disabled.
- domain
Management String | "AzureManaged" | "Customer Managed" | "Customer Managed In Exchange Online" - Describes how a Domains resource is being managed.
- email
Service StringName - The name of the EmailService resource.
- resource
Group StringName - The name of the resource group. The name is case insensitive.
- domain
Name String - The name of the Domains resource.
- location String
- The geo-location where the resource lives
- Map<String>
- Resource tags.
- user
Engagement String | "Disabled" | "Enabled"Tracking - Describes whether user engagement tracking is enabled or disabled.
Outputs
All input properties are implicitly available as output properties. Additionally, the Domain resource produces the following output properties:
- Data
Location string - The location where the Domains resource data is stored at rest.
- From
Sender stringDomain - P2 sender domain that is displayed to the email recipients [RFC 5322].
- Id string
- The provider-assigned unique ID for this managed resource.
- Mail
From stringSender Domain - P1 sender domain that is present on the email envelope [RFC 5321].
- Name string
- The name of the resource
- Provisioning
State string - Provisioning state of the resource.
- System
Data Pulumi.Azure Native. Communication. Outputs. System Data Response - 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"
- Verification
Records Pulumi.Azure Native. Communication. Outputs. Domain Properties Response Verification Records - List of DnsRecord
- Verification
States Pulumi.Azure Native. Communication. Outputs. Domain Properties Response Verification States - List of VerificationStatusRecord
- Data
Location string - The location where the Domains resource data is stored at rest.
- From
Sender stringDomain - P2 sender domain that is displayed to the email recipients [RFC 5322].
- Id string
- The provider-assigned unique ID for this managed resource.
- Mail
From stringSender Domain - P1 sender domain that is present on the email envelope [RFC 5321].
- Name string
- The name of the resource
- Provisioning
State string - Provisioning state of the resource.
- System
Data SystemData Response - 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"
- Verification
Records DomainProperties Response Verification Records - List of DnsRecord
- Verification
States DomainProperties Response Verification States - List of VerificationStatusRecord
- data
Location String - The location where the Domains resource data is stored at rest.
- from
Sender StringDomain - P2 sender domain that is displayed to the email recipients [RFC 5322].
- id String
- The provider-assigned unique ID for this managed resource.
- mail
From StringSender Domain - P1 sender domain that is present on the email envelope [RFC 5321].
- name String
- The name of the resource
- provisioning
State String - Provisioning state of the resource.
- system
Data SystemData Response - 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"
- verification
Records DomainProperties Response Verification Records - List of DnsRecord
- verification
States DomainProperties Response Verification States - List of VerificationStatusRecord
- data
Location string - The location where the Domains resource data is stored at rest.
- from
Sender stringDomain - P2 sender domain that is displayed to the email recipients [RFC 5322].
- id string
- The provider-assigned unique ID for this managed resource.
- mail
From stringSender Domain - P1 sender domain that is present on the email envelope [RFC 5321].
- name string
- The name of the resource
- provisioning
State string - Provisioning state of the resource.
- system
Data SystemData Response - 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"
- verification
Records DomainProperties Response Verification Records - List of DnsRecord
- verification
States DomainProperties Response Verification States - List of VerificationStatusRecord
- data_
location str - The location where the Domains resource data is stored at rest.
- from_
sender_ strdomain - 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_ strsender_ domain - 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 SystemData Response - 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 DomainProperties Response Verification Records - List of DnsRecord
- verification_
states DomainProperties Response Verification States - List of VerificationStatusRecord
- data
Location String - The location where the Domains resource data is stored at rest.
- from
Sender StringDomain - P2 sender domain that is displayed to the email recipients [RFC 5322].
- id String
- The provider-assigned unique ID for this managed resource.
- mail
From StringSender Domain - P1 sender domain that is present on the email envelope [RFC 5321].
- name String
- The name of the resource
- provisioning
State String - Provisioning state of the resource.
- system
Data 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"
- verification
Records Property Map - List of DnsRecord
- verification
States Property Map - List of VerificationStatusRecord
Supporting Types
DnsRecordResponse, DnsRecordResponseArgs
DomainManagement, DomainManagementArgs
- Azure
Managed - AzureManaged
- Customer
Managed - CustomerManaged
- Customer
Managed In Exchange Online - CustomerManagedInExchangeOnline
- Domain
Management Azure Managed - AzureManaged
- Domain
Management Customer Managed - CustomerManaged
- Domain
Management Customer Managed In Exchange Online - CustomerManagedInExchangeOnline
- Azure
Managed - AzureManaged
- Customer
Managed - CustomerManaged
- Customer
Managed In Exchange Online - CustomerManagedInExchangeOnline
- Azure
Managed - AzureManaged
- Customer
Managed - CustomerManaged
- Customer
Managed In Exchange Online - CustomerManagedInExchangeOnline
- AZURE_MANAGED
- AzureManaged
- CUSTOMER_MANAGED
- CustomerManaged
- CUSTOMER_MANAGED_IN_EXCHANGE_ONLINE
- CustomerManagedInExchangeOnline
- "Azure
Managed" - AzureManaged
- "Customer
Managed" - CustomerManaged
- "Customer
Managed In Exchange Online" - CustomerManagedInExchangeOnline
DomainPropertiesResponseVerificationRecords, DomainPropertiesResponseVerificationRecordsArgs
- DKIM
Pulumi.
Azure Native. Communication. Inputs. Dns Record Response - A class that represents a VerificationStatus record.
- DKIM2
Pulumi.
Azure Native. Communication. Inputs. Dns Record Response - A class that represents a VerificationStatus record.
- DMARC
Pulumi.
Azure Native. Communication. Inputs. Dns Record Response - A class that represents a VerificationStatus record.
- Domain
Pulumi.
Azure Native. Communication. Inputs. Dns Record Response - A class that represents a VerificationStatus record.
- SPF
Pulumi.
Azure Native. Communication. Inputs. Dns Record Response - A class that represents a VerificationStatus record.
- DKIM
Dns
Record Response - A class that represents a VerificationStatus record.
- DKIM2
Dns
Record Response - A class that represents a VerificationStatus record.
- DMARC
Dns
Record Response - A class that represents a VerificationStatus record.
- Domain
Dns
Record Response - A class that represents a VerificationStatus record.
- SPF
Dns
Record Response - A class that represents a VerificationStatus record.
- d
KIM DnsRecord Response - A class that represents a VerificationStatus record.
- d
KIM2 DnsRecord Response - A class that represents a VerificationStatus record.
- d
MARC DnsRecord Response - A class that represents a VerificationStatus record.
- domain
Dns
Record Response - A class that represents a VerificationStatus record.
- s
PF DnsRecord Response - A class that represents a VerificationStatus record.
- d
KIM DnsRecord Response - A class that represents a VerificationStatus record.
- d
KIM2 DnsRecord Response - A class that represents a VerificationStatus record.
- d
MARC DnsRecord Response - A class that represents a VerificationStatus record.
- domain
Dns
Record Response - A class that represents a VerificationStatus record.
- s
PF DnsRecord Response - A class that represents a VerificationStatus record.
- d_
kim DnsRecord Response - A class that represents a VerificationStatus record.
- d_
kim2 DnsRecord Response - A class that represents a VerificationStatus record.
- d_
marc DnsRecord Response - A class that represents a VerificationStatus record.
- domain
Dns
Record Response - A class that represents a VerificationStatus record.
- s_
pf DnsRecord Response - A class that represents a VerificationStatus record.
- d
KIM Property Map - A class that represents a VerificationStatus record.
- d
KIM2 Property Map - A class that represents a VerificationStatus record.
- d
MARC Property Map - A class that represents a VerificationStatus record.
- domain Property Map
- A class that represents a VerificationStatus record.
- s
PF Property Map - A class that represents a VerificationStatus record.
DomainPropertiesResponseVerificationStates, DomainPropertiesResponseVerificationStatesArgs
- DKIM
Pulumi.
Azure Native. Communication. Inputs. Verification Status Record Response - A class that represents a VerificationStatus record.
- DKIM2
Pulumi.
Azure Native. Communication. Inputs. Verification Status Record Response - A class that represents a VerificationStatus record.
- DMARC
Pulumi.
Azure Native. Communication. Inputs. Verification Status Record Response - A class that represents a VerificationStatus record.
- Domain
Pulumi.
Azure Native. Communication. Inputs. Verification Status Record Response - A class that represents a VerificationStatus record.
- SPF
Pulumi.
Azure Native. Communication. Inputs. Verification Status Record Response - A class that represents a VerificationStatus record.
- DKIM
Verification
Status Record Response - A class that represents a VerificationStatus record.
- DKIM2
Verification
Status Record Response - A class that represents a VerificationStatus record.
- DMARC
Verification
Status Record Response - A class that represents a VerificationStatus record.
- Domain
Verification
Status Record Response - A class that represents a VerificationStatus record.
- SPF
Verification
Status Record Response - A class that represents a VerificationStatus record.
- d
KIM VerificationStatus Record Response - A class that represents a VerificationStatus record.
- d
KIM2 VerificationStatus Record Response - A class that represents a VerificationStatus record.
- d
MARC VerificationStatus Record Response - A class that represents a VerificationStatus record.
- domain
Verification
Status Record Response - A class that represents a VerificationStatus record.
- s
PF VerificationStatus Record Response - A class that represents a VerificationStatus record.
- d
KIM VerificationStatus Record Response - A class that represents a VerificationStatus record.
- d
KIM2 VerificationStatus Record Response - A class that represents a VerificationStatus record.
- d
MARC VerificationStatus Record Response - A class that represents a VerificationStatus record.
- domain
Verification
Status Record Response - A class that represents a VerificationStatus record.
- s
PF VerificationStatus Record Response - A class that represents a VerificationStatus record.
- d_
kim VerificationStatus Record Response - A class that represents a VerificationStatus record.
- d_
kim2 VerificationStatus Record Response - A class that represents a VerificationStatus record.
- d_
marc VerificationStatus Record Response - A class that represents a VerificationStatus record.
- domain
Verification
Status Record Response - A class that represents a VerificationStatus record.
- s_
pf VerificationStatus Record Response - A class that represents a VerificationStatus record.
- d
KIM Property Map - A class that represents a VerificationStatus record.
- d
KIM2 Property Map - A class that represents a VerificationStatus record.
- d
MARC Property Map - A class that represents a VerificationStatus record.
- domain Property Map
- A class that represents a VerificationStatus record.
- s
PF Property Map - A class that represents a VerificationStatus record.
SystemDataResponse, SystemDataResponseArgs
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- Created
At string - The timestamp of resource creation (UTC).
- Created
By string - The identity that created the resource.
- Created
By stringType - The type of identity that created the resource.
- Last
Modified stringAt - The timestamp of resource last modification (UTC)
- Last
Modified stringBy - The identity that last modified the resource.
- Last
Modified stringBy Type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
- created
At string - The timestamp of resource creation (UTC).
- created
By string - The identity that created the resource.
- created
By stringType - The type of identity that created the resource.
- last
Modified stringAt - The timestamp of resource last modification (UTC)
- last
Modified stringBy - The identity that last modified the resource.
- last
Modified stringBy Type - 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_ strtype - The type of identity that created the resource.
- last_
modified_ strat - The timestamp of resource last modification (UTC)
- last_
modified_ strby - The identity that last modified the resource.
- last_
modified_ strby_ type - The type of identity that last modified the resource.
- created
At String - The timestamp of resource creation (UTC).
- created
By String - The identity that created the resource.
- created
By StringType - The type of identity that created the resource.
- last
Modified StringAt - The timestamp of resource last modification (UTC)
- last
Modified StringBy - The identity that last modified the resource.
- last
Modified StringBy Type - The type of identity that last modified the resource.
UserEngagementTracking, UserEngagementTrackingArgs
- Disabled
- Disabled
- Enabled
- Enabled
- User
Engagement Tracking Disabled - Disabled
- User
Engagement Tracking Enabled - Enabled
- Disabled
- Disabled
- Enabled
- Enabled
- Disabled
- Disabled
- Enabled
- Enabled
- DISABLED
- Disabled
- ENABLED
- Enabled
- "Disabled"
- Disabled
- "Enabled"
- Enabled
VerificationStatusRecordResponse, VerificationStatusRecordResponseArgs
- error_
code str - Error code. This property will only be present if the status is UnableToVerify.
- status str
- 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/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains/{domainName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0