@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 4.06 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as outputs from "../types/output";
/**
* Get the Domains resource and its properties.
*
* Uses Azure REST API version 2023-06-01-preview.
*
* Other available API versions: 2023-03-31, 2023-04-01, 2023-04-01-preview, 2024-09-01-preview, 2025-05-01, 2025-05-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native communication [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getDomain(args: GetDomainArgs, opts?: pulumi.InvokeOptions): Promise<GetDomainResult>;
export interface GetDomainArgs {
/**
* The name of the Domains resource.
*/
domainName: string;
/**
* The name of the EmailService resource.
*/
emailServiceName: string;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: string;
}
/**
* A class representing a Domains resource.
*/
export interface GetDomainResult {
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: string;
/**
* The location where the Domains resource data is stored at rest.
*/
readonly dataLocation: string;
/**
* Describes how a Domains resource is being managed.
*/
readonly domainManagement: string;
/**
* P2 sender domain that is displayed to the email recipients [RFC 5322].
*/
readonly fromSenderDomain: string;
/**
* Fully qualified resource ID for the resource. E.g. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
*/
readonly id: string;
/**
* The geo-location where the resource lives
*/
readonly location: string;
/**
* P1 sender domain that is present on the email envelope [RFC 5321].
*/
readonly mailFromSenderDomain: string;
/**
* The name of the resource
*/
readonly name: string;
/**
* Provisioning state of the resource.
*/
readonly provisioningState: string;
/**
* Azure Resource Manager metadata containing createdBy and modifiedBy information.
*/
readonly systemData: outputs.communication.SystemDataResponse;
/**
* Resource tags.
*/
readonly tags?: {
[key: string]: string;
};
/**
* The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
*/
readonly type: string;
/**
* Describes whether user engagement tracking is enabled or disabled.
*/
readonly userEngagementTracking?: string;
/**
* List of DnsRecord
*/
readonly verificationRecords: outputs.communication.DomainPropertiesResponseVerificationRecords;
/**
* List of VerificationStatusRecord
*/
readonly verificationStates: outputs.communication.DomainPropertiesResponseVerificationStates;
}
/**
* Get the Domains resource and its properties.
*
* Uses Azure REST API version 2023-06-01-preview.
*
* Other available API versions: 2023-03-31, 2023-04-01, 2023-04-01-preview, 2024-09-01-preview, 2025-05-01, 2025-05-01-preview. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native communication [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare function getDomainOutput(args: GetDomainOutputArgs, opts?: pulumi.InvokeOutputOptions): pulumi.Output<GetDomainResult>;
export interface GetDomainOutputArgs {
/**
* The name of the Domains resource.
*/
domainName: pulumi.Input<string>;
/**
* The name of the EmailService resource.
*/
emailServiceName: pulumi.Input<string>;
/**
* The name of the resource group. The name is case insensitive.
*/
resourceGroupName: pulumi.Input<string>;
}