Domains - List By Email Service Resource

Dienst:

Communication

API-Version:

2023-04-01

Nach EmailService auflisten
Verarbeitet Anforderungen zum Auflisten aller Domänenressourcen unter der übergeordneten EmailServices-Ressource.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Communication/emailServices/{emailServiceName}/domains?api-version=2023-04-01

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
emailServiceName	path	True	string minLength: 1 maxLength: 63 pattern: ^[a-zA-Z0-9-]+$	Der Name der EmailService-Ressource.
resourceGroupName	path	True	string minLength: 1 maxLength: 90	Der Name der Ressourcengruppe. Bei dem Namen wird die Groß-/Kleinschreibung nicht beachtet.
subscriptionId	path	True	string (uuid)	Die ID des Zielabonnements. Der Wert muss eine UUID sein.
api-version	query	True	string minLength: 1	Die API-Version, die für diesen Vorgang verwendet werden soll.

Antworten

Name	Typ	Beschreibung
200 OK	DomainResourceList	Erfolg. Die Antwort beschreibt die Liste der Domänenressourcen unter der übergeordneten EmailServices-Ressource.
Other Status Codes	ErrorResponse	Fehlerantwort, die beschreibt, warum der Vorgang fehlgeschlagen ist.

Beispiele

List Domains resources by EmailServiceName

Beispielanforderung

HTTP

GET https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/emailServices/MyEmailServiceResource/domains?api-version=2023-04-01

Java

/**
 * Samples for Domains ListByEmailServiceResource.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/communication/resource-manager/Microsoft.Communication/stable/2023-04-01/examples/domains/
     * listByEmailService.json
     */
    /**
     * Sample code: List Domains resources by EmailServiceName.
     * 
     * @param manager Entry point to CommunicationManager.
     */
    public static void
        listDomainsResourcesByEmailServiceName(com.azure.resourcemanager.communication.CommunicationManager manager) {
        manager.domains().listByEmailServiceResource("MyResourceGroup", "MyEmailServiceResource",
            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.communication import CommunicationServiceManagementClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-communication
# USAGE
    python list_by_email_service.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 = CommunicationServiceManagementClient(
        credential=DefaultAzureCredential(),
        subscription_id="11112222-3333-4444-5555-666677778888",
    )

    response = client.domains.list_by_email_service_resource(
        resource_group_name="MyResourceGroup",
        email_service_name="MyEmailServiceResource",
    )
    for item in response:
        print(item)


# x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2023-04-01/examples/domains/listByEmailService.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 armcommunication_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/communication/armcommunication/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/cf5ad1932d00c7d15497705ad6b71171d3d68b1e/specification/communication/resource-manager/Microsoft.Communication/stable/2023-04-01/examples/domains/listByEmailService.json
func ExampleDomainsClient_NewListByEmailServiceResourcePager() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armcommunication.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	pager := clientFactory.NewDomainsClient().NewListByEmailServiceResourcePager("MyResourceGroup", "MyEmailServiceResource", 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.DomainResourceList = armcommunication.DomainResourceList{
		// 	Value: []*armcommunication.DomainResource{
		// 		{
		// 			Name: to.Ptr("mydomain.com"),
		// 			Type: to.Ptr("Microsoft.Communication/EmailServices/Domains"),
		// 			ID: to.Ptr("/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/EmailServices/MyEmailServiceResource/Domains/mydomain.com"),
		// 			Location: to.Ptr("Global"),
		// 			Properties: &armcommunication.DomainProperties{
		// 				DataLocation: to.Ptr("United States"),
		// 				DomainManagement: to.Ptr(armcommunication.DomainManagementCustomerManaged),
		// 				FromSenderDomain: to.Ptr("mydomain.com"),
		// 				MailFromSenderDomain: to.Ptr("mydomain.com"),
		// 				ProvisioningState: to.Ptr(armcommunication.DomainsProvisioningStateSucceeded),
		// 				VerificationRecords: &armcommunication.DomainPropertiesVerificationRecords{
		// 					Domain: &armcommunication.DNSRecord{
		// 						Name: to.Ptr("recordName"),
		// 						Type: to.Ptr("TXT"),
		// 						TTL: to.Ptr[int32](3600),
		// 						Value: to.Ptr("recordValue"),
		// 					},
		// 					SPF: &armcommunication.DNSRecord{
		// 						Name: to.Ptr("recordName"),
		// 						Type: to.Ptr("TXT"),
		// 						TTL: to.Ptr[int32](3600),
		// 						Value: to.Ptr("recordValue"),
		// 					},
		// 				},
		// 				VerificationStates: &armcommunication.DomainPropertiesVerificationStates{
		// 					Domain: &armcommunication.VerificationStatusRecord{
		// 						ErrorCode: to.Ptr(""),
		// 						Status: to.Ptr(armcommunication.VerificationStatusVerified),
		// 					},
		// 					SPF: &armcommunication.VerificationStatusRecord{
		// 						ErrorCode: to.Ptr(""),
		// 						Status: to.Ptr(armcommunication.VerificationStatusNotStarted),
		// 					},
		// 				},
		// 			},
		// 	}},
		// }
	}
}

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 { CommunicationServiceManagementClient } = require("@azure/arm-communication");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Handles requests to list all Domains resources under the parent EmailServices resource.
 *
 * @summary Handles requests to list all Domains resources under the parent EmailServices resource.
 * x-ms-original-file: specification/communication/resource-manager/Microsoft.Communication/stable/2023-04-01/examples/domains/listByEmailService.json
 */
async function listDomainsResourcesByEmailServiceName() {
  const subscriptionId =
    process.env["COMMUNICATION_SUBSCRIPTION_ID"] || "11112222-3333-4444-5555-666677778888";
  const resourceGroupName = process.env["COMMUNICATION_RESOURCE_GROUP"] || "MyResourceGroup";
  const emailServiceName = "MyEmailServiceResource";
  const credential = new DefaultAzureCredential();
  const client = new CommunicationServiceManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (let item of client.domains.listByEmailServiceResource(
    resourceGroupName,
    emailServiceName,
  )) {
    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

dotnet

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.Communication.Models;
using Azure.ResourceManager.Communication;

// Generated from example definition: specification/communication/resource-manager/Microsoft.Communication/stable/2023-04-01/examples/domains/listByEmailService.json
// this example is just showing the usage of "Domains_ListByEmailServiceResource" 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);

// this example assumes you already have this EmailServiceResource created on azure
// for more information of creating EmailServiceResource, please refer to the document of EmailServiceResource
string subscriptionId = "11112222-3333-4444-5555-666677778888";
string resourceGroupName = "MyResourceGroup";
string emailServiceName = "MyEmailServiceResource";
ResourceIdentifier emailServiceResourceId = EmailServiceResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, emailServiceName);
EmailServiceResource emailServiceResource = client.GetEmailServiceResource(emailServiceResourceId);

// get the collection of this CommunicationDomainResource
CommunicationDomainResourceCollection collection = emailServiceResource.GetCommunicationDomainResources();

// invoke the operation and iterate over the result
await foreach (CommunicationDomainResource item in collection.GetAllAsync())
{
    // the variable item is a resource, you could call other operations on this instance as well
    // but just for demo, we get its data from this resource instance
    CommunicationDomainResourceData resourceData = item.Data;
    // for demo we just print out the id
    Console.WriteLine($"Succeeded on id: {resourceData.Id}");
}

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

Beispiel für eine Antwort

Statuscode:

200

{
  "value": [
    {
      "id": "/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/EmailServices/MyEmailServiceResource/Domains/mydomain.com",
      "name": "mydomain.com",
      "type": "Microsoft.Communication/EmailServices/Domains",
      "location": "Global",
      "properties": {
        "provisioningState": "Running",
        "dataLocation": "United States",
        "fromSenderDomain": "mydomain.com",
        "mailFromSenderDomain": "mydomain.com",
        "domainManagement": "CustomerManaged",
        "verificationStates": {
          "Domain": {
            "status": "Verified",
            "errorCode": ""
          },
          "SPF": {
            "status": "NotStarted",
            "errorCode": ""
          }
        },
        "verificationRecords": {
          "Domain": {
            "type": "TXT",
            "name": "recordName",
            "value": "recordValue",
            "ttl": 3600
          },
          "SPF": {
            "type": "TXT",
            "name": "recordName",
            "value": "recordValue",
            "ttl": 3600
          }
        }
      }
    }
  ]
}

Definitionen

Name	Beschreibung
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
DnsRecord	Eine Klasse, die einen VerificationStatus-Eintrag darstellt.
DomainManagement	Beschreibt, wie eine Domänenressource verwaltet wird.
DomainResource	Eine Klasse, die eine Domänenressource darstellt.
DomainResourceList	Objekt, das ein Array von Domänenressource und eine mögliche Verknüpfung für den nächsten Satz enthält.
Domains_ProvisioningState	Bereitstellungsstatus der Ressource.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
UserEngagementTracking	Beschreibt, ob die Nachverfolgung des Benutzereinsatzes aktiviert oder deaktiviert ist.
VerificationRecords	Liste der DnsRecord
VerificationStates	Liste der VerificationStatusRecord
VerificationStatus	Status des Überprüfungsvorgangs.
VerificationStatusRecord	Eine Klasse, die einen VerificationStatus-Eintrag darstellt.

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

DnsRecord

Objekt

Eine Klasse, die einen VerificationStatus-Eintrag darstellt.

Name	Typ	Beschreibung
name	string	Name des DNS-Eintrags.
ttl	integer (int32)	Stellt eine Ablaufzeit in Sekunden dar, um darzustellen, wie lange dieser Eintrag vom Resolver zwischengespeichert werden kann, Standard = 3600sec.
type	string	Typ des DNS-Eintrags. Beispiel: TXT
value	string	Wert des DNS-Eintrags.

DomainManagement

Enumeration

Beschreibt, wie eine Domänenressource verwaltet wird.

Wert	Beschreibung
AzureManaged
CustomerManaged
CustomerManagedInExchangeOnline

DomainResource

Objekt

Eine Klasse, die eine Domänenressource darstellt.

Name	Typ	Beschreibung
id	string (arm-id)	Vollqualifizierte Ressourcen-ID für die Ressource. Z. B. "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.dataLocation	string	Der Speicherort, an dem die Domänenressourcendaten ruhen.
properties.domainManagement	DomainManagement	Beschreibt, wie eine Domänenressource verwaltet wird.
properties.fromSenderDomain	string	P2-Absenderdomäne, die den E-Mail-Empfängern angezeigt wird [RFC 5322].
properties.mailFromSenderDomain	string	P1-Absenderdomäne, die auf dem E-Mail-Umschlag vorhanden ist [RFC 5321].
properties.provisioningState	Domains_ProvisioningState	Bereitstellungsstatus der Ressource.
properties.userEngagementTracking	UserEngagementTracking	Beschreibt, ob die Nachverfolgung des Benutzereinsatzes aktiviert oder deaktiviert ist.
properties.verificationRecords	VerificationRecords	Liste der DnsRecord
properties.verificationStates	VerificationStates	Liste der VerificationStatusRecord
systemData	systemData	Azure Resource Manager-Metadaten, die createdBy- und modifiedBy-Informationen enthalten.
tags	object	Ressourcentags.
type	string	Der Typ der Ressource. Z. B. "Microsoft.Compute/virtualMachines" oder "Microsoft.Storage/storageAccounts"

DomainResourceList

Objekt

Objekt, das ein Array von Domänenressource und eine mögliche Verknüpfung für den nächsten Satz enthält.

Name	Typ	Beschreibung
nextLink	string	Die URL, die der Client zum Abrufen der nächsten Seite (pro serverseitigem Paging) verwenden soll. Es ist null für jetzt, für die zukünftige Verwendung hinzugefügt.
value	DomainResource[]	Liste der Domänenressource

Domains_ProvisioningState

Enumeration

Bereitstellungsstatus der Ressource.

Wert	Beschreibung
Unknown
Succeeded
Failed
Canceled
Running
Creating
Updating
Deleting
Moving

ErrorAdditionalInfo

Objekt

Der Ressourcenverwaltungsfehler zusätzliche Informationen.

Name	Typ	Beschreibung
info	object	Die zusätzlichen Informationen.
type	string	Der zusätzliche Informationstyp.

ErrorDetail

Objekt

Das Fehlerdetails.

Name	Typ	Beschreibung
additionalInfo	ErrorAdditionalInfo[]	Die zusätzlichen Informationen des Fehlers.
code	string	Der Fehlercode.
details	ErrorDetail[]	Die Fehlerdetails.
message	string	Die Fehlermeldung.
target	string	Das Fehlerziel.

ErrorResponse

Objekt

Fehlerantwort

Name	Typ	Beschreibung
error	ErrorDetail	Das Fehlerobjekt.

systemData

Objekt

Metadaten zur Erstellung und letzten Änderung der Ressource.

Name	Typ	Beschreibung
createdAt	string (date-time)	Der Zeitstempel der Ressourcenerstellung (UTC).
createdBy	string	Die Identität, die die Ressource erstellt hat.
createdByType	createdByType	Der Identitätstyp, der die Ressource erstellt hat.
lastModifiedAt	string (date-time)	Der Zeitstempel der letzten Änderung der Ressource (UTC)
lastModifiedBy	string	Die Identität, die die Ressource zuletzt geändert hat.
lastModifiedByType	createdByType	Der Identitätstyp, der die Ressource zuletzt geändert hat.

UserEngagementTracking

Enumeration

Beschreibt, ob die Nachverfolgung des Benutzereinsatzes aktiviert oder deaktiviert ist.

Wert	Beschreibung
Disabled
Enabled

VerificationRecords

Objekt

Liste der DnsRecord

Name	Typ	Beschreibung
DKIM	DnsRecord	Eine Klasse, die einen VerificationStatus-Eintrag darstellt.
DKIM2	DnsRecord	Eine Klasse, die einen VerificationStatus-Eintrag darstellt.
DMARC	DnsRecord	Eine Klasse, die einen VerificationStatus-Eintrag darstellt.
Domain	DnsRecord	Eine Klasse, die einen VerificationStatus-Eintrag darstellt.
SPF	DnsRecord	Eine Klasse, die einen VerificationStatus-Eintrag darstellt.

VerificationStates

Objekt

Liste der VerificationStatusRecord

Name	Typ	Beschreibung
DKIM	VerificationStatusRecord	Eine Klasse, die einen VerificationStatus-Eintrag darstellt.
DKIM2	VerificationStatusRecord	Eine Klasse, die einen VerificationStatus-Eintrag darstellt.
DMARC	VerificationStatusRecord	Eine Klasse, die einen VerificationStatus-Eintrag darstellt.
Domain	VerificationStatusRecord	Eine Klasse, die einen VerificationStatus-Eintrag darstellt.
SPF	VerificationStatusRecord	Eine Klasse, die einen VerificationStatus-Eintrag darstellt.

VerificationStatus

Enumeration

Status des Überprüfungsvorgangs.

Wert	Beschreibung
NotStarted
VerificationRequested
VerificationInProgress
VerificationFailed
Verified
CancellationRequested

VerificationStatusRecord

Objekt

Eine Klasse, die einen VerificationStatus-Eintrag darstellt.

Name	Typ	Beschreibung
errorCode	string	Fehlercode. Diese Eigenschaft ist nur vorhanden, wenn der Status "UnableToVerify" ist.
status	VerificationStatus	Status des Überprüfungsvorgangs.