{"note":"OpenAPI conversion -- returning structured metadata","name":"azure-com-web-domains","description":"Domains API Client","version":"2018-02-01","base_url":"https://management.azure.com","endpoints":15,"raw":"@lap v0.3\n# Machine-readable API spec. Each @endpoint block is one API call.\n@api Domains API Client\n@base https://management.azure.com\n@version 2018-02-01\n@auth OAuth2\n@common_fields {subscriptionId: any # Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)., api-version: any # API Version}\n@endpoints 15\n@toc subscriptions(15)\n\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/checkDomainAvailability\n@desc Check if a domain is available for registration.\n@required {identifier: any # Name of the domain.}\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/domains\n@desc Get all domains in a subscription.\n@returns(200) OK\n\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/generateSsoRequest\n@desc Generate a single sign-on request for the domain management portal.\n@returns(200) OK\n\n@endpoint POST /subscriptions/{subscriptionId}/providers/Microsoft.DomainRegistration/listDomainRecommendations\n@desc Get domain name recommendations based on keywords.\n@required {parameters: map # Search parameters for domain name recommendations.}\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains\n@desc Get all domains in a resource group.\n@required {resourceGroupName: any # Name of the resource group to which the resource belongs.}\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}\n@desc Get a domain.\n@required {resourceGroupName: any # Name of the resource group to which the resource belongs., domainName: any # Name of the domain.}\n@returns(200) OK\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}\n@desc Creates or updates a domain.\n@required {resourceGroupName: any # Name of the resource group to which the resource belongs., domainName: any # Name of the domain., domain: map # Domain registration information.}\n@returns(200) Domain purchase was successful.\n@returns(202) Domain purchase is in progress.\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}\n@desc Delete a domain.\n@required {resourceGroupName: any # Name of the resource group to which the resource belongs., domainName: any # Name of the domain.}\n@optional {forceHardDeleteDomain: any # Specify true to delete the domain immediately. The default is false which deletes the domain after 24 hours.}\n@returns(200) Successfully deleted domain.\n@returns(204) Domain does not exist in Azure database probably because it has already been deleted\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}\n@desc Creates or updates a domain.\n@required {resourceGroupName: any # Name of the resource group to which the resource belongs., domainName: any # Name of the domain., domain: map # Domain registration information.}\n@returns(200) Domain purchase was successful.\n@returns(202) Domain purchase is in progress.\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers\n@desc Lists domain ownership identifiers.\n@required {resourceGroupName: any # Name of the resource group to which the resource belongs., domainName: any # Name of domain.}\n@returns(200) OK\n\n@endpoint GET /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers/{name}\n@desc Get ownership identifier for domain\n@required {resourceGroupName: any # Name of the resource group to which the resource belongs., domainName: any # Name of domain., name: any # Name of identifier.}\n@returns(200) OK\n\n@endpoint PUT /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers/{name}\n@desc Creates an ownership identifier for a domain or updates identifier details for an existing identifier\n@required {resourceGroupName: any # Name of the resource group to which the resource belongs., domainName: any # Name of domain., name: any # Name of identifier., domainOwnershipIdentifier: map # A JSON representation of the domain ownership properties.}\n@returns(200) OK\n\n@endpoint DELETE /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers/{name}\n@desc Delete ownership identifier for domain\n@required {resourceGroupName: any # Name of the resource group to which the resource belongs., domainName: any # Name of domain., name: any # Name of identifier.}\n@returns(200) Successfully deleted domain ownership identifier.\n@returns(204) Domain ownership identifier does not exist.\n\n@endpoint PATCH /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers/{name}\n@desc Creates an ownership identifier for a domain or updates identifier details for an existing identifier\n@required {resourceGroupName: any # Name of the resource group to which the resource belongs., domainName: any # Name of domain., name: any # Name of identifier., domainOwnershipIdentifier: map # A JSON representation of the domain ownership properties.}\n@returns(200) OK\n\n@endpoint POST /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/renew\n@desc Renew a domain.\n@required {resourceGroupName: any # Name of the resource group to which the resource belongs., domainName: any # Name of the domain.}\n@returns(200) Domain renewal was successful.\n@returns(202) Domain renewal in progress.\n@returns(204) Domain does not exist.\n@errors {400: Malformed domain renewal request., 500: Domain renewal request failed.}\n\n@end\n"}