Domains - Update Ownership Identifier

Service:

App Service

API Version:

2023-12-01

Description for Creates an ownership identifier for a domain or updates identifier details for an existing identifier

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DomainRegistration/domains/{domainName}/domainOwnershipIdentifiers/{name}?api-version=2023-12-01

URI Parameters

Name	In	Required	Type	Description
domainName	path	True	string	Name of domain.
name	path	True	string	Name of identifier.
resourceGroupName	path	True	string	Name of the resource group to which the resource belongs. Regex pattern: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	Your Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000).
api-version	query	True	string	API Version

Request Body

Name	Type	Description
kind	string	Kind of resource.
properties.ownershipId	string	Ownership Id.

Responses

Name	Type	Description
200 OK	DomainOwnershipIdentifier	OK
Other Status Codes	DefaultErrorResponse	App Service error response.

Security

azure_auth

Azure Active Directory OAuth2 Flow

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

Update App Service Domain OwnershipIdentifier

Sample Request

HTTP

PATCH https://management.azure.com/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.DomainRegistration/domains/example.com/domainOwnershipIdentifiers/SampleOwnershipId?api-version=2023-12-01

{
  "properties": {
    "ownershipId": "SampleOwnershipId"
  }
}

Sample Response

Status code:

200

{
  "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.DomainRegistration/domains/example.com/domainownershipidentifiers/SampleOwnershipId",
  "name": "SampleOwnershipId",
  "type": "Microsoft.DomainRegistration/domains/domainownershipidentifiers",
  "properties": {
    "ownershipId": "SampleOwnershipId"
  }
}

Definitions

Name	Description
DefaultErrorResponse	App Service error response.
Details
DomainOwnershipIdentifier	Domain ownership Identifier.
Error	Error model.

DefaultErrorResponse

App Service error response.

Name	Type	Description
error	Error	Error model.

Details

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.

DomainOwnershipIdentifier

Domain ownership Identifier.

Name	Type	Description
id	string	Resource Id.
kind	string	Kind of resource.
name	string	Resource Name.
properties.ownershipId	string	Ownership Id.
type	string	Resource type.

Error

Error model.

Name	Type	Description
code	string	Standardized string to programmatically identify the error.
details	Details[]	Detailed errors.
innererror	string	More information to debug error.
message	string	Detailed error description and debugging information.
target	string	Detailed error description and debugging information.