Communication Services - List By Subscription

Dienst:: Communication

API-Version:: 2026-03-18

Nach Abonnement auflisten
Verarbeitet Anforderungen zum Auflisten aller Ressourcen in einem Abonnement.

GET https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Communication/communicationServices?api-version=2026-03-18

URI-Parameter

Name	In	Erforderlich	Typ	Beschreibung
subscriptionId	path	True	string (uuid)	Hierbei handelt es sich um 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	CommunicationServiceResourceList	Azure-Operation erfolgreich abgeschlossen.
Other Status Codes	ErrorResponse	Unerwartete Fehlerantwort.

Sicherheit

azure_auth

Azure Active Directory OAuth2 Flow.

Typ: oauth2
Ablauf: implicit
Autorisierungs-URL: https://login.microsoftonline.com/common/oauth2/authorize

Bereiche

Name	Beschreibung
user_impersonation	Identitätswechsel ihres Benutzerkontos

Beispiele

List by subscription

GET https://management.azure.com/subscriptions/11112222-3333-4444-5555-666677778888/providers/Microsoft.Communication/communicationServices?api-version=2026-03-18

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

/**
 * This sample demonstrates how to handles requests to list all resources in a subscription.
 *
 * @summary handles requests to list all resources in a subscription.
 * x-ms-original-file: 2026-03-18/communicationServices/listBySubscription.json
 */
async function listBySubscription() {
  const credential = new DefaultAzureCredential();
  const subscriptionId = "11112222-3333-4444-5555-666677778888";
  const client = new CommunicationServiceManagementClient(credential, subscriptionId);
  const resArray = new Array();
  for await (const item of client.communicationServices.listBySubscription()) {
    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

Beispiel für eine Antwort

Statuscode:: 200

{
  "value": [
    {
      "name": "MyCommunicationResource",
      "type": "Microsoft.Communication/CommunicationServices",
      "id": "/subscriptions/11112222-3333-4444-5555-666677778888/resourceGroups/MyResourceGroup/providers/Microsoft.Communication/CommunicationServices/MyCommunicationResource",
      "location": "Global",
      "properties": {
        "dataLocation": "United States",
        "hostName": "mycommunicationservice.comms.azure.net",
        "provisioningState": "Running",
        "version": "0.2.0"
      }
    }
  ]
}

Definitionen

Name	Beschreibung
CommunicationServiceResource	Eine Klasse, die eine CommunicationService-Ressource darstellt.
CommunicationServiceResourceList	Objekt, das ein Array von CommunicationServices und einen möglichen Link für die nächste Menge enthält.
CommunicationServices_ProvisioningState	Bereitstellungsstatus der Ressource.
createdByType	Der Identitätstyp, der die Ressource erstellt hat.
ErrorAdditionalInfo	Der Ressourcenverwaltungsfehler zusätzliche Informationen.
ErrorDetail	Das Fehlerdetails.
ErrorResponse	Fehlerantwort
ManagedServiceIdentity	Verwaltete Dienstidentität (vom System zugewiesene und/oder vom Benutzer zugewiesene Identitäten)
ManagedServiceIdentityType	Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind).
PublicNetworkAccess	Zulassen, Verweigern oder Steuern des Zugriffs auf die geschützte Ressource durch die Konfiguration des Netzwerksicherheitsperimeters für das öffentliche Netzwerk. Der Wert ist optional, aber wenn er übergeben wird, muss er "Enabled", "Disabled" oder "SecuredByPerimeter" lauten.
systemData	Metadaten zur Erstellung und letzten Änderung der Ressource.
UserAssignedIdentity	Benutzer zugewiesene Identitätseigenschaften

CommunicationServiceResource

Objekt

Eine Klasse, die eine CommunicationService-Ressource 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}"
identity	ManagedServiceIdentity	Die verwalteten Dienstidentitäten, die dieser Ressource zugewiesen sind.
location	string	Der geografische Standort, an dem sich die Ressource befindet
name	string	Der Name der Ressource
properties.dataLocation	string	Der Ort, an dem der Kommunikationsdienst ruhende Daten speichert.
properties.disableLocalAuth	boolean	Deaktivieren Sie die lokale Authentifizierung für den CommunicationService.
properties.hostName	string	FQDN der CommunicationService-Instanz.
properties.immutableResourceId	string	Die unveränderliche Ressourcen-ID des Kommunikationsdienstes.
properties.linkedDomains	string[]	Liste der E-Mail-Domänenressourcen-IDs.
properties.notificationHubId	string	Ressourcen-ID eines Azure Notification Hubs, der mit dieser Ressource verknüpft ist.
properties.provisioningState	CommunicationServices_ProvisioningState	Bereitstellungsstatus der Ressource.
properties.publicNetworkAccess	PublicNetworkAccess	Zulassen, Verweigern oder Steuern des Zugriffs auf die geschützte Ressource durch die Konfiguration des Netzwerksicherheitsperimeters für das öffentliche Netzwerk. Der Wert ist optional, aber wenn er übergeben wird, muss er "Enabled", "Disabled" oder "SecuredByPerimeter" lauten.
properties.version	string	Version der CommunicationService-Ressource. Wahrscheinlich benötigen Sie dieselbe oder höhere Version von Client-SDKs.
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"

CommunicationServiceResourceList

Objekt

Objekt, das ein Array von CommunicationServices und einen möglichen Link für die nächste Menge enthält.

Name	Typ	Beschreibung
nextLink	string (uri)	Der Link zur nächsten Seite von Elementen
value	CommunicationServiceResource[]	Die CommunicationServiceResource-Elemente auf dieser Seite

CommunicationServices_ProvisioningState

Enumeration

Bereitstellungsstatus der Ressource.

Wert	Beschreibung
Unknown	Unbekannt
Succeeded	Erfolgreich
Failed	gescheitert
Canceled	Abgesagt
Running	Laufen
Creating	Erstellen
Updating	Wird aktualisiert
Deleting	Wird gelöscht
Moving	Verschieben

createdByType

Enumeration

Der Identitätstyp, der die Ressource erstellt hat.

Wert	Beschreibung
User
Application
ManagedIdentity
Key

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.

ManagedServiceIdentity

Objekt

Verwaltete Dienstidentität (vom System zugewiesene und/oder vom Benutzer zugewiesene Identitäten)

Name	Typ	Beschreibung
principalId	string (uuid)	Die Dienstprinzipal-ID der vom System zugewiesenen Identität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt.
tenantId	string (uuid)	Die Mandanten-ID der vom System zugewiesenen Identität. Diese Eigenschaft wird nur für eine vom System zugewiesene Identität bereitgestellt.
type	ManagedServiceIdentityType	Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind).
userAssignedIdentities	<string, UserAssignedIdentity>	Die Gruppe der benutzerzuweisungen Identitäten, die der Ressource zugeordnet sind. Die Wörterbuchschlüssel "userAssignedIdentities" sind ARM-Ressourcen-IDs im Formular: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}. Die Wörterbuchwerte können leere Objekte ({}) in Anforderungen sein.

ManagedServiceIdentityType

Enumeration

Typ der verwalteten Dienstidentität (wobei systemAssigned- und UserAssigned-Typen zulässig sind).

Wert	Beschreibung
None
SystemAssigned
UserAssigned
SystemAssigned,UserAssigned

PublicNetworkAccess

Enumeration

Zulassen, Verweigern oder Steuern des Zugriffs auf die geschützte Ressource durch die Konfiguration des Netzwerksicherheitsperimeters für das öffentliche Netzwerk. Der Wert ist optional, aber wenn er übergeben wird, muss er "Enabled", "Disabled" oder "SecuredByPerimeter" lauten.

Wert	Beschreibung
Enabled	Ermöglicht die access des öffentlichen Netzwerks zur Ressource
Disabled	Öffentliche Netzwerk-access zur Ressource verhindert
SecuredByPerimeter	Die Netzwerksicherheitsperimeter-Konfigurationsregeln erlauben oder verbieten öffentliche Netzwerk access zur Ressource. Erfordert einen zugehörigen Netzwerksicherheitsperimeter.

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.

UserAssignedIdentity

Objekt

Benutzer zugewiesene Identitätseigenschaften

Name	Typ	Beschreibung
clientId	string (uuid)	Die Client-ID der zugewiesenen Identität.
principalId	string (uuid)	Die Prinzipal-ID der zugewiesenen Identität.