Domains - Update Ownership Identifier

Service:

App Service

API Version:

2023-01-01

Description pour Crée un identificateur de propriété pour un domaine ou met à jour les détails de l’identificateur pour un identificateur existant

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

Paramètres URI

Nom	Dans	Obligatoire	Type	Description
domainName	path	True	string	Nom du domaine.
name	path	True	string	Nom de l’identificateur.
resourceGroupName	path	True	string	Nom du groupe de ressources auquel appartient la ressource. Regex pattern: ^[-\w\._\(\)]+[^\.]$
subscriptionId	path	True	string	Votre ID d’abonnement Azure. Il s’agit d’une chaîne au format GUID (par exemple, 000000-0000-0000-0000-000000000000000).
api-version	query	True	string	Version d'API

Corps de la demande

Nom	Type	Description
kind	string	Type de ressource.
properties.ownershipId	string	ID de propriété.

Réponses

Nom	Type	Description
200 OK	DomainOwnershipIdentifier	Ok
Other Status Codes	DefaultErrorResponse	App Service réponse d’erreur.

Sécurité

azure_auth

Flux OAuth2 Azure Active Directory

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

Scopes

Nom	Description
user_impersonation	Emprunter l’identité de votre compte d’utilisateur

Exemples

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-01-01

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

Java

import com.azure.resourcemanager.appservice.fluent.models.DomainOwnershipIdentifierInner;

/**
 * Samples for Domains UpdateOwnershipIdentifier.
 */
public final class Main {
    /*
     * x-ms-original-file: specification/web/resource-manager/Microsoft.DomainRegistration/stable/2023-01-01/examples/
     * UpdateAppServiceDomainOwnershipIdentifier.json
     */
    /**
     * Sample code: Update App Service Domain OwnershipIdentifier.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void updateAppServiceDomainOwnershipIdentifier(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getDomains().updateOwnershipIdentifierWithResponse("testrg123",
            "example.com", "SampleOwnershipId",
            new DomainOwnershipIdentifierInner().withOwnershipId("SampleOwnershipId"),
            com.azure.core.util.Context.NONE);
    }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Python

from azure.identity import DefaultAzureCredential
from azure.mgmt.web import WebSiteManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-web
# USAGE
    python update_app_service_domain_ownership_identifier.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = WebSiteManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="34adfa4f-cedf-4dc0-ba29-b6d1a69ab345",
    )

    response = client.domains.update_ownership_identifier(
        resource_group_name="testrg123",
        domain_name="example.com",
        name="SampleOwnershipId",
        domain_ownership_identifier={"properties": {"ownershipId": "SampleOwnershipId"}},
    )
    print(response)


# x-ms-original-file: specification/web/resource-manager/Microsoft.DomainRegistration/stable/2023-01-01/examples/UpdateAppServiceDomainOwnershipIdentifier.json
if __name__ == "__main__":
    main()

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Go

package armappservice_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/appservice/armappservice/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/738ab25fe76324897f273645906d4a0415068a6c/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2023-01-01/examples/UpdateAppServiceDomainOwnershipIdentifier.json
func ExampleDomainsClient_UpdateOwnershipIdentifier() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armappservice.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewDomainsClient().UpdateOwnershipIdentifier(ctx, "testrg123", "example.com", "SampleOwnershipId", armappservice.DomainOwnershipIdentifier{
		Properties: &armappservice.DomainOwnershipIdentifierProperties{
			OwnershipID: to.Ptr("SampleOwnershipId"),
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.DomainOwnershipIdentifier = armappservice.DomainOwnershipIdentifier{
	// 	Name: to.Ptr("SampleOwnershipId"),
	// 	Type: to.Ptr("Microsoft.DomainRegistration/domains/domainownershipidentifiers"),
	// 	ID: to.Ptr("/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.DomainRegistration/domains/example.com/domainownershipidentifiers/SampleOwnershipId"),
	// 	Properties: &armappservice.DomainOwnershipIdentifierProperties{
	// 		OwnershipID: to.Ptr("SampleOwnershipId"),
	// 	},
	// }
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

JavaScript

const { WebSiteManagementClient } = require("@azure/arm-appservice");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Description for Creates an ownership identifier for a domain or updates identifier details for an existing identifier
 *
 * @summary Description for Creates an ownership identifier for a domain or updates identifier details for an existing identifier
 * x-ms-original-file: specification/web/resource-manager/Microsoft.DomainRegistration/stable/2023-01-01/examples/UpdateAppServiceDomainOwnershipIdentifier.json
 */
async function updateAppServiceDomainOwnershipIdentifier() {
  const subscriptionId =
    process.env["APPSERVICE_SUBSCRIPTION_ID"] || "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345";
  const resourceGroupName = process.env["APPSERVICE_RESOURCE_GROUP"] || "testrg123";
  const domainName = "example.com";
  const name = "SampleOwnershipId";
  const domainOwnershipIdentifier = {
    ownershipId: "SampleOwnershipId",
  };
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential, subscriptionId);
  const result = await client.domains.updateOwnershipIdentifier(
    resourceGroupName,
    domainName,
    name,
    domainOwnershipIdentifier
  );
  console.log(result);
}

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

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"
  }
}

Définitions

Nom	Description
DefaultErrorResponse	App Service réponse d’erreur.
Details
DomainOwnershipIdentifier	Identificateur de propriété de domaine.
Error	Modèle d’erreur.

DefaultErrorResponse

App Service réponse d’erreur.

Nom	Type	Description
error	Error	Modèle d’erreur.

Details

Nom	Type	Description
code	string	Chaîne standardisée pour identifier l’erreur par programmation.
message	string	Description détaillée de l’erreur et informations de débogage.
target	string	Description détaillée de l’erreur et informations de débogage.

DomainOwnershipIdentifier

Identificateur de propriété de domaine.

Nom	Type	Description
id	string	ID de ressource.
kind	string	Type de ressource.
name	string	Nom de la ressource.
properties.ownershipId	string	ID de propriété.
type	string	Type de ressource.

Error

Modèle d’erreur.

Nom	Type	Description
code	string	Chaîne standardisée pour identifier l’erreur par programmation.
details	Details[]	Erreurs détaillées.
innererror	string	Plus d’informations sur l’erreur de débogage.
message	string	Description détaillée de l’erreur et informations de débogage.
target	string	Description détaillée de l’erreur et informations de débogage.