Freigeben über

az communication rooms

Note

Diese Referenz ist Teil der Kommunikationserweiterung für die Azure CLI (Version 2.67.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie ein az Kommunikationsräume Befehl ausführen. Erfahren Sie mehr über Erweiterungen.

Befehle für die Interaktion mit dem Azure Communication Services Rooms-Gateway.

Befehle

Name Beschreibung Typ Status
az communication rooms create

Erstellen Sie einen neuen Raum.

 Extension GA
az communication rooms delete

Löschen eines vorhandenen Chatrooms.

 Extension GA
az communication rooms get

Gibt Attribute eines vorhandenen Raums zurück.

 Extension GA
az communication rooms list

Listet alle aktiven Räume auf, die zu einer aktuellen Kommunikationsdienstressource gehören.

 Extension GA
az communication rooms participant

Befehle zum Verwalten von Teilnehmern eines vorhandenen Chatrooms.

 Extension GA
az communication rooms participant add-or-update

Hinzufügen oder Aktualisieren von Teilnehmern in einem Raum.

 Extension GA
az communication rooms participant get

Abrufen von Teilnehmern eines Chatrooms.

 Extension GA
az communication rooms participant remove

Entfernen sie Teilnehmer aus einem Chatroom.

 Extension GA
az communication rooms update

Aktualisieren von Attributen eines vorhandenen Raums.

 Extension GA

az communication rooms create

Erstellen Sie einen neuen Raum.

az communication rooms create [--attendee-participants --attendees]
                              [--collaborator-participants --collaborators]
                              [--connection-string]
                              [--consumer-participants --consumers]
                              [--presenter-participants --presenters]
                              [--pstn-dial-out-enabled]
                              [--valid-from]
                              [--valid-until]

Beispiele

Erstellen eines Raums mit Standardparametern

az communication rooms create

Erstellen eines Chatrooms mit gültigen und gültigen Datums-/Uhrzeiten

az communication rooms create --valid-from "2022-07-14T10:21" --valid-until "2022-08-14T10:21"

Erstellen eines Chatrooms mit gültigen, gültigen Datums-/Uhrzeiten und aktivierter Pstn-Ausgehend-Auswahl

az communication rooms create --valid-from "2022-07-14T10:21" --valid-until "2022-08-14T10:21" --pstn-dial-out-enabled "True"

Erstellen eines Chatrooms mit einer Teilnehmerliste mit Referentenrolle

az communication rooms create --presenter-participants "8:acs:xxxxxx" "8:acs:xxxxxx"

Erstellen eines Chatrooms mit einer Teilnehmerliste mit Teilnehmerrolle

az communication rooms create --attendee-participants "8:acs:xxxxxx" "8:acs:xxxxxx"

Erstellen eines Chatrooms mit einer Teilnehmerliste mit Referenten- und Consumerrollen

az communication rooms create --presenter-participants "8:acs:xxxxxx" "8:acs:xxxxxx" --consumer-participants "8:acs:xxxxxx" "8:acs:xxxxxx"

Erstellen eines Chatrooms mit einer Teilnehmerliste mit Teilnehmer- und Mitarbeiterrollen

az communication rooms create --attendee-participants "8:acs:xxxxxx" "8:acs:xxxxxx" --collaborator-participants "8:acs:xxxxxx" "8:acs:xxxxxx"

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--attendee-participants --attendees

Sammlung von Identitäten, die als Teilnehmer zum Chatroom eingeladen werden sollen. Optional.

--collaborator-participants --collaborators

Sammlung von Identitäten, die als Mitarbeiter zum Chatroom eingeladen werden sollen. Optional.

--connection-string

Kommunikationsverbindungszeichenfolge. Umgebungsvariable: AZURE_COMMUNICATION_CONNECTION_STRING.

Eigenschaft Wert
Parametergruppe: Communication Arguments
--consumer-participants --consumers

Sammlung von Identitäten, die als Verbraucher zum Raum eingeladen werden sollen. Optional.

--presenter-participants --presenters

Sammlung von Identitäten, die als Referent in den Raum eingeladen werden sollen. Optional.

--pstn-dial-out-enabled

Legen Sie dieses Kennzeichen auf "true" fest, wenn zum Zeitpunkt des Anrufs eine PSTN-Nummer in einem bestimmten Raum aktiviert ist. Dieses Flag ist standardmäßig auf „false“ festgelegt. Optional.

--valid-from

Der Zeitstempel, ab dem der Raum für die Teilnahme geöffnet ist, im ISO8601 Format, z. B. 2023-03-31T10:21. Optional.

--valid-until

Der Zeitstempel, ab dem der Raum nicht mehr verbunden werden kann, im ISO8601 Format, z. B. 2023-06-31T10:21. Optional.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az communication rooms delete

Löschen eines vorhandenen Chatrooms.

az communication rooms delete --room
                              [--connection-string]
                              [--yes]

Beispiele

Löschen eines vorhandenen Chatrooms

az communication rooms delete --room "12345678901234567"

Erforderliche Parameter

--room

Raum-ID.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--connection-string

Kommunikationsverbindungszeichenfolge. Umgebungsvariable: AZURE_COMMUNICATION_CONNECTION_STRING.

Eigenschaft Wert
Parametergruppe: Communication Arguments
--yes -y

Zur Bestätigung nicht auffordern.

Eigenschaft Wert
Standardwert: False
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az communication rooms get

Gibt Attribute eines vorhandenen Raums zurück.

az communication rooms get --room
                           [--connection-string]

Beispiele

Raum abrufen

az communication rooms get --room "12345678901234567"

Erforderliche Parameter

--room

Raum-ID.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--connection-string

Kommunikationsverbindungszeichenfolge. Umgebungsvariable: AZURE_COMMUNICATION_CONNECTION_STRING.

Eigenschaft Wert
Parametergruppe: Communication Arguments
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az communication rooms list

Listet alle aktiven Räume auf, die zu einer aktuellen Kommunikationsdienstressource gehören.

az communication rooms list [--connection-string]

Beispiele

Liste aller aktiven Räume

az communication rooms list

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--connection-string

Kommunikationsverbindungszeichenfolge. Umgebungsvariable: AZURE_COMMUNICATION_CONNECTION_STRING.

Eigenschaft Wert
Parametergruppe: Communication Arguments
Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False

az communication rooms update

Aktualisieren von Attributen eines vorhandenen Raums.

az communication rooms update --room
                              [--connection-string]
                              [--pstn-dial-out-enabled]
                              [--valid-from]
                              [--valid-until]

Beispiele

Aktualisieren der gültigen und gültigen Eigenschaften eines Chatrooms

az communication rooms update --room "12345678901234567" --valid-from "2022-07-14T10:21" --valid-until "2022-08-14T10:21"

Erforderliche Parameter

--room

Raum-ID.

Optionale Parameter

Die folgenden Parameter sind optional, aber je nach Kontext kann mindestens ein Parameter erforderlich sein, damit der Befehl erfolgreich ausgeführt werden kann.

--connection-string

Kommunikationsverbindungszeichenfolge. Umgebungsvariable: AZURE_COMMUNICATION_CONNECTION_STRING.

Eigenschaft Wert
Parametergruppe: Communication Arguments
--pstn-dial-out-enabled

Legen Sie dieses Kennzeichen auf "true" fest, wenn zum Zeitpunkt des Anrufs eine PSTN-Nummer in einem bestimmten Raum aktiviert ist. Dieses Flag ist standardmäßig auf „false“ festgelegt. Optional.

--valid-from

Der Zeitstempel, ab dem der Raum für die Teilnahme geöffnet ist, im ISO8601 Format, z. B. 2023-03-31T10:21. Sollte zusammen mit --valid-until verwendet werden. Optional.

--valid-until

Der Zeitstempel, ab dem der Raum nicht mehr verbunden werden kann, im ISO8601 Format, z. B. 2023-06-31T10:21. Sollte zusammen mit --valid-from verwendet werden. Optional.

Globale Parameter
--debug

Erhöhen Sie die Ausführlichkeit der Protokollierung, um alle Debugprotokolle anzuzeigen.

Eigenschaft Wert
Standardwert: False
--help -h

Diese Hilfemeldung anzeigen und schließen.

--only-show-errors

Nur Fehler anzeigen, Warnungen unterdrücken.

Eigenschaft Wert
Standardwert: False
--output -o

Ausgabeformat.

Eigenschaft Wert
Standardwert: json
Zulässige Werte: json, jsonc, none, table, tsv, yaml, yamlc
--query

JMESPath-Abfragezeichenfolge. Weitere Informationen und Beispiele finden Sie unter http://jmespath.org/.

--subscription

Name oder ID des Abonnements. Sie können das Standardabonnement mithilfe von az account set -s NAME_OR_IDkonfigurieren.

--verbose

Erhöhen Sie die Ausführlichkeit der Protokollierung. Verwenden Sie "-debug" für vollständige Debugprotokolle.

Eigenschaft Wert
Standardwert: False