Domains - Create Or Update

Referencia

Szolgáltatás:: App Service

API-verzió:: 2024-11-01

A tartomány létrehozása vagy frissítése leírás.

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

URI-paraméterek

Name	In	Kötelező	Típus	Description
domainName	path	True	string pattern: [a-zA-Z0-9][a-zA-Z0-9\.-]+	A tartomány neve.
resourceGroupName	path	True	string minLength: 1 maxLength: 90 pattern: ^[-\w\._]+[^\.]$	Annak az erőforráscsoportnak a neve, amelyhez az erőforrás tartozik.
subscriptionId	path	True	string	Az Ön Azure előfizetési azonosítója. Ez egy GUID formátumú sztring (például 000000000-0000-0000-0000-0000000000).
api-version	query	True	string	API-verzió

Kérelem törzse

Name	Kötelező	Típus	Description
location	True	string	Erőforrás helye.
properties.consent	True	DomainPurchaseConsent	Jogi hozzájárulás.
properties.contactAdmin	True	Contact	Rendszergazdai kapcsolattartó.
properties.contactBilling	True	Contact	Számlázási kapcsolattartó.
properties.contactRegistrant	True	Contact	Regisztráló kapcsolattartó.
properties.contactTech	True	Contact	Műszaki kapcsolattartó.
kind		string	Erőforrás típusa. Ha az erőforrás egy alkalmazás, a https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference a természetben támogatott értékek részleteiért tekintse meg.
properties.authCode		string
properties.autoRenew		boolean	`true`, hogy a tartományt automatikusan meg kell-e újítani; ellenkező esetben `false`.
properties.dnsType		DnsType	Aktuális DNS-típus
properties.dnsZoneId		string	Használandó Azure DNS-zóna
properties.privacy		boolean	`true`, hogy engedélyezve van-e a tartomány adatvédelem; ellenkező esetben `false`.
properties.targetDnsType		DnsType	Cél DNS-típus (migráláshoz használható)
tags		object	Erőforráscímkék.

Válaszok

Name	Típus	Description
200 OK	Domain	A tartományvásárlás sikeres volt.
202 Accepted	Domain	A tartományvásárlás folyamatban van.
Other Status Codes	DefaultErrorResponse	App Service-hibaválasz.

Biztonság

azure_auth

Azure Active Directory OAuth2-folyamat

Típus: oauth2
Folyamat: implicit
Engedélyezési URL: https://login.microsoftonline.com/common/oauth2/authorize

Hatókörök

Name	Description
user_impersonation	a felhasználói fiók megszemélyesítése

Példák

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

Mintaválasz

Állapotkód:: 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"
      }
    }
  }
}

Állapotkód:: 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"
      }
    }
  }
}

Definíciók

Name	Description
Address	A tartományregisztráció címadatai.
AzureResourceType	Annak az Azure-erőforrásnak a típusa, amelyhez a gazdagépnév hozzá van rendelve.
Contact	A tartományregisztráció kapcsolattartási adatai. Ha a "Domain Privacy" (Tartomány adatainak védelme) lehetőség nincs kiválasztva, akkor a kapcsolattartási adatok az ICANN-követelményeknek megfelelően nyilvánosan elérhetővé válnak a Whois-címtárakon keresztül.
CustomHostNameDnsRecordType	A DNS-rekord típusa.
DefaultErrorResponse	App Service-hibaválasz.
Details
DnsType	Aktuális DNS-típus
Domain	Egy tartományra vonatkozó információk.
DomainPurchaseConsent	A tartományvásárlási hozzájárulás objektuma, amely a vonatkozó jogi megállapodások elfogadását jelenti.
DomainStatus	Tartományregisztrációs állapot.
Error	Hibamodell.
HostName	A tartományból származtatott gazdagépnév részletei.
HostNameType	A gazdagépnév típusa.
ProvisioningState	Tartománykiépítési állapot.
ResourceNotRenewableReason	A tartomány nem megújítható okai.

Address

Objektum

A tartományregisztráció címadatai.

Name	Típus	Description
address1	string	Cím első sora.
address2	string	A Cím második sora. Opcionális.
city	string	A cím városát.
country	string	A cím országa.
postalCode	string	A cím irányítószáma.
state	string	A cím állama vagy tartománya.

AzureResourceType

Enumerálás

Annak az Azure-erőforrásnak a típusa, amelyhez a gazdagépnév hozzá van rendelve.

Érték	Description
TrafficManager
Website

Contact

Objektum

A tartományregisztráció kapcsolattartási adatai. Ha a "Domain Privacy" (Tartomány adatainak védelme) lehetőség nincs kiválasztva, akkor a kapcsolattartási adatok az ICANN-követelményeknek megfelelően nyilvánosan elérhetővé válnak a Whois-címtárakon keresztül.

Name	Típus	Description
addressMailing	Address	Levélcím.
email	string	Email cím.
fax	string	Faxszám.
jobTitle	string	Beosztás.
nameFirst	string	Keresztnév.
nameLast	string	Vezetéknév.
nameMiddle	string	Középső név.
organization	string	A szervezeti partner a tagja.
phone	string	Telefonszám.

CustomHostNameDnsRecordType

Enumerálás

A DNS-rekord típusa.

Érték	Description
A
CName

DefaultErrorResponse

Objektum

App Service-hibaválasz.

Name	Típus	Description
error	Error	Hibamodell.

Details

Objektum

Name	Típus	Description
code	string	Szabványosított sztring a hiba programozott azonosításához.
message	string	Részletes hibaleírás és hibakeresési információk.
target	string	Részletes hibaleírás és hibakeresési információk.

DnsType

Enumerálás

Aktuális DNS-típus

Érték	Description
AzureDns
DefaultDomainRegistrarDns

Domain

Objektum

Egy tartományra vonatkozó információk.

Name	Típus	Alapértelmezett érték	Description
id	string		Erőforrás-azonosító.
kind	string		Erőforrás típusa. Ha az erőforrás egy alkalmazás, a https://github.com/Azure/app-service-linux-docs/blob/master/Things_You_Should_Know/kind_property.md#app-service-resource-kind-reference a természetben támogatott értékek részleteiért tekintse meg.
location	string		Erőforrás helye.
name	string		Erőforrás neve.
properties.authCode	string
properties.autoRenew	boolean	True	`true`, hogy a tartományt automatikusan meg kell-e újítani; ellenkező esetben `false`.
properties.consent	DomainPurchaseConsent		Jogi hozzájárulás.
properties.contactAdmin	Contact		Rendszergazdai kapcsolattartó.
properties.contactBilling	Contact		Számlázási kapcsolattartó.
properties.contactRegistrant	Contact		Regisztráló kapcsolattartó.
properties.contactTech	Contact		Műszaki kapcsolattartó.
properties.createdTime	string (date-time)		Tartománylétrehozás időbélyege.
properties.dnsType	DnsType		Aktuális DNS-típus
properties.dnsZoneId	string		Használandó Azure DNS-zóna
properties.domainNotRenewableReasons	ResourceNotRenewableReason[]		A tartomány nem megújítható okai.
properties.expirationTime	string (date-time)		Tartomány lejárati időbélyege.
properties.lastRenewedTime	string (date-time)		Időbélyeg, amikor a tartományt legutóbb megújították.
properties.managedHostNames	HostName[]		A tartományból származó és az Azure-erőforrásokhoz rendelt összes gazdagépnév.
properties.nameServers	string[]		Névkiszolgálók.
properties.privacy	boolean		`true`, hogy engedélyezve van-e a tartomány adatvédelem; ellenkező esetben `false`.
properties.provisioningState	ProvisioningState		Tartománykiépítési állapot.
properties.readyForDnsRecordManagement	boolean		`true`, hogy az Azure hozzárendelheti-e ezt a tartományt az App Service-alkalmazásokhoz; ellenkező esetben `false`. Ez az érték `true` lesz, ha a tartományregisztrációs állapot aktív, és az Azure programozott hozzáféréssel rendelkező névkiszolgálókon fut.
properties.registrationStatus	DomainStatus		Tartományregisztrációs állapot.
properties.targetDnsType	DnsType		Cél DNS-típus (migráláshoz használható)
tags	object		Erőforráscímkék.
type	string		Erőforrás típusa.

DomainPurchaseConsent

Objektum

A tartományvásárlási hozzájárulás objektuma, amely a vonatkozó jogi megállapodások elfogadását jelenti.

Name	Típus	Description
agreedAt	string (date-time)	Időbélyeg a megállapodások elfogadásakor.
agreedBy	string	Ügyfél IP-címe.
agreementKeys	string[]	A vonatkozó jogi szerződéskulcsok listája. Ez a lista a ListLegalAgreements API-val kérhető le `TopLevelDomain` erőforrás alatt.

DomainStatus

Enumerálás

Tartományregisztrációs állapot.

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

Error

Objektum

Hibamodell.

Name	Típus	Description
code	string	Szabványosított sztring a hiba programozott azonosításához.
details	Details[]	Részletes hibák.
innererror	string	További információ a hibakereséshez.
message	string	Részletes hibaleírás és hibakeresési információk.
target	string	Részletes hibaleírás és hibakeresési információk.

HostName

Objektum

A tartományból származtatott gazdagépnév részletei.

Name	Típus	Description
azureResourceName	string	Annak az Azure-erőforrásnak a neve, amelyhez a gazdagépnév hozzá van rendelve. Ha egy Traffic Managerhez van rendelve, akkor az lesz a Traffic Manager neve, ellenkező esetben az alkalmazás neve lesz.
azureResourceType	AzureResourceType	Annak az Azure-erőforrásnak a típusa, amelyhez a gazdagépnév hozzá van rendelve.
customHostNameDnsRecordType	CustomHostNameDnsRecordType	A DNS-rekord típusa.
hostNameType	HostNameType	A gazdagépnév típusa.
name	string	A gazdagépnév neve.
siteNames	string[]	Azon alkalmazások listája, amelyekhez a gazdagépnév hozzá van rendelve. Ez a lista csak akkor lesz több alkalmazással, ha a gazdagép neve egy Traffic Managerre mutat.

HostNameType

Enumerálás

A gazdagépnév típusa.

Érték	Description
Managed
Verified

ProvisioningState

Enumerálás

Tartománykiépítési állapot.

Érték	Description
Canceled
Deleting
Failed
InProgress
Succeeded

ResourceNotRenewableReason

Enumerálás

A tartomány nem megújítható okai.

Érték	Description
ExpirationNotInRenewalTimeRange
RegistrationStatusNotSupportedForRenewal
SubscriptionNotActive

Megosztás a következőn keresztül:

Domains - Create Or Update

URI-paraméterek

Kérelem törzse

Válaszok

Biztonság

azure_auth

Hatókörök

Példák

Create App Service Domain

Mintakérelem

Mintaválasz

Definíciók

Address

AzureResourceType

Contact

CustomHostNameDnsRecordType

DefaultErrorResponse

Details

DnsType

Domain

DomainPurchaseConsent

DomainStatus

Error

HostName

HostNameType

ProvisioningState

ResourceNotRenewableReason