azure.mgmt.web.v2015_04_01.operations.TopLevelDomainsOperations.yml

### YamlMime:PythonClass
uid: azure.mgmt.web.v2015_04_01.operations.TopLevelDomainsOperations
name: TopLevelDomainsOperations
fullName: azure.mgmt.web.v2015_04_01.operations.TopLevelDomainsOperations
module: azure.mgmt.web.v2015_04_01.operations
inheritances:
- builtins.object
summary: "> [!WARNING]\n> DO NOT instantiate this class directly.\n>\n> \n>\n> Instead,\
  \ you should access the following operations through\n>\n> <xref:azure.mgmt.web.v2015_04_01.WebSiteManagementClient>'s\n\
  >\n> <xref:top_level_domains> attribute.\n>"
constructor:
  syntax: TopLevelDomainsOperations(*args, **kwargs)
methods:
- uid: azure.mgmt.web.v2015_04_01.operations.TopLevelDomainsOperations.get
  name: get
  summary: 'Get details of a top-level domain.


    Get details of a top-level domain.'
  signature: 'get(name: str, **kwargs: Any) -> TopLevelDomain'
  parameters:
  - name: name
    description: Name of the top-level domain. Required.
    isRequired: true
    types:
    - <xref:str>
  return:
    description: TopLevelDomain or the result of cls(response)
    types:
    - <xref:azure.mgmt.web.v2015_04_01.models.TopLevelDomain>
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2015_04_01.operations.TopLevelDomainsOperations.list
  name: list
  summary: 'Get all top-level domains supported for registration.


    Get all top-level domains supported for registration.'
  signature: 'list(**kwargs: Any) -> Iterable[TopLevelDomain]'
  return:
    description: An iterator like instance of either TopLevelDomain or the result
      of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.web.v2015_04_01.models.TopLevelDomain>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
- uid: azure.mgmt.web.v2015_04_01.operations.TopLevelDomainsOperations.list_agreements
  name: list_agreements
  summary: 'Gets all legal agreements that user needs to accept before purchasing
    a domain.


    Gets all legal agreements that user needs to accept before purchasing a domain.'
  signature: 'list_agreements(name: str, agreement_option: _models.TopLevelDomainAgreementOption,
    *, content_type: str = ''application/json'', **kwargs: Any) -> Iterable[''_models.TldLegalAgreement'']'
  parameters:
  - name: name
    description: Name of the top-level domain. Required.
    isRequired: true
    types:
    - <xref:str>
  - name: agreement_option
    description: 'Domain agreement options. Is either a TopLevelDomainAgreementOption

      type or a IO[bytes] type. Required.'
    isRequired: true
    types:
    - <xref:azure.mgmt.web.v2015_04_01.models.TopLevelDomainAgreementOption>
    - <xref:typing.IO>[<xref:bytes>]
  return:
    description: An iterator like instance of either TldLegalAgreement or the result
      of cls(response)
    types:
    - <xref:azure.core.paging.ItemPaged>[<xref:azure.mgmt.web.v2015_04_01.models.TldLegalAgreement>]
  exceptions:
  - type: azure.core.exceptions.HttpResponseError
attributes:
- uid: azure.mgmt.web.v2015_04_01.operations.TopLevelDomainsOperations.models
  name: models
  signature: models = <module 'azure.mgmt.web.v2015_04_01.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.9\\x64\\Lib\\site-packages\\azure\\mgmt\\web\\v2015_04_01\\models\\__init__.py'>