> For the complete documentation index, see [llms.txt](https://docs.realmjoin.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.realmjoin.com/es/dev-reference/interacting-with-runbooks.md). # Interactuar con runbooks ## Descripción general RealmJoin te permite usar los Runbooks de Azure Automation para automatizar las operaciones diarias en tu entorno. Consulta [Runbooks](/es/automatizacion/runbooks.md) para más información. La API de RealmJoin te permite iniciar runbooks desde tu aplicación para consultar la ejecución correcta de ejecuciones activadas previamente. Consulta [la descripción Swagger de RealmJoin](https://customer-api.realmjoin.com/swagger/index.html) para ver qué operaciones son compatibles actualmente. Las siguientes secciones explican cómo usar la API de RealmJoin para iniciar y hacer seguimiento de trabajos de runbook. Se supone que ya has [conectado una cuenta de Azure Automation](/es/automatizacion/connecting-azure-automation.md) a RealmJoin Portal. Además, asegúrate de [autenticar ](/es/dev-reference/realmjoin-api/authentication.md)cada solicitud a la API de RealmJoin usando un encabezado http Authorization adecuado. ## ¿Cómo maneja Azure Automation los runbooks? Azure Automation tiene un enfoque de procesamiento por lotes respecto a los runbooks. Cuando activas la ejecución de un runbook, se crea un trabajo para ese runbook y se pone en cola para su ejecución. Así que, en general, un runbook no se iniciará inmediatamente. Además, pueden existir varios trabajos para el mismo runbook al mismo tiempo en distintos estados de ejecución. Cada trabajo tiene un conjunto de parámetros (entradas) que se pasan al script del runbook. Esto puede ser, por ejemplo, dos variables como `$username` y `$newEmailAddress` si se supone que el runbook debe agregar un alias de eMail al buzón de un usuario. Cada trabajo tiene un estado que representa su estado actual de ejecución, consulta [Microsoft Docs](https://docs.microsoft.com/en-us/azure/automation/automation-runbook-execution#job-statuses). Nos centraremos en `Queued`, `Running`, `Completed` y `Failed` en este documento. Ten en cuenta que esto es una simplificación para facilitar la comprensión. ## Iniciar un trabajo de Runbook La API de RealmJoin ofrece dos endpoints para activar runbooks. `run` ejecutará un runbook de forma síncrona y solo devolverá/finalizará cuando el runbook realmente se haya completado o haya fallado. Este endpoint devuelve directamente el estado de éxito y la salida del trabajo de runbook asociado. `start` tendrá los mismos parámetros que `run` pero funciona de forma asíncrona. Devolverá tan pronto como un trabajo de runbook se haya puesto en cola. Devolverá el `jobID` para facilitar el seguimiento del nuevo trabajo. ### Convención de nombres de los runbooks Los runbooks se direccionan por su nombre en Azure Automation. En resumen: * ¿Se sincroniza desde el repositorio GitHub de RealmJoin? Añade `prefijo rjgit-`como prefijo * Ya sea `org_`, `device_`, `group_`, `user_` como ámbito (exactamente uno de esos) * Una categoría, como `general_`o `security_` * El nombre del runbook, separado por `_` como `add-xyz-exception` El resultado en este caso sería: `rjgit-org_security_add-xyz-exception` Vea [Convenciones de nomenclatura](/es/automatizacion/runbooks/naming-conventions.md) para más detalles. ### Ejemplo Supongamos la siguiente situación: * Tienes tus credenciales de la API de RealmJoin y las has codificado en `dC0xMjM0MTIzNDpteVMzY3JldCE=` (Base64) * Quieres iniciar el runbook `rjgit-user_security_revoke-or-restore-access` para bloquear el inicio de sesión de un usuario específico * Los parámetros para el runbook (PowerShell) son: * `$UserName = "someone@contoso.com"` * `$Revoke = $true` Usaremos el `run` endpoint para saber de inmediato si el trabajo fue exitoso. Vamos a construir el **solicitar**: Encabezados: ```http Authorization: Basic dC0xMjM0MTIzNDpteVMzY3JldCE= Content-Type: application/json ``` Solicitud / URI: ```http POST https://customer-api.realmjoin.com/runbook/rjgit-user_security_revoke-or-restore-access/run ``` Cuerpo (en notación JSON): ```json { "UserName": "someone@contoso.com", "Revoke": true } ``` La solicitud tardará un poco, ya que espera a que se ejecute el trabajo. Asegúrate de adaptar en consecuencia el tiempo de espera de tus clientes HTTP. Si no, prueba a usar el `start` endpoint, que devolverá la respuesta de inmediato. La respuesta contendrá el `jobID`, el `estado` (`Failed` o `Completed`) y todos los flujos de salida del runbook. **Respuesta**: Estado HTTP: `200` (OK) Cuerpo (en notación JSON): ```json { "jobID": "1234545e-7a24-436a-90c9-6056b512345", "status": "Completed", "streams": [ { "time": "2021-12-15T14:47:27.7756185+00:00", "summary": "RealmJoin.RunbookHelper: Ejecutándose en la cuenta de Azure Automation", "streamType": "Verbose", "streamText": null, "value": null }, { "time": "2021-12-15T14:47:27.96063+00:00", "summary": "getAutomationConnectionOrFromLocalCertificate: Obteniendo la conexión de automatización 'AzureRunAsConnection'", "streamType": "Verbose", "streamText": null, "value": null }, { "time": "2021-12-15T14:47:31.560861+00:00", "summary": "Connect-RjRbAzureAD: Conectando con el módulo AzureAD: ...", "streamType": "Verbose", "streamText": null, "value": null }, { "time": "2021-12-15T14:47:33.8860333+00:00", "summary": "## El acceso del usuario para someone@contoso.com ha sido revocado.", "streamType": "Output", "streamText": null, "value": null } ] } ``` Los flujos de salida se separan en diferentes canales (`streamTypes`): `Output`, `Verbose`, `Error`). Esto permite filtrar errores o reducir la salida solo a la información relevante mostrando únicamente `Output`. Puedes obtener estos flujos después de que un runbook haya finalizado usando el `/runbook/jobs/{jobID}/output/streams` endpoint. (consulta abajo) ## Consulta del estado y la salida de un trabajo Si un trabajo ya se ha creado, puedes usar la API de RealmJoin para consultar su estado y su salida. ### Consulta del estado del trabajo Utilice `/runbook/jobs/{jobID}/status` para consultar el estado actual. Vea [Autenticación ](/es/dev-reference/realmjoin-api/authentication.md)sobre cómo crear un encabezado de autorización, lo siguiente es solo un ejemplo. Supón que el `jobID` es `1234545e-7a24-436a-90c9-6056b512345` **`Solicitud`** Encabezados: ```http Authorization: Basic dC0xMjM0MTIzNDpteVMzY3JldCE= Content-Type: application/json ``` Solicitud / URI: ```html GET https://customer-api.realmjoin.com/runbook/jobs/1234545e-7a24-436a-90c9-6056b512345/status ``` Esta solicitud no tiene cuerpo. **Respuesta** Estado HTTP 200 (OK) Cuerpo (texto plano) ``` Completed ``` Otros estados posibles incluyen `New`, `Failed`, `Running`. Consulta [posibles estados de Runbook](https://docs.microsoft.com/en-us/azure/automation/automation-runbook-execution#job-statuses). ### Lectura de la salida del trabajo Utilice `/runbook/jobs/{jobID}/output/text` para obtener una representación de texto plano sencilla de la salida de un runbook. Esto no incluirá el `Verbose` y `Error` flujo. Consulta [lectura de flujos](#reading-specific-streams) para leer otros flujos. [Excepciones](#reading-exceptions) se tratan por separado. Vea [Autenticación ](/es/dev-reference/realmjoin-api/authentication.md)sobre cómo crear un encabezado de autorización, lo siguiente es solo un ejemplo. Supón que el `jobID` es `1234545e-7a24-436a-90c9-6056b512345` **Solicitud** Encabezados: ```http Authorization: Basic dC0xMjM0MTIzNDpteVMzY3JldCE= Content-Type: application/json ``` Solicitud / URI: ```html GET https://customer-api.realmjoin.com/runbook/jobs/1234545e-7a24-436a-90c9-6056b512345/output/text ``` Esta solicitud no tiene cuerpo. **Respuesta** Estado HTTP 200 (OK) Cuerpo (texto plano) ``` ## El grupo de distribución 'Sales Team' ha sido creado. ``` ### Lectura de flujos específicos Utilice `/runbook/jobs/{jobID}/output/streams` para obtener una representación JSON completa de la salida de un runbook. De esta manera puedes acceder al `Output`, `Verbose` y `Error` flujo. [Excepciones](#reading-exceptions) se tratan por separado. Vea [Autenticación ](/es/dev-reference/realmjoin-api/authentication.md)sobre cómo crear un encabezado de autorización, lo siguiente es solo un ejemplo. Supón que el `jobID` es `1234545e-7a24-436a-90c9-6056b512345` **Solicitud (todos los flujos)** Encabezados: ```http Authorization: Basic dC0xMjM0MTIzNDpteVMzY3JldCE= Content-Type: application/json ``` Solicitud / URI: ```html GET https://customer-api.realmjoin.com/runbook/jobs/1234545e-7a24-436a-90c9-6056b512345/output/streams ``` Esta solicitud no tiene cuerpo. **Respuesta** Estado HTTP 200 (OK) Cuerpo (JSON, matriz de mensajes) ```json [ { "time": "2021-12-20T08:37:46.8572747+00:00", "summary": "Carga del módulo desde la ruta 'C:\\Modules\\User\\RealmJoin.RunbookHelper\\RealmJoin.RunbookHelper.psd1'.", "streamType": "Verbose", "streamText": null, "value": null }, { "time": "2021-12-20T08:37:46.9272241+00:00", "summary": "Carga del módulo desde la ruta 'C:\\Modules\\User\\RealmJoin.RunbookHelper\\RealmJoin.RunbookHelper.psm1'.", "streamType": "Verbose", "streamText": null, "value": null }, { "time": "2021-12-20T08:37:47.1522235+00:00", "summary": "RealmJoin.RunbookHelper: Ejecutándose en la cuenta de Azure Automation", "streamType": "Verbose", "streamText": null, "value": null }, { "time": "2021-12-20T08:37:47.3122219+00:00", "summary": "Salida normal", "streamType": "Output", "streamText": null, "value": null }, { "time": "2021-12-20T08:37:47.8422225+00:00", "summary": "Mensaje detallado o de depuración", "streamType": "Verbose", "streamText": null, "value": null }, { "time": "2021-12-20T08:37:47.7672223+00:00", "summary": "Mensaje de error no interrumpible", "streamType": "Error", "streamText": null, "value": null } ] ``` Consulta abajo para leer los mensajes de error que interrumpen y [excepciones](#reading-exceptions) Para recibir solo un flujo, por ejemplo Verbose, puedes agregar un filtro a la solicitud añadiendo `?streamTypes=Verbose`. También puedes filtrar por `Output` y `Error`. **Solicitud (filtrar para un solo flujo)** Encabezados: ```http Authorization: Basic dC0xMjM0MTIzNDpteVMzY3JldCE= Content-Type: application/json ``` Solicitud / URI: ```html GET https://customer-api.realmjoin.com/runbook/jobs/1234545e-7a24-436a-90c9-6056b512345/output/streams?streamTypes=Verbose ``` Esta solicitud no tiene cuerpo. **Respuesta** Estado HTTP 200 (OK) Cuerpo (JSON, matriz de mensajes) ```json [ { "time": "2021-12-20T08:37:46.8572747+00:00", "summary": "Carga del módulo desde la ruta 'C:\\Modules\\User\\RealmJoin.RunbookHelper\\RealmJoin.RunbookHelper.psd1'.", "streamType": "Verbose", "streamText": null, "value": null }, { "time": "2021-12-20T08:37:46.9272241+00:00", "summary": "Carga del módulo desde la ruta 'C:\\Modules\\User\\RealmJoin.RunbookHelper\\RealmJoin.RunbookHelper.psm1'.", "streamType": "Verbose", "streamText": null, "value": null }, { "time": "2021-12-20T08:37:47.1522235+00:00", "summary": "RealmJoin.RunbookHelper: Ejecutándose en la cuenta de Azure Automation", "streamType": "Verbose", "streamText": null, "value": null }, { "time": "2021-12-20T08:37:47.8422225+00:00", "summary": "Mensaje detallado o de depuración", "streamType": "Verbose", "streamText": null, "value": null } ] ``` ### Lectura de excepciones Utilice `/runbook/jobs/{jobID}/exception/text` para obtener una representación de texto plano sencilla del mensaje de excepción de un runbook (si existe). Esto no incluirá los `Output`, `Verbose` y `Error` flujos. Consulta [lectura de flujos](#reading-specific-streams) para leer otros flujos. Las excepciones se escriben cuando se producen errores que interrumpen la ejecución del script de PowerShell asociado con el runbook. Este endpoint solo leerá el mensaje de texto plano y no incluye detalles técnicos, como en qué línea de código se detuvo el script. En nuestro ejemplo, un error que interrumpía fue causado por `throw "Exception"`. Vea [Autenticación ](/es/dev-reference/realmjoin-api/authentication.md)sobre cómo crear un encabezado de autorización, lo siguiente es solo un ejemplo. Supón que el `jobID` es `1234545e-7a24-436a-90c9-6056b512345` **Solicitud** Encabezados: ```http Authorization: Basic dC0xMjM0MTIzNDpteVMzY3JldCE= Content-Type: application/json ``` Solicitud / URI: ```html GET https://customer-api.realmjoin.com/runbook/jobs/1234545e-7a24-436a-90c9-6056b512345/exception/text ``` Esta solicitud no tiene cuerpo. **Respuesta** Estado HTTP 200 (OK) Cuerpo (texto plano) ``` Excepción (Exception) ``` --- # Agent Instructions This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com. ## Querying This Documentation If you need additional information that is not directly available in this page, you can query the documentation dynamically by asking a question. Perform an HTTP GET request on the current page URL with the `ask` query parameter, and the optional `goal` query parameter: ``` GET https://docs.realmjoin.com/es/dev-reference/interacting-with-runbooks.md?ask=&goal= ``` `ask` is the immediate question: it should be specific, self-contained, and written in natural language. `goal` is optional and describes the broader end goal you are ultimately trying to accomplish on behalf of the user. GitBook uses it to tailor the answer towards what is most useful for that goal. The response will contain a direct answer to the question and relevant excerpts and sources from the documentation. Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.