azure.mgmt.web.v2023_12_01.models.DomainPatchResource.yml

### YamlMime:PythonClass
uid: azure.mgmt.web.v2023_12_01.models.DomainPatchResource
name: DomainPatchResource
fullName: azure.mgmt.web.v2023_12_01.models.DomainPatchResource
module: azure.mgmt.web.v2023_12_01.models
inheritances:
- azure.mgmt.web.v2023_12_01.models._models_py3.ProxyOnlyResource
summary: 'ARM resource for a domain.


  Variables are only populated by the server, and will be ignored when sending a request.'
constructor:
  syntax: 'DomainPatchResource(*, kind: str | None = None, contact_admin: _models.Contact
    | None = None, contact_billing: _models.Contact | None = None, contact_registrant:
    _models.Contact | None = None, contact_tech: _models.Contact | None = None, privacy:
    bool | None = None, auto_renew: bool = True, consent: _models.DomainPurchaseConsent
    | None = None, dns_type: str | _models.DnsType | None = None, dns_zone_id: str
    | None = None, target_dns_type: str | _models.DnsType | None = None, auth_code:
    str | None = None, **kwargs: Any)'
  keywordOnlyParameters:
  - name: kind
    description: Kind of resource.
    types:
    - <xref:str>
  - name: contact_admin
    description: Administrative contact.
    types:
    - <xref:azure.mgmt.web.v2023_12_01.models.Contact>
  - name: contact_billing
    description: Billing contact.
    types:
    - <xref:azure.mgmt.web.v2023_12_01.models.Contact>
  - name: contact_registrant
    description: Registrant contact.
    types:
    - <xref:azure.mgmt.web.v2023_12_01.models.Contact>
  - name: contact_tech
    description: Technical contact.
    types:
    - <xref:azure.mgmt.web.v2023_12_01.models.Contact>
  - name: privacy
    description: '`<code>true</code>` if domain privacy is enabled for this domain;

      otherwise, `<code>false</code>`.'
    types:
    - <xref:bool>
  - name: auto_renew
    description: '`<code>true</code>` if the domain should be automatically renewed;

      otherwise, `<code>false</code>`.'
    defaultValue: 'True'
    types:
    - <xref:bool>
  - name: consent
    description: Legal agreement consent.
    types:
    - <xref:azure.mgmt.web.v2023_12_01.models.DomainPurchaseConsent>
  - name: dns_type
    description: 'Current DNS type. Known values are: "AzureDns" and

      "DefaultDomainRegistrarDns".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.web.v2023_12_01.models.DnsType>
  - name: dns_zone_id
    description: Azure DNS Zone to use.
    types:
    - <xref:str>
  - name: target_dns_type
    description: 'Target DNS type (would be used for migration). Known values are:

      "AzureDns" and "DefaultDomainRegistrarDns".'
    types:
    - <xref:str>
    - <xref:azure.mgmt.web.v2023_12_01.models.DnsType>
  - name: auth_code
    types:
    - <xref:str>
variables:
- description: Resource Id.
  name: id
  types:
  - <xref:str>
- description: Resource Name.
  name: name
  types:
  - <xref:str>
- description: Kind of resource.
  name: kind
  types:
  - <xref:str>
- description: Resource type.
  name: type
  types:
  - <xref:str>
- description: Administrative contact.
  name: contact_admin
  types:
  - <xref:azure.mgmt.web.v2023_12_01.models.Contact>
- description: Billing contact.
  name: contact_billing
  types:
  - <xref:azure.mgmt.web.v2023_12_01.models.Contact>
- description: Registrant contact.
  name: contact_registrant
  types:
  - <xref:azure.mgmt.web.v2023_12_01.models.Contact>
- description: Technical contact.
  name: contact_tech
  types:
  - <xref:azure.mgmt.web.v2023_12_01.models.Contact>
- description: 'Domain registration status. Known values are: "Active", "Awaiting",

    "Cancelled", "Confiscated", "Disabled", "Excluded", "Expired", "Failed", "Held",
    "Locked",

    "Parked", "Pending", "Reserved", "Reverted", "Suspended", "Transferred", "Unknown",
    "Unlocked",

    "Unparked", "Updated", and "JsonConverterFailed".'
  name: registration_status
  types:
  - <xref:str>
  - <xref:azure.mgmt.web.v2023_12_01.models.DomainStatus>
- description: 'Domain provisioning state. Known values are: "Succeeded", "Failed",

    "Canceled", "InProgress", and "Deleting".'
  name: provisioning_state
  types:
  - <xref:str>
  - <xref:azure.mgmt.web.v2023_12_01.models.ProvisioningState>
- description: Name servers.
  name: name_servers
  types:
  - <xref:list>[<xref:str>]
- description: '`<code>true</code>` if domain privacy is enabled for this domain;

    otherwise, `<code>false</code>`.'
  name: privacy
  types:
  - <xref:bool>
- description: Domain creation timestamp.
  name: created_time
  types:
  - <xref:datetime.datetime>
- description: Domain expiration timestamp.
  name: expiration_time
  types:
  - <xref:datetime.datetime>
- description: Timestamp when the domain was renewed last time.
  name: last_renewed_time
  types:
  - <xref:datetime.datetime>
- description: '`<code>true</code>` if the domain should be automatically renewed;

    otherwise, `<code>false</code>`.'
  name: auto_renew
  types:
  - <xref:bool>
- description: "`<code>true</code>` if Azure can assign this\ndomain to App Service\
    \ apps; otherwise, `<code>false</code>`. This value will be\n`<code>true</code>`\
    \ if domain registration status is active and\n\n   it is hosted on name servers\
    \ Azure has programmatic access to."
  name: ready_for_dns_record_management
  types:
  - <xref:bool>
- description: 'All hostnames derived from the domain and assigned to Azure

    resources.'
  name: managed_host_names
  types:
  - <xref:list>[<xref:azure.mgmt.web.v2023_12_01.models.HostName>]
- description: Legal agreement consent.
  name: consent
  types:
  - <xref:azure.mgmt.web.v2023_12_01.models.DomainPurchaseConsent>
- description: Reasons why domain is not renewable.
  name: domain_not_renewable_reasons
  types:
  - <xref:list>[<xref:str>
  - <xref:azure.mgmt.web.v2023_12_01.models.ResourceNotRenewableReason>]
- description: 'Current DNS type. Known values are: "AzureDns" and "DefaultDomainRegistrarDns".'
  name: dns_type
  types:
  - <xref:str>
  - <xref:azure.mgmt.web.v2023_12_01.models.DnsType>
- description: Azure DNS Zone to use.
  name: dns_zone_id
  types:
  - <xref:str>
- description: 'Target DNS type (would be used for migration). Known values are:

    "AzureDns" and "DefaultDomainRegistrarDns".'
  name: target_dns_type
  types:
  - <xref:str>
  - <xref:azure.mgmt.web.v2023_12_01.models.DnsType>
- name: auth_code
  types:
  - <xref:str>