Domains - Create Or Update

Referencia

Servicio:: App Service

Versión de la API:: 2024-11-01

Descripción para Crea o actualiza un dominio.

PUT https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}?api-version=2024-11-01

Parámetros de identificador URI

Nombre	En	Requerido	Tipo	Description
domainName	path	True	string pattern: [a-zA-Z0-9][a-zA-Z0-9\.-]+	Nombre del dominio.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+[^\.]$	Nombre del grupo de recursos al que pertenece el recurso.
subscriptionId	path	True	string	Su identificador de suscripción de Azure. Se trata de una cadena con formato GUID (por ejemplo, 000000000-00000-0000-0000-00000000000000).
api-version	query	True	string	Versión de la API

Cuerpo de la solicitud

Nombre	Requerido	Tipo	Description
location	True	string	Ubicación del recurso.
properties.consent	True	DomainPurchaseConsent	Consentimiento del contrato legal.
properties.contactAdmin	True	Contact	Contacto administrativo.
properties.contactBilling	True	Contact	Contacto de facturación.
properties.contactRegistrant	True	Contact	Contacto de registrador.
properties.contactTech	True	Contact	Contacto técnico.
kind		string	Tipo de recurso. Si el recurso es una aplicación, puede consultar https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference para obtener más información sobre los valores admitidos para el tipo.
properties.authCode		string
properties.autoRenew		boolean	`true` si el dominio se debe renovar automáticamente; de lo contrario, `false`.
properties.dnsType		DnsType	Tipo DNS actual
properties.dnsZoneId		string	Zona DNS de Azure que se va a usar
properties.privacy		boolean	`true` si la privacidad del dominio está habilitada para este dominio; de lo contrario, `false`.
properties.targetDnsType		DnsType	Tipo DNS de destino (se usaría para la migración)
tags		object	Etiquetas de recursos.

Respuestas

Nombre	Tipo	Description
200 OK	Domain	La compra del dominio se realizó correctamente.
202 Accepted	Domain	La compra de dominio está en curso.
Other Status Codes	DefaultErrorResponse	Respuesta de error de App Service.

Seguridad

azure_auth

Flujo de OAuth2 de Azure Active Directory

Tipo: oauth2
Flujo: implicit
Dirección URL de autorización: https://login.microsoftonline.com/common/oauth2/authorize

Ámbitos

Nombre	Description
user_impersonation	suplantar la cuenta de usuario

Ejemplos

Create App Service Domain

PUT https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.DomainRegistration/domains/example.com?api-version=2024-11-01

{
  "location": "global",
  "tags": {},
  "properties": {
    "authCode": "exampleAuthCode",
    "privacy": false,
    "autoRenew": true,
    "dnsType": "DefaultDomainRegistrarDns",
    "consent": {
      "agreementKeys": [
        "agreementKey1"
      ],
      "agreedBy": "192.0.2.1",
      "agreedAt": "2021-09-10T19:30:53Z"
    },
    "contactTech": {
      "email": "tech@email.com",
      "fax": "1-245-534-2242",
      "nameFirst": "John",
      "nameLast": "Doe",
      "nameMiddle": "",
      "jobTitle": "Tech",
      "organization": "Microsoft Inc.",
      "phone": "1-245-534-2242",
      "addressMailing": {
        "address1": "3400 State St",
        "city": "Chicago",
        "state": "IL",
        "country": "United States",
        "postalCode": "67098"
      }
    },
    "contactBilling": {
      "email": "billing@email.com",
      "fax": "1-245-534-2242",
      "nameFirst": "John",
      "nameLast": "Doe",
      "nameMiddle": "",
      "jobTitle": "Billing",
      "organization": "Microsoft Inc.",
      "phone": "1-245-534-2242",
      "addressMailing": {
        "address1": "3400 State St",
        "city": "Chicago",
        "state": "IL",
        "country": "United States",
        "postalCode": "67098"
      }
    },
    "contactAdmin": {
      "email": "admin@email.com",
      "fax": "1-245-534-2242",
      "nameFirst": "John",
      "nameLast": "Doe",
      "nameMiddle": "",
      "jobTitle": "Admin",
      "organization": "Microsoft Inc.",
      "phone": "1-245-534-2242",
      "addressMailing": {
        "address1": "3400 State St",
        "city": "Chicago",
        "state": "IL",
        "country": "United States",
        "postalCode": "67098"
      }
    },
    "contactRegistrant": {
      "email": "registrant@email.com",
      "fax": "1-245-534-2242",
      "nameFirst": "John",
      "nameLast": "Doe",
      "nameMiddle": "",
      "jobTitle": "Registrant",
      "organization": "Microsoft Inc.",
      "phone": "1-245-534-2242",
      "addressMailing": {
        "address1": "3400 State St",
        "city": "Chicago",
        "state": "IL",
        "country": "United States",
        "postalCode": "67098"
      }
    }
  }
}

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-11-01/examples/CreateAppServiceDomain.json
// this example is just showing the usage of "Domains_CreateOrUpdate" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this ResourceGroupResource created on azure
// for more information of creating ResourceGroupResource, please refer to the document of ResourceGroupResource
string subscriptionId = "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
string resourceGroupName = "testrg123";
ResourceIdentifier resourceGroupResourceId = ResourceGroupResource.CreateResourceIdentifier(subscriptionId, resourceGroupName);
ResourceGroupResource resourceGroupResource = client.GetResourceGroupResource(resourceGroupResourceId);

// get the collection of this AppServiceDomainResource
AppServiceDomainCollection collection = resourceGroupResource.GetAppServiceDomains();

// invoke the operation
string domainName = "example.com";
AppServiceDomainData data = new AppServiceDomainData(new AzureLocation("global"))
{
    ContactAdmin = new RegistrationContactInfo("admin@email.com", "John", "Doe", "1-245-534-2242")
    {
        AddressMailing = new RegistrationAddressInfo("3400 State St", "Chicago", "United States", "67098", "IL"),
        Fax = "1-245-534-2242",
        JobTitle = "Admin",
        NameMiddle = "",
        Organization = "Microsoft Inc.",
    },
    ContactBilling = new RegistrationContactInfo("billing@email.com", "John", "Doe", "1-245-534-2242")
    {
        AddressMailing = new RegistrationAddressInfo("3400 State St", "Chicago", "United States", "67098", "IL"),
        Fax = "1-245-534-2242",
        JobTitle = "Billing",
        NameMiddle = "",
        Organization = "Microsoft Inc.",
    },
    ContactRegistrant = new RegistrationContactInfo("registrant@email.com", "John", "Doe", "1-245-534-2242")
    {
        AddressMailing = new RegistrationAddressInfo("3400 State St", "Chicago", "United States", "67098", "IL"),
        Fax = "1-245-534-2242",
        JobTitle = "Registrant",
        NameMiddle = "",
        Organization = "Microsoft Inc.",
    },
    ContactTech = new RegistrationContactInfo("tech@email.com", "John", "Doe", "1-245-534-2242")
    {
        AddressMailing = new RegistrationAddressInfo("3400 State St", "Chicago", "United States", "67098", "IL"),
        Fax = "1-245-534-2242",
        JobTitle = "Tech",
        NameMiddle = "",
        Organization = "Microsoft Inc.",
    },
    IsDomainPrivacyEnabled = false,
    IsAutoRenew = true,
    Consent = new DomainPurchaseConsent
    {
        AgreementKeys = { "agreementKey1" },
        AgreedBy = "192.0.2.1",
        AgreedOn = DateTimeOffset.Parse("2021-09-10T19:30:53Z"),
    },
    DnsType = AppServiceDnsType.DefaultDomainRegistrarDns,
    AuthCode = "exampleAuthCode",
    Tags = { },
};
ArmOperation<AppServiceDomainResource> lro = await collection.CreateOrUpdateAsync(WaitUntil.Completed, domainName, data);
AppServiceDomainResource result = lro.Value;

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
AppServiceDomainData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Respuesta de muestra

status code:: 200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.DomainRegistration/domains/example.com",
  "name": "example.com",
  "type": "Microsoft.DomainRegistration/domains",
  "location": "global",
  "tags": {},
  "properties": {
    "authCode": "exampleAuthCode",
    "registrationStatus": "Active",
    "provisioningState": "Succeeded",
    "nameServers": [
      "ns01.ote.domaincontrol.com",
      "ns02.ote.domaincontrol.com"
    ],
    "privacy": false,
    "createdTime": "2021-09-10T19:30:53Z",
    "expirationTime": "2022-09-10T19:30:53Z",
    "autoRenew": true,
    "readyForDnsRecordManagement": true,
    "managedHostNames": [],
    "domainNotRenewableReasons": [
      "ExpirationNotInRenewalTimeRange"
    ],
    "dnsType": "DefaultDomainRegistrarDns",
    "consent": {
      "agreementKeys": [
        "agreementKey1"
      ],
      "agreedBy": "192.0.2.1",
      "agreedAt": "2021-09-10T19:30:53Z"
    },
    "contactTech": {
      "email": "tech@email.com",
      "fax": "1-245-534-2242",
      "nameFirst": "John",
      "nameLast": "Doe",
      "nameMiddle": "",
      "jobTitle": "Tech",
      "organization": "Microsoft Inc.",
      "phone": "1-245-534-2242",
      "addressMailing": {
        "address1": "3400 State St",
        "city": "Chicago",
        "state": "IL",
        "country": "United States",
        "postalCode": "67098"
      }
    },
    "contactBilling": {
      "email": "billing@email.com",
      "fax": "1-245-534-2242",
      "nameFirst": "John",
      "nameLast": "Doe",
      "nameMiddle": "",
      "jobTitle": "Billing",
      "organization": "Microsoft Inc.",
      "phone": "1-245-534-2242",
      "addressMailing": {
        "address1": "3400 State St",
        "city": "Chicago",
        "state": "IL",
        "country": "United States",
        "postalCode": "67098"
      }
    },
    "contactAdmin": {
      "email": "admin@email.com",
      "fax": "1-245-534-2242",
      "nameFirst": "John",
      "nameLast": "Doe",
      "nameMiddle": "",
      "jobTitle": "Admin",
      "organization": "Microsoft Inc.",
      "phone": "1-245-534-2242",
      "addressMailing": {
        "address1": "3400 State St",
        "city": "Chicago",
        "state": "IL",
        "country": "United States",
        "postalCode": "67098"
      }
    },
    "contactRegistrant": {
      "email": "registrant@email.com",
      "fax": "1-245-534-2242",
      "nameFirst": "John",
      "nameLast": "Doe",
      "nameMiddle": "",
      "jobTitle": "Registrant",
      "organization": "Microsoft Inc.",
      "phone": "1-245-534-2242",
      "addressMailing": {
        "address1": "3400 State St",
        "city": "Chicago",
        "state": "IL",
        "country": "United States",
        "postalCode": "67098"
      }
    }
  }
}

status code:: 202

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.DomainRegistration/domains/example.com",
  "name": "example.com",
  "type": "Microsoft.DomainRegistration/domains",
  "location": "global",
  "tags": {},
  "properties": {
    "authCode": "exampleAuthCode",
    "registrationStatus": "Active",
    "provisioningState": "Succeeded",
    "nameServers": [
      "ns01.ote.domaincontrol.com",
      "ns02.ote.domaincontrol.com"
    ],
    "privacy": false,
    "createdTime": "2021-09-10T19:30:53Z",
    "expirationTime": "2022-09-10T19:30:53Z",
    "autoRenew": true,
    "readyForDnsRecordManagement": true,
    "managedHostNames": [],
    "domainNotRenewableReasons": [
      "ExpirationNotInRenewalTimeRange"
    ],
    "dnsType": "DefaultDomainRegistrarDns",
    "consent": {
      "agreementKeys": [
        "agreementKey1"
      ],
      "agreedBy": "192.0.2.1",
      "agreedAt": "2021-09-10T19:30:53Z"
    },
    "contactTech": {
      "email": "tech@email.com",
      "fax": "1-245-534-2242",
      "nameFirst": "John",
      "nameLast": "Doe",
      "nameMiddle": "",
      "jobTitle": "Tech",
      "organization": "Microsoft Inc.",
      "phone": "1-245-534-2242",
      "addressMailing": {
        "address1": "3400 State St",
        "city": "Chicago",
        "state": "IL",
        "country": "United States",
        "postalCode": "67098"
      }
    },
    "contactBilling": {
      "email": "billing@email.com",
      "fax": "1-245-534-2242",
      "nameFirst": "John",
      "nameLast": "Doe",
      "nameMiddle": "",
      "jobTitle": "Billing",
      "organization": "Microsoft Inc.",
      "phone": "1-245-534-2242",
      "addressMailing": {
        "address1": "3400 State St",
        "city": "Chicago",
        "state": "IL",
        "country": "United States",
        "postalCode": "67098"
      }
    },
    "contactAdmin": {
      "email": "admin@email.com",
      "fax": "1-245-534-2242",
      "nameFirst": "John",
      "nameLast": "Doe",
      "nameMiddle": "",
      "jobTitle": "Admin",
      "organization": "Microsoft Inc.",
      "phone": "1-245-534-2242",
      "addressMailing": {
        "address1": "3400 State St",
        "city": "Chicago",
        "state": "IL",
        "country": "United States",
        "postalCode": "67098"
      }
    },
    "contactRegistrant": {
      "email": "registrant@email.com",
      "fax": "1-245-534-2242",
      "nameFirst": "John",
      "nameLast": "Doe",
      "nameMiddle": "",
      "jobTitle": "Registrant",
      "organization": "Microsoft Inc.",
      "phone": "1-245-534-2242",
      "addressMailing": {
        "address1": "3400 State St",
        "city": "Chicago",
        "state": "IL",
        "country": "United States",
        "postalCode": "67098"
      }
    }
  }
}

Definiciones

Nombre	Description
Address	Información de dirección para el registro de dominio.
AzureResourceType	Tipo del recurso de Azure al que se asigna el nombre de host.
Contact	Información de contacto para el registro de dominio. Si la opción "Privacidad del dominio" no está seleccionada, la información de contacto se pone a disposición públicamente a través de los directorios whois según los requisitos de la ICANN.
CustomHostNameDnsRecordType	Tipo del registro DNS.
DefaultErrorResponse	Respuesta de error de App Service.
Details
DnsType	Tipo DNS actual
Domain	Información sobre un dominio.
DomainPurchaseConsent	Objeto de consentimiento de compra de dominio, que representa la aceptación de acuerdos legales aplicables.
DomainStatus	Estado del registro de dominio.
Error	Modelo de error.
HostName	Detalles de un nombre de host derivado de un dominio.
HostNameType	Tipo del nombre de host.
ProvisioningState	Estado de aprovisionamiento de dominio.
ResourceNotRenewableReason	Razones por las que el dominio no es renovable.

Address

Object

Información de dirección para el registro de dominio.

Nombre	Tipo	Description
address1	string	Primera línea de una dirección.
address2	string	Segunda línea de la dirección. Opcional.
city	string	Ciudad de la dirección.
country	string	País de la dirección.
postalCode	string	Código postal de la dirección.
state	string	Estado o provincia de la dirección.

AzureResourceType

Enumeración

Tipo del recurso de Azure al que se asigna el nombre de host.

Valor	Description
TrafficManager
Website

Contact

Object

Información de contacto para el registro de dominio. Si la opción "Privacidad del dominio" no está seleccionada, la información de contacto se pone a disposición públicamente a través de los directorios whois según los requisitos de la ICANN.

Nombre	Tipo	Description
addressMailing	Address	Dirección postal.
email	string	Dirección de correo electrónico.
fax	string	Número de fax.
jobTitle	string	Puesto.
nameFirst	string	Nombre.
nameLast	string	Apellido.
nameMiddle	string	Segundo nombre.
organization	string	El contacto de la organización pertenece.
phone	string	Número de teléfono.

CustomHostNameDnsRecordType

Enumeración

Tipo del registro DNS.

Valor	Description
A
CName

DefaultErrorResponse

Object

Respuesta de error de App Service.

Nombre	Tipo	Description
error	Error	Modelo de error.

Details

Object

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar mediante programación el error.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

DnsType

Enumeración

Tipo DNS actual

Valor	Description
AzureDns
DefaultDomainRegistrarDns

Domain

Object

Información sobre un dominio.

Nombre	Tipo	Valor predeterminado	Description
id	string		Identificador de recurso.
kind	string		Tipo de recurso. Si el recurso es una aplicación, puede consultar https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference para obtener más información sobre los valores admitidos para el tipo.
location	string		Ubicación del recurso.
name	string		Nombre del recurso.
properties.authCode	string
properties.autoRenew	boolean	True	`true` si el dominio se debe renovar automáticamente; de lo contrario, `false`.
properties.consent	DomainPurchaseConsent		Consentimiento del contrato legal.
properties.contactAdmin	Contact		Contacto administrativo.
properties.contactBilling	Contact		Contacto de facturación.
properties.contactRegistrant	Contact		Contacto de registrador.
properties.contactTech	Contact		Contacto técnico.
properties.createdTime	string (date-time)		Marca de tiempo de creación de dominio.
properties.dnsType	DnsType		Tipo DNS actual
properties.dnsZoneId	string		Zona DNS de Azure que se va a usar
properties.domainNotRenewableReasons	ResourceNotRenewableReason[]		Razones por las que el dominio no es renovable.
properties.expirationTime	string (date-time)		Marca de tiempo de expiración del dominio.
properties.lastRenewedTime	string (date-time)		Marca de tiempo en la que se renovó el dominio la última vez.
properties.managedHostNames	HostName[]		Todos los nombres de host derivados del dominio y asignados a los recursos de Azure.
properties.nameServers	string[]		Servidores de nombres.
properties.privacy	boolean		`true` si la privacidad del dominio está habilitada para este dominio; de lo contrario, `false`.
properties.provisioningState	ProvisioningState		Estado de aprovisionamiento de dominio.
properties.readyForDnsRecordManagement	boolean		`true` si Azure puede asignar este dominio a las aplicaciones de App Service; de lo contrario, `false`. Este valor se `true` si el estado del registro de dominio está activo y se hospeda en servidores de nombres a los que Azure tiene acceso mediante programación.
properties.registrationStatus	DomainStatus		Estado del registro de dominio.
properties.targetDnsType	DnsType		Tipo DNS de destino (se usaría para la migración)
tags	object		Etiquetas de recursos.
type	string		Tipo de recurso.

DomainPurchaseConsent

Object

Objeto de consentimiento de compra de dominio, que representa la aceptación de acuerdos legales aplicables.

Nombre	Tipo	Description
agreedAt	string (date-time)	Marca de tiempo cuando se aceptaron los acuerdos.
agreedBy	string	Dirección IP del cliente.
agreementKeys	string[]	Lista de claves de contrato legales aplicables. Esta lista se puede recuperar mediante listLegalAgreements API en `TopLevelDomain` recurso.

DomainStatus

Enumeración

Estado del registro de dominio.

Valor	Description
Active
Awaiting
Cancelled
Confiscated
Disabled
Excluded
Expired
Failed
Held
JsonConverterFailed
Locked
Parked
Pending
Reserved
Reverted
Suspended
Transferred
Unknown
Unlocked
Unparked
Updated

Error

Object

Modelo de error.

Nombre	Tipo	Description
code	string	Cadena estandarizada para identificar mediante programación el error.
details	Details[]	Errores detallados.
innererror	string	Más información para depurar el error.
message	string	Descripción detallada del error e información de depuración.
target	string	Descripción detallada del error e información de depuración.

HostName

Object

Detalles de un nombre de host derivado de un dominio.

Nombre	Tipo	Description
azureResourceName	string	Nombre del recurso de Azure al que se asigna el nombre de host. Si se asigna a un Administrador de tráfico, será el nombre de Traffic Manager; de lo contrario, será el nombre de la aplicación.
azureResourceType	AzureResourceType	Tipo del recurso de Azure al que se asigna el nombre de host.
customHostNameDnsRecordType	CustomHostNameDnsRecordType	Tipo del registro DNS.
hostNameType	HostNameType	Tipo del nombre de host.
name	string	Nombre del nombre de host.
siteNames	string[]	Lista de aplicaciones a las que se asigna el nombre de host. Esta lista solo tendrá más de una aplicación si el nombre de host apunta a un Administrador de tráfico.

HostNameType

Enumeración

Tipo del nombre de host.

Valor	Description
Managed
Verified

ProvisioningState

Enumeración

Estado de aprovisionamiento de dominio.

Valor	Description
Canceled
Deleting
Failed
InProgress
Succeeded

ResourceNotRenewableReason

Enumeración

Razones por las que el dominio no es renovable.

Valor	Description
ExpirationNotInRenewalTimeRange
RegistrationStatusNotSupportedForRenewal
SubscriptionNotActive

Compartir a través de

Domains - Create Or Update

Parámetros de identificador URI

Cuerpo de la solicitud

Respuestas

Seguridad

azure_auth

Ámbitos

Ejemplos

Create App Service Domain

Solicitud de ejemplo

Respuesta de muestra

Definiciones

Address

AzureResourceType

Contact

CustomHostNameDnsRecordType

DefaultErrorResponse

Details

DnsType

Domain

DomainPurchaseConsent

DomainStatus

Error

HostName

HostNameType

ProvisioningState

ResourceNotRenewableReason