Domain Registration Provider - List Operations

Usługa:: App Service

Wersja interfejsu API:: 2024-11-01

Opis implementowania interfejsu API operacji Csm w celu uwidocznienia listy dostępnych interfejsów API csm u dostawcy zasobów

GET https://management.azure.com/providers/Microsoft.DomainRegistration/operations?api-version=2024-11-01

Parametry identyfikatora URI

Nazwa	W	Wymagane	Typ	Opis
api-version	query	True	string	Wersja interfejsu API

Odpowiedzi

Nazwa	Typ	Opis
200 OK	CsmOperationCollection	OK
Other Status Codes	DefaultErrorResponse	Odpowiedź na błąd usługi App Service.

Zabezpieczenia

azure_auth

Przepływ protokołu OAuth2 usługi Azure Active Directory

Typ: oauth2
Flow: implicit
Adres URL autoryzacji: https://login.microsoftonline.com/common/oauth2/authorize

Zakresy

Nazwa	Opis
user_impersonation	personifikacja konta użytkownika

Przykłady

List operations

Przykładowe żądanie

GET https://management.azure.com/providers/Microsoft.DomainRegistration/operations?api-version=2024-11-01


/**
 * Samples for DomainRegistrationProvider ListOperations.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-11-01/examples/ListOperations.json
     */
    /**
     * Sample code: List operations.
     * 
     * @param azure The entry point for accessing resource management APIs in Azure.
     */
    public static void listOperations(com.azure.resourcemanager.AzureResourceManager azure) {
        azure.webApps().manager().serviceClient().getDomainRegistrationProviders()
            .listOperations(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

package armappservice_test

import (
	"context"
	"log"

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

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/82e9c6f9fbfa2d6d47d5e2a6a11c0ad2eb345c43/specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-11-01/examples/ListOperations.json
func ExampleDomainRegistrationProviderClient_NewListOperationsPager() {
	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)
	}
	pager := clientFactory.NewDomainRegistrationProviderClient().NewListOperationsPager(nil)
	for pager.More() {
		page, err := pager.NextPage(ctx)
		if err != nil {
			log.Fatalf("failed to advance page: %v", err)
		}
		for _, v := range page.Value {
			// You could use page here. We use blank identifier for just demo purposes.
			_ = v
		}
		// If the HTTP response code is 200 as defined in example definition, your page structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
		// page.CsmOperationCollection = armappservice.CsmOperationCollection{
		// 	Value: []*armappservice.CsmOperationDescription{
		// 		{
		// 			Name: to.Ptr("Microsoft.DomainRegistration/domains/Read"),
		// 			Display: &armappservice.CsmOperationDisplay{
		// 				Description: to.Ptr("Get the list of domains"),
		// 				Operation: to.Ptr("Get Domains"),
		// 				Provider: to.Ptr("Microsoft Domains"),
		// 				Resource: to.Ptr("Domain"),
		// 			},
		// 			Origin: to.Ptr("user,system"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DomainRegistration/domains/Write"),
		// 			Display: &armappservice.CsmOperationDisplay{
		// 				Description: to.Ptr("Add a new Domain or update an existing one"),
		// 				Operation: to.Ptr("Add or Update Domain"),
		// 				Provider: to.Ptr("Microsoft Domains"),
		// 				Resource: to.Ptr("Domain"),
		// 			},
		// 			Origin: to.Ptr("user,system"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DomainRegistration/domains/Delete"),
		// 			Display: &armappservice.CsmOperationDisplay{
		// 				Description: to.Ptr("Delete an existing domain."),
		// 				Operation: to.Ptr("Delete Domain"),
		// 				Provider: to.Ptr("Microsoft Domains"),
		// 				Resource: to.Ptr("Domain"),
		// 			},
		// 			Origin: to.Ptr("user,system"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DomainRegistration/domains/operationresults/Read"),
		// 			Display: &armappservice.CsmOperationDisplay{
		// 				Description: to.Ptr("Get a domain operation"),
		// 				Operation: to.Ptr("Get Domain Operation"),
		// 				Provider: to.Ptr("Microsoft Domains"),
		// 				Resource: to.Ptr("Domain operation"),
		// 			},
		// 			Origin: to.Ptr("user,system"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DomainRegistration/generateSsoRequest/Action"),
		// 			Display: &armappservice.CsmOperationDisplay{
		// 				Description: to.Ptr("Generate a request for signing into domain control center."),
		// 				Operation: to.Ptr("Generate Domain Control Center Single Sign On Request"),
		// 				Provider: to.Ptr("Microsoft Domains"),
		// 				Resource: to.Ptr("Domain Control Center Single Sign On Request"),
		// 			},
		// 			Origin: to.Ptr("user,system"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DomainRegistration/validateDomainRegistrationInformation/Action"),
		// 			Display: &armappservice.CsmOperationDisplay{
		// 				Description: to.Ptr("Validate domain purchase object without submitting it"),
		// 				Operation: to.Ptr("Domain Purchase Info Validation"),
		// 				Provider: to.Ptr("Microsoft Domains"),
		// 				Resource: to.Ptr("Domain Validation"),
		// 			},
		// 			Origin: to.Ptr("user,system"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DomainRegistration/checkDomainAvailability/Action"),
		// 			Display: &armappservice.CsmOperationDisplay{
		// 				Description: to.Ptr("Check if a domain is available for purchase"),
		// 				Operation: to.Ptr("Check Domain Availability"),
		// 				Provider: to.Ptr("Microsoft Domains"),
		// 				Resource: to.Ptr("Domain Availability Result"),
		// 			},
		// 			Origin: to.Ptr("user,system"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DomainRegistration/listDomainRecommendations/Action"),
		// 			Display: &armappservice.CsmOperationDisplay{
		// 				Description: to.Ptr("Retrieve the list domain recommendations based on keywords"),
		// 				Operation: to.Ptr("Retrieve Domain Recommendations"),
		// 				Provider: to.Ptr("Microsoft Domains"),
		// 				Resource: to.Ptr("Domain Recommendations"),
		// 			},
		// 			Origin: to.Ptr("user,system"),
		// 		},
		// 		{
		// 			Name: to.Ptr("Microsoft.DomainRegistration/register/action"),
		// 			Display: &armappservice.CsmOperationDisplay{
		// 				Description: to.Ptr("Register the Microsoft Domains resource provider for the subscription"),
		// 				Operation: to.Ptr("Register Microsoft Domains resource provider"),
		// 				Provider: to.Ptr("Microsoft Domains"),
		// 				Resource: to.Ptr("Microsoft Domains resource provider"),
		// 			},
		// 			Origin: to.Ptr("user,system"),
		// 	}},
		// }
	}
}

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

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

/**
 * This sample demonstrates how to Description for Implements Csm operations Api to exposes the list of available Csm Apis under the resource provider
 *
 * @summary Description for Implements Csm operations Api to exposes the list of available Csm Apis under the resource provider
 * x-ms-original-file: specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-11-01/examples/ListOperations.json
 */
async function listOperations() {
  const credential = new DefaultAzureCredential();
  const client = new WebSiteManagementClient(credential);
  const resArray = new Array();
  for await (const item of client.domainRegistrationProvider.listOperations()) {
    resArray.push(item);
  }
  console.log(resArray);
}

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

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.AppService.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.AppService;

// Generated from example definition: specification/web/resource-manager/Microsoft.DomainRegistration/stable/2024-11-01/examples/ListOperations.json
// this example is just showing the usage of "DomainRegistrationProvider_ListOperations" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

TenantResource tenantResource = client.GetTenants().GetAllAsync().GetAsyncEnumerator().Current;

// invoke the operation and iterate over the result
await foreach (CsmOperationDescription item in tenantResource.GetOperationsDomainRegistrationProvidersAsync())
{
    Console.WriteLine($"Succeeded: {item}");
}

Console.WriteLine("Succeeded");

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

Przykładowa odpowiedź

Kod stanu:: 200

{
  "value": [
    {
      "name": "Microsoft.DomainRegistration/domains/Read",
      "display": {
        "provider": "Microsoft Domains",
        "resource": "Domain",
        "operation": "Get Domains",
        "description": "Get the list of domains"
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.DomainRegistration/domains/Write",
      "display": {
        "provider": "Microsoft Domains",
        "resource": "Domain",
        "operation": "Add or Update Domain",
        "description": "Add a new Domain or update an existing one"
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.DomainRegistration/domains/Delete",
      "display": {
        "provider": "Microsoft Domains",
        "resource": "Domain",
        "operation": "Delete Domain",
        "description": "Delete an existing domain."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.DomainRegistration/domains/operationresults/Read",
      "display": {
        "provider": "Microsoft Domains",
        "resource": "Domain operation",
        "operation": "Get Domain Operation",
        "description": "Get a domain operation"
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.DomainRegistration/generateSsoRequest/Action",
      "display": {
        "provider": "Microsoft Domains",
        "resource": "Domain Control Center Single Sign On Request",
        "operation": "Generate Domain Control Center Single Sign On Request",
        "description": "Generate a request for signing into domain control center."
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.DomainRegistration/validateDomainRegistrationInformation/Action",
      "display": {
        "provider": "Microsoft Domains",
        "resource": "Domain Validation",
        "operation": "Domain Purchase Info Validation",
        "description": "Validate domain purchase object without submitting it"
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.DomainRegistration/checkDomainAvailability/Action",
      "display": {
        "provider": "Microsoft Domains",
        "resource": "Domain Availability Result",
        "operation": "Check Domain Availability",
        "description": "Check if a domain is available for purchase"
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.DomainRegistration/listDomainRecommendations/Action",
      "display": {
        "provider": "Microsoft Domains",
        "resource": "Domain Recommendations",
        "operation": "Retrieve Domain Recommendations",
        "description": "Retrieve the list domain recommendations based on keywords"
      },
      "origin": "user,system"
    },
    {
      "name": "Microsoft.DomainRegistration/register/action",
      "display": {
        "provider": "Microsoft Domains",
        "resource": "Microsoft Domains resource provider",
        "operation": "Register Microsoft Domains resource provider",
        "description": "Register the Microsoft Domains resource provider for the subscription"
      },
      "origin": "user,system"
    }
  ]
}

Definicje

Nazwa	Opis
CsmOperationCollection	Kolekcja metadanych operacji usługi Azure Resource Manager.
CsmOperationDescription	Opis operacji dostępnej dla dostawcy zasobów Microsoft.Web.
CsmOperationDescriptionProperties	Właściwości dostępne dla operacji dostawcy zasobów Microsoft.Web.
CsmOperationDisplay	Metadane dotyczące operacji używanej do wyświetlania w portalu.
DefaultErrorResponse	Odpowiedź na błąd usługi App Service.
Details
Dimension	Wymiar metryki zasobu. Na przykład dla wystąpień określonych żądań HTTP dla aplikacji internetowej, gdzie nazwa wystąpienia jest wymiarem metryki żądania HTTP
Error	Model błędu.
LogSpecification	Definicja dziennika pojedynczej metryki zasobu.
MetricAvailability	Zasady przechowywania metryki zasobów.
MetricSpecification	Definicja metryki pojedynczego zasobu.
ServiceSpecification	Usługa metryk zasobów zapewniana przez dostawcę zasobów Microsoft.Insights.

CsmOperationCollection

Objekt

Kolekcja metadanych operacji usługi Azure Resource Manager.

Nazwa	Typ	Opis
nextLink	string	Łącze do następnej strony zasobów.
value	CsmOperationDescription[]	Kolekcja zasobów.

CsmOperationDescription

Objekt

Opis operacji dostępnej dla dostawcy zasobów Microsoft.Web.

Nazwa	Typ	Opis
display	CsmOperationDisplay	Metadane dotyczące operacji używanej do wyświetlania w portalu.
isDataAction	boolean
name	string
origin	string
properties	CsmOperationDescriptionProperties	Właściwości dostępne dla operacji dostawcy zasobów Microsoft.Web.

CsmOperationDescriptionProperties

Objekt

Właściwości dostępne dla operacji dostawcy zasobów Microsoft.Web.

Nazwa	Typ	Opis
serviceSpecification	ServiceSpecification	Usługa metryk zasobów zapewniana przez dostawcę zasobów Microsoft.Insights.

CsmOperationDisplay

Objekt

Metadane dotyczące operacji używanej do wyświetlania w portalu.

Nazwa	Typ	Opis
description	string
operation	string
provider	string
resource	string

DefaultErrorResponse

Objekt

Odpowiedź na błąd usługi App Service.

Nazwa	Typ	Opis
error	Error	Model błędu.

Details

Objekt

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg do programowego identyfikowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

Dimension

Objekt

Wymiar metryki zasobu. Na przykład dla wystąpień określonych żądań HTTP dla aplikacji internetowej, gdzie nazwa wystąpienia jest wymiarem metryki żądania HTTP

Nazwa	Typ	Opis
displayName	string
internalName	string
name	string
toBeExportedForShoebox	boolean

Error

Objekt

Model błędu.

Nazwa	Typ	Opis
code	string	Ustandaryzowany ciąg do programowego identyfikowania błędu.
details	Details[]	Szczegółowe błędy.
innererror	string	Więcej informacji na temat debugowania błędu.
message	string	Szczegółowy opis błędu i informacje o debugowaniu.
target	string	Szczegółowy opis błędu i informacje o debugowaniu.

LogSpecification

Objekt

Definicja dziennika pojedynczej metryki zasobu.

Nazwa	Typ	Opis
blobDuration	string
displayName	string
logFilterPattern	string
name	string

MetricAvailability

Objekt

Zasady przechowywania metryki zasobów.

Nazwa	Typ	Opis
blobDuration	string
timeGrain	string

MetricSpecification

Objekt

Definicja metryki pojedynczego zasobu.

Nazwa	Typ	Opis
aggregationType	string
availabilities	MetricAvailability[]	Zasady przechowywania metryki zasobów.
category	string
dimensions	Dimension[]	Wymiar metryki zasobu. Na przykład dla wystąpień określonych żądań HTTP dla aplikacji internetowej, gdzie nazwa wystąpienia jest wymiarem metryki żądania HTTP
displayDescription	string
displayName	string
enableRegionalMdmAccount	boolean
fillGapWithZero	boolean
isInternal	boolean
metricFilterPattern	string
name	string
sourceMdmAccount	string
sourceMdmNamespace	string
supportedAggregationTypes	string[]
supportedTimeGrainTypes	string[]
supportsInstanceLevelAggregation	boolean
unit	string

ServiceSpecification

Objekt

Usługa metryk zasobów zapewniana przez dostawcę zasobów Microsoft.Insights.

Nazwa	Typ	Opis
logSpecifications	LogSpecification[]	Definicja dziennika pojedynczej metryki zasobu.
metricSpecifications	MetricSpecification[]	Definicja metryki pojedynczego zasobu.

Udostępnij za pośrednictwem

Domain Registration Provider - List Operations

Parametry identyfikatora URI

Odpowiedzi

Zabezpieczenia

azure_auth

Zakresy

Przykłady

List operations

Przykładowe żądanie

Przykładowa odpowiedź

Definicje

CsmOperationCollection

CsmOperationDescription

CsmOperationDescriptionProperties

CsmOperationDisplay

DefaultErrorResponse

Details

Dimension

Error

LogSpecification

MetricAvailability

MetricSpecification

ServiceSpecification