az communication rooms

  • Referenz

Hinweis

Diese Referenz ist Teil der Kommunikationserweiterung für die Azure CLI (Version 2.59.0 oder höher). Die Erweiterung wird automatisch installiert, wenn Sie einen Az-Kommunikationsraumbefehl zum ersten Mal ausführen. Weitere Informationen zu 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.

 Erweiterung Allgemein verfügbar
az communication rooms delete

Löschen eines vorhandenen Chatrooms.

 Erweiterung Allgemein verfügbar
az communication rooms get

Gibt Attribute eines vorhandenen Raums zurück.

 Erweiterung Allgemein verfügbar
az communication rooms list

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

 Erweiterung Allgemein verfügbar
az communication rooms participant

Befehle zum Verwalten von Teilnehmern eines vorhandenen Chatrooms.

 Erweiterung Allgemein verfügbar
az communication rooms participant add-or-update

Hinzufügen oder Aktualisieren von Teilnehmern in einem Raum.

 Erweiterung Allgemein verfügbar
az communication rooms participant get

Abrufen von Teilnehmern eines Chatrooms.

 Erweiterung Allgemein verfügbar
az communication rooms participant remove

Entfernen sie Teilnehmer aus einem Chatroom.

 Erweiterung Allgemein verfügbar
az communication rooms update

Aktualisieren von Attributen eines vorhandenen Raums.

 Erweiterung Allgemein verfügbar

az communication rooms create

Erstellen Sie einen neuen Raum.

az communication rooms create [--attendee-participants]
                              [--connection-string]
                              [--consumer-participants]
                              [--presenter-participants]
                              [--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"

Optionale Parameter

--attendee-participants

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

--connection-string

Kommunikation Verbindungszeichenfolge. Umgebungsvariable: AZURE_COMMUNICATION_CONNECTION_STRING.

--consumer-participants

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

--presenter-participants

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

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

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

--connection-string

Kommunikation Verbindungszeichenfolge. Umgebungsvariable: AZURE_COMMUNICATION_CONNECTION_STRING.

--yes -y

Nicht zur Bestätigung auffordern

Standardwert: False
Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

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

--connection-string

Kommunikation Verbindungszeichenfolge. Umgebungsvariable: AZURE_COMMUNICATION_CONNECTION_STRING.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

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

--connection-string

Kommunikation Verbindungszeichenfolge. Umgebungsvariable: AZURE_COMMUNICATION_CONNECTION_STRING.

Globale Parameter
--debug

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.

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

--connection-string

Kommunikation Verbindungszeichenfolge. Umgebungsvariable: AZURE_COMMUNICATION_CONNECTION_STRING.

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

Ausführlichkeit der Protokollierung erhöhen, um alle Debugprotokolle anzuzeigen.

--help -h

Zeigen Sie diese Hilfemeldung an, und schließen Sie sie.

--only-show-errors

Nur Fehler anzeigen und Warnungen unterdrücken.

--output -o

Ausgabeformat.

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

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

--subscription

Der Name oder die ID des Abonnements. Sie können das standardmäßig verwendete Abonnement mittels az account set -s NAME_OR_ID konfigurieren.

--verbose

Ausführlichkeit der Protokollierung erhöhen. „--debug“ für vollständige Debugprotokolle verwenden.