@pulumi/azure-native
Version:
[](https://slack.pulumi.com) [](https://npmjs.com/package/@pulumi/azure-native) [ • 6.75 kB
TypeScript
import * as pulumi from "@pulumi/pulumi";
import * as inputs from "../types/input";
import * as outputs from "../types/output";
import * as enums from "../types/enums";
/**
* Information about a domain.
*
* Uses Azure REST API version 2024-04-01. In version 2.x of the Azure Native provider, it used API version 2022-09-01.
*
* Other available API versions: 2022-09-01, 2023-01-01, 2023-12-01, 2024-11-01. These can be accessed by generating a local SDK package using the CLI command `pulumi package add azure-native domainregistration [ApiVersion]`. See the [version guide](../../../version-guide/#accessing-any-api-version-via-local-packages) for details.
*/
export declare class Domain extends pulumi.CustomResource {
/**
* Get an existing Domain resource's state with the given name, ID, and optional extra
* properties used to qualify the lookup.
*
* @param name The _unique_ name of the resulting resource.
* @param id The _unique_ provider ID of the resource to lookup.
* @param opts Optional settings to control the behavior of the CustomResource.
*/
static get(name: string, id: pulumi.Input<pulumi.ID>, opts?: pulumi.CustomResourceOptions): Domain;
/**
* Returns true if the given object is an instance of Domain. This is designed to work even
* when multiple copies of the Pulumi SDK have been loaded into the same process.
*/
static isInstance(obj: any): obj is Domain;
readonly authCode: pulumi.Output<string | undefined>;
/**
* <code>true</code> if the domain should be automatically renewed; otherwise, <code>false</code>.
*/
readonly autoRenew: pulumi.Output<boolean | undefined>;
/**
* The Azure API version of the resource.
*/
readonly azureApiVersion: pulumi.Output<string>;
/**
* Domain creation timestamp.
*/
readonly createdTime: pulumi.Output<string>;
/**
* Current DNS type
*/
readonly dnsType: pulumi.Output<string | undefined>;
/**
* Azure DNS Zone to use
*/
readonly dnsZoneId: pulumi.Output<string | undefined>;
/**
* Reasons why domain is not renewable.
*/
readonly domainNotRenewableReasons: pulumi.Output<string[]>;
/**
* Domain expiration timestamp.
*/
readonly expirationTime: pulumi.Output<string>;
/**
* Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.
*/
readonly kind: pulumi.Output<string | undefined>;
/**
* Timestamp when the domain was renewed last time.
*/
readonly lastRenewedTime: pulumi.Output<string>;
/**
* Resource Location.
*/
readonly location: pulumi.Output<string>;
/**
* All hostnames derived from the domain and assigned to Azure resources.
*/
readonly managedHostNames: pulumi.Output<outputs.domainregistration.HostNameResponse[]>;
/**
* Resource Name.
*/
readonly name: pulumi.Output<string>;
/**
* Name servers.
*/
readonly nameServers: pulumi.Output<string[]>;
/**
* <code>true</code> if domain privacy is enabled for this domain; otherwise, <code>false</code>.
*/
readonly privacy: pulumi.Output<boolean | undefined>;
/**
* Domain provisioning state.
*/
readonly provisioningState: pulumi.Output<string>;
/**
* <code>true</code> if Azure can assign this domain to App Service apps; otherwise, <code>false</code>. This value will be <code>true</code> if domain registration status is active and
* it is hosted on name servers Azure has programmatic access to.
*/
readonly readyForDnsRecordManagement: pulumi.Output<boolean>;
/**
* Domain registration status.
*/
readonly registrationStatus: pulumi.Output<string>;
/**
* Resource tags.
*/
readonly tags: pulumi.Output<{
[key: string]: string;
} | undefined>;
/**
* Target DNS type (would be used for migration)
*/
readonly targetDnsType: pulumi.Output<string | undefined>;
/**
* Resource type.
*/
readonly type: pulumi.Output<string>;
/**
* Create a Domain resource with the given unique name, arguments, and options.
*
* @param name The _unique_ name of the resource.
* @param args The arguments to use to populate this resource's properties.
* @param opts A bag of options that control this resource's behavior.
*/
constructor(name: string, args: DomainArgs, opts?: pulumi.CustomResourceOptions);
}
/**
* The set of arguments for constructing a Domain resource.
*/
export interface DomainArgs {
authCode?: pulumi.Input<string>;
/**
* <code>true</code> if the domain should be automatically renewed; otherwise, <code>false</code>.
*/
autoRenew?: pulumi.Input<boolean>;
/**
* Legal agreement consent.
*/
consent: pulumi.Input<inputs.domainregistration.DomainPurchaseConsentArgs>;
/**
* Administrative contact.
*/
contactAdmin: pulumi.Input<inputs.domainregistration.ContactArgs>;
/**
* Billing contact.
*/
contactBilling: pulumi.Input<inputs.domainregistration.ContactArgs>;
/**
* Registrant contact.
*/
contactRegistrant: pulumi.Input<inputs.domainregistration.ContactArgs>;
/**
* Technical contact.
*/
contactTech: pulumi.Input<inputs.domainregistration.ContactArgs>;
/**
* Current DNS type
*/
dnsType?: pulumi.Input<enums.domainregistration.DnsType>;
/**
* Azure DNS Zone to use
*/
dnsZoneId?: pulumi.Input<string>;
/**
* Name of the domain.
*/
domainName?: pulumi.Input<string>;
/**
* Kind of resource. If the resource is an app, you can refer to https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference for details supported values for kind.
*/
kind?: pulumi.Input<string>;
/**
* Resource Location.
*/
location?: pulumi.Input<string>;
/**
* <code>true</code> if domain privacy is enabled for this domain; otherwise, <code>false</code>.
*/
privacy?: pulumi.Input<boolean>;
/**
* Name of the resource group to which the resource belongs.
*/
resourceGroupName: pulumi.Input<string>;
/**
* Resource tags.
*/
tags?: pulumi.Input<{
[key: string]: pulumi.Input<string>;
}>;
/**
* Target DNS type (would be used for migration)
*/
targetDnsType?: pulumi.Input<enums.domainregistration.DnsType>;
}