Compartir a través de

az communication rooms

Note

Esta referencia forma parte de la extensión de comunicación para la CLI de Azure (versión 2.67.0 o posterior). La extensión instalará automáticamente la primera vez que ejecute un comando az communication rooms. Obtenga más información sobre las extensiones.

Comandos para interactuar con la puerta de enlace de Salas de Azure Communication Services.

Comandos

Nombre Description Tipo Estado
az communication rooms create

Cree una nueva sala.

 Extension GA
az communication rooms delete

Elimine una sala existente.

 Extension GA
az communication rooms get

Devuelve atributos de una sala existente.

 Extension GA
az communication rooms list

Enumere todas las salas activas que pertenecen a un recurso actual de Communication Service.

 Extension GA
az communication rooms participant

Comandos para administrar los participantes de una sala existente.

 Extension GA
az communication rooms participant add-or-update

Agregar o actualizar participantes en una sala.

 Extension GA
az communication rooms participant get

Obtener participantes de una sala.

 Extension GA
az communication rooms participant remove

Quitar participantes de una sala.

 Extension GA
az communication rooms update

Actualice los atributos de una sala existente.

 Extension GA

az communication rooms create

Cree una nueva sala.

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]

Ejemplos

Creación de una sala con parámetros predeterminados

az communication rooms create

Creación de una sala con fecha y hora válidas y válidas

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

Creación de una sala con fecha y hora válidas y habilitadas para acceso telefónico telefónico rtc

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

Crear una sala con una lista de participantes con el rol moderador

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

Crear una sala con una lista de participantes con el rol de asistente

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

Crear una sala con una lista de participantes con roles de moderador y consumidor

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

Crear una sala con una lista de participantes con roles de asistente y colaborador

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

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--attendee-participants --attendees

Colección de identidades que se van a invitar a la sala como asistente. Optional.

--collaborator-participants --collaborators

Colección de identidades que se van a invitar a la sala como colaborador. Optional.

--connection-string

Cadena de conexión de comunicación. Variable de entorno: AZURE_COMMUNICATION_CONNECTION_STRING.

Propiedad Valor
Grupo de parámetros: Communication Arguments
--consumer-participants --consumers

Colección de identidades que se van a invitar a la sala como consumidor. Optional.

--presenter-participants --presenters

Colección de identidades que se van a invitar a la sala como moderador. Optional.

--pstn-dial-out-enabled

Establezca esta marca en true si, en el momento de la llamada, la marcación se habilita en un número RTC en una sala determinada. De forma predeterminada, esta marca se establece en false. Optional.

--valid-from

Marca de tiempo de cuando la sala está abierta para unirse, en formato ISO8601, por ejemplo: 2023-03-31T10:21. Optional.

--valid-until

Marca de tiempo desde la que la sala ya no se puede unir, en ISO8601 formato, por ejemplo: 2023-06-31T10:21. Optional.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az communication rooms delete

Elimine una sala existente.

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

Ejemplos

Eliminar una sala existente

az communication rooms delete --room "12345678901234567"

Parámetros requeridos

--room

Id. de habitación.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--connection-string

Cadena de conexión de comunicación. Variable de entorno: AZURE_COMMUNICATION_CONNECTION_STRING.

Propiedad Valor
Grupo de parámetros: Communication Arguments
--yes -y

No solicita confirmación.

Propiedad Valor
Valor predeterminado: False
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az communication rooms get

Devuelve atributos de una sala existente.

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

Ejemplos

Obtener habitación

az communication rooms get --room "12345678901234567"

Parámetros requeridos

--room

Id. de habitación.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--connection-string

Cadena de conexión de comunicación. Variable de entorno: AZURE_COMMUNICATION_CONNECTION_STRING.

Propiedad Valor
Grupo de parámetros: Communication Arguments
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az communication rooms list

Enumere todas las salas activas que pertenecen a un recurso actual de Communication Service.

az communication rooms list [--connection-string]

Ejemplos

Enumerar todas las salas activas

az communication rooms list

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--connection-string

Cadena de conexión de comunicación. Variable de entorno: AZURE_COMMUNICATION_CONNECTION_STRING.

Propiedad Valor
Grupo de parámetros: Communication Arguments
Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False

az communication rooms update

Actualice los atributos de una sala existente.

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

Ejemplos

Actualizar las propiedades válidas y válidas de una sala

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

Parámetros requeridos

--room

Id. de habitación.

Parámetros opcionales

Los parámetros siguientes son opcionales, pero dependiendo del contexto, es posible que se requiera uno o varios para que el comando se ejecute correctamente.

--connection-string

Cadena de conexión de comunicación. Variable de entorno: AZURE_COMMUNICATION_CONNECTION_STRING.

Propiedad Valor
Grupo de parámetros: Communication Arguments
--pstn-dial-out-enabled

Establezca esta marca en true si, en el momento de la llamada, la marcación se habilita en un número RTC en una sala determinada. De forma predeterminada, esta marca se establece en false. Optional.

--valid-from

Marca de tiempo de cuando la sala está abierta para unirse, en formato ISO8601, por ejemplo: 2023-03-31T10:21. Debe usarse junto con --valid-until. Optional.

--valid-until

Marca de tiempo desde la que la sala ya no se puede unir, en ISO8601 formato, por ejemplo: 2023-06-31T10:21. Debe usarse junto con --valid-from. Optional.

Parámetros globales
--debug

Aumente el nivel de detalle del registro para mostrar todos los registros de depuración.

Propiedad Valor
Valor predeterminado: False
--help -h

Mostrar este mensaje de ayuda y salir.

--only-show-errors

Solo se muestran errores, suprimiendo advertencias.

Propiedad Valor
Valor predeterminado: False
--output -o

Formato de salida.

Propiedad Valor
Valor predeterminado: json
Valores aceptados: json, jsonc, none, table, tsv, yaml, yamlc
--query

Cadena de consulta JMESPath. Consulte http://jmespath.org/ para obtener más información y ejemplos.

--subscription

Nombre o identificador de la suscripción. Puede configurar la suscripción predeterminada mediante az account set -s NAME_OR_ID.

--verbose

Aumente el nivel de detalle del registro. Usa --debug para ver registros de depuración completos.

Propiedad Valor
Valor predeterminado: False