Acciones de Azure Cosmos DB

Las acciones de Azure Cosmos DB le permiten leer, escribir y administrar documentos y bases de datos en Azure Cosmos DB directamente desde los flujos de trabajo. Todas las acciones se autentican mediante una entidad de servicio de Azure AD y se comunican con el plano de datos de Cosmos DB.

Obtener un elemento

Esta acción lee un único documento por ID de un contenedor de Azure Cosmos DB mediante la API REST Azure Cosmos DB - Get Document.

Aporte	Tipo	Descripción
`clientId`	Cadena	Requerido. ID de la aplicación (cliente) de Azure AD. Debe pasarse como un secreto. Vea cómo registrar una aplicación de Azure .
`clientSecret`	Cadena	Requerido. Secreto de cliente de Azure AD. Debe pasarse como un secreto. Vea cómo registrar una aplicación de Azure .
`tenantId`	Cadena	Requerido. El identificador de inquilino de Azure AD. Se puede pasar como un secreto.
`accountName`	Cadena	Requerido. El nombre de la cuenta de Cosmos DB. Por ejemplo, `"my-cosmos-account"` .
`databaseId`	Cadena	Requerido. El identificador de la base de datos. Por ejemplo, `"TestDb"` .
`collectionId`	Cadena	Requerido. El identificador del contenedor (colección). Por ejemplo, `"Items"` .
`itemId`	Cadena	Requerido. El documento `id` para leer. Por ejemplo, `"121"` .
`partitionKey`	Cadena	Requerido. El valor principal de partición para el documento. Por ejemplo, `"beta"` .
`selectors`	Lista	Opcional. Una lista de selectores utilizados para extraer valores específicos de la respuesta. Por ejemplo, `[{"name": "item", "expression": ".response"}]` .

Producción	Tipo	Descripción
`success`	Booleano	`true` en caso de éxito, `false` en caso de error o si no se encuentra el documento.
`errorMessage`	Cadena	Motivo del error como mensaje.
`response`	Objeto	El cuerpo del documento. Para obtener más información, consulte la API REST Azure Cosmos DB - Get Document .
`eTag`	Cadena	El ETag del documento devuelto, utilizado para el control de concurrencia optimista.
`requestCharge`	Cadena	Las unidades de solicitud (RU) consumidas por la operación.

name: cosmosGetItemWorkflow
description: ''
steps:
  - name: get_item
    type: action
    action: azure.cosmos.getItem
    version: 1
    inputs:
      clientId: ${{ :secrets:azure-client-id }}
      clientSecret: ${{ :secrets:azure-client-secret }}
      tenantId: ${{ :secrets:azure-client-tenant }}
      accountName: my-cosmos-account
      databaseId: TestDb
      collectionId: Items
      itemId: "121"
      partitionKey: beta
      selectors:
        - name: item
          expression: ".response"
    next: log_result
  - name: log_result
    type: action
    action: newrelic.ingest.sendLogs
    version: 1
    inputs:
      logs:
        - message: 'azure.cosmos.getItem result: ${{ .steps.get_item.outputs | tostring }}'
    next: end

Crear un elemento

Esta acción crea un nuevo documento en un contenedor de Azure Cosmos DB mediante la API REST Azure Cosmos DB - Create Document.

Aporte	Tipo	Descripción
`clientId`	Cadena	Requerido. ID de la aplicación (cliente) de Azure AD. Debe pasarse como un secreto. Vea cómo registrar una aplicación de Azure .
`clientSecret`	Cadena	Requerido. Secreto de cliente de Azure AD. Debe pasarse como un secreto. Vea cómo registrar una aplicación de Azure .
`tenantId`	Cadena	Requerido. El identificador de inquilino de Azure AD. Se puede pasar como un secreto.
`accountName`	Cadena	Requerido. El nombre de la cuenta de Cosmos DB. Por ejemplo, `"my-cosmos-account"` .
`databaseId`	Cadena	Requerido. El identificador de la base de datos. Por ejemplo, `"TestDb"` .
`collectionId`	Cadena	Requerido. El identificador del contenedor (colección). Por ejemplo, `"Items"` .
`partitionKey`	Cadena	Requerido. El valor principal de la partición para el nuevo documento. Debe coincidir con el valor de la propiedad de la clave de partición del documento. Por ejemplo, `"beta"` .
`item`	Mapa	Requerido. El documento para crear. Debe incluir la propiedad de clave de partición (por ejemplo, `pk` ) establecida en el mismo valor que `partitionKey` , y normalmente un `id` .
`selectors`	Lista	Opcional. Una lista de selectores utilizados para extraer valores específicos de la respuesta. Por ejemplo, `[{"name": "newId", "expression": ".response.id"}]` .

Producción	Tipo	Descripción
`success`	Booleano	`true` en 201 Created, `false` en caso de error.
`errorMessage`	Cadena	Motivo del error como mensaje.
`response`	Objeto	El documento creado tal como se almacenó, incluidos los campos del sistema. Para obtener más información, consulte la API REST Azure Cosmos DB - Create Document .
`eTag`	Cadena	El ETag del documento creado, utilizado para el control de concurrencia optimista.
`requestCharge`	Cadena	Las unidades de solicitud (RU) consumidas por la operación.

name: cosmosCreateItemWorkflow
description: ''
steps:
  - name: create_item
    type: action
    action: azure.cosmos.createItem
    version: 1
    inputs:
      clientId: ${{ :secrets:azure-client-id }}
      clientSecret: ${{ :secrets:azure-client-secret }}
      tenantId: ${{ :secrets:azure-client-tenant }}
      accountName: my-cosmos-account
      databaseId: TestDb
      collectionId: Items
      partitionKey: beta
      item:
        id: "423"
        pk: beta
        name: created-by-workflow
        category: demo
        value: 42
      selectors:
        - name: newId
          expression: .response.id
    next: log_result
  - name: log_result
    type: action
    action: newrelic.ingest.sendLogs
    version: 1
    inputs:
      logs:
        - message: 'azure.cosmos.createItem succeeded=${{ .steps.create_item.outputs.success }} newId=${{ .steps.create_item.outputs.newId }}'
    next: end

Actualizar un elemento

Esta acción reemplaza o inserta/actualiza un documento en un contenedor de Azure Cosmos DB mediante la API REST Azure Cosmos DB - Replace Document. De forma predeterminada (upsert: false), el documento ya debe existir. Establezca upsert: true para crear el documento si no existe.

Aporte	Tipo	Descripción
`clientId`	Cadena	Requerido. ID de la aplicación (cliente) de Azure AD. Debe pasarse como un secreto. Vea cómo registrar una aplicación de Azure .
`clientSecret`	Cadena	Requerido. Secreto de cliente de Azure AD. Debe pasarse como un secreto. Vea cómo registrar una aplicación de Azure .
`tenantId`	Cadena	Requerido. El identificador de inquilino de Azure AD. Se puede pasar como un secreto.
`accountName`	Cadena	Requerido. El nombre de la cuenta de Cosmos DB. Por ejemplo, `"my-cosmos-account"` .
`databaseId`	Cadena	Requerido. El identificador de la base de datos. Por ejemplo, `"TestDb"` .
`collectionId`	Cadena	Requerido. El identificador del contenedor (colección). Por ejemplo, `"Items"` .
`itemId`	Cadena	Requerido. El documento `id` para reemplazar. Por ejemplo, `"323"` .
`partitionKey`	Cadena	Requerido. El valor principal de partición para el documento. Por ejemplo, `"beta"` .
`item`	Mapa	Requerido. El documento de reemplazo completo. Debe incluir el mismo `id` y valor principal de partición que el documento existente.
`upsert`	Booleano	Opcional. Cuando es `false` (predeterminado), reemplaza el documento y devuelve un error si no existe. Cuando es `true` , crea el documento si no existe. Acepta `true` o `false` .
`selectors`	Lista	Opcional. Una lista de selectores utilizados para extraer valores específicos de la respuesta. Por ejemplo, `[{"name": "updatedId", "expression": ".response.id"}]` .

Producción	Tipo	Descripción
`success`	Booleano	`true` en caso de éxito, `false` en caso de error.
`errorMessage`	Cadena	Motivo del error como mensaje.
`response`	Objeto	El documento almacenado después de la escritura. Para obtener más información, consulte la API REST de Azure Cosmos DB - Replace Document .
`eTag`	Cadena	El ETag del documento almacenado después de la escritura, utilizado para el control de concurrencia optimista.
`requestCharge`	Cadena	Las unidades de solicitud (RU) consumidas por la operación.

name: cosmosUpdateItemWorkflow
description: ''
steps:
  - name: update_item
    type: action
    action: azure.cosmos.updateItem
    version: 1
    inputs:
      clientId: ${{ :secrets:azure-client-id }}
      clientSecret: ${{ :secrets:azure-client-secret }}
      tenantId: ${{ :secrets:azure-client-tenant }}
      accountName: my-cosmos-account
      databaseId: TestDb
      collectionId: Items
      itemId: "323"
      partitionKey: beta
      upsert: false
      item:
        id: "323"
        pk: beta
        name: updated-by-workflow
        category: demo
        value: 43
      selectors:
        - name: updatedId
          expression: .response.id
        - name: eTag
          expression: .response._etag
    next: log_result
  - name: log_result
    type: action
    action: newrelic.ingest.sendLogs
    version: 1
    inputs:
      logs:
        - message: 'azure.cosmos.updateItem succeeded=${{ .steps.update_item.outputs.success }} updatedId=${{ .steps.update_item.outputs.updatedId }} eTag=${{ .steps.update_item.outputs.eTag }}'
    next: end

Eliminar un elemento

Esta acción elimina un documento de un contenedor de Azure Cosmos DB mediante la API REST Azure Cosmos DB - Delete Document.

Aporte	Tipo	Descripción
`clientId`	Cadena	Requerido. ID de la aplicación (cliente) de Azure AD. Debe pasarse como un secreto. Vea cómo registrar una aplicación de Azure .
`clientSecret`	Cadena	Requerido. Secreto de cliente de Azure AD. Debe pasarse como un secreto. Vea cómo registrar una aplicación de Azure .
`tenantId`	Cadena	Requerido. El identificador de inquilino de Azure AD. Se puede pasar como un secreto.
`accountName`	Cadena	Requerido. El nombre de la cuenta de Cosmos DB. Por ejemplo, `"my-cosmos-account"` .
`databaseId`	Cadena	Requerido. El identificador de la base de datos. Por ejemplo, `"TestDb"` .
`collectionId`	Cadena	Requerido. El identificador del contenedor (colección). Por ejemplo, `"Items"` .
`itemId`	Cadena	Requerido. El documento `id` que se va a eliminar. Por ejemplo, `"121"` .
`partitionKey`	Cadena	Requerido. El valor principal de partición para el documento. Debe coincidir con el valor de la propiedad de la clave de partición del documento. Por ejemplo, `"beta"` .
`selectors`	Lista	Opcional. Una lista de selectores utilizados para extraer valores específicos de la respuesta. Por ejemplo, `[{"name": "statusCode", "expression": ".response.status_code"}]` .

Producción	Tipo	Descripción
`success`	Booleano	`true` en 204 No Content, `false` en caso de error.
`errorMessage`	Cadena	Motivo del error como mensaje.
`response`	Objeto	La respuesta de eliminación. Normalmente vacía en caso de éxito. Use un selector como `.response.status_code` para confirmar el estado. Para obtener más información, consulte la API REST Azure Cosmos DB - Delete Document .
`requestCharge`	Cadena	Las unidades de solicitud (RU) consumidas por la operación.

name: cosmosDeleteItemWorkflow
description: ''
steps:
  - name: delete_item
    type: action
    action: azure.cosmos.deleteItem
    version: 1
    inputs:
      clientId: ${{ :secrets:azure-client-id }}
      clientSecret: ${{ :secrets:azure-client-secret }}
      tenantId: ${{ :secrets:azure-client-tenant }}
      accountName: my-cosmos-account
      databaseId: TestDb
      collectionId: Items
      itemId: "121"
      partitionKey: beta
      selectors:
        - name: statusCode
          expression: ".response.status_code"
    next: log_result
  - name: log_result
    type: action
    action: newrelic.ingest.sendLogs
    version: 1
    inputs:
      logs:
        - message: 'azure.cosmos.deleteItem result: ${{ .steps.delete_item.outputs | tostring }}'
    next: end

Describe una base de datos

Esta acción recupera metadatos para una base de datos de Azure Cosmos DB mediante la API REST Azure Cosmos DB - Get Database.

Aporte	Tipo	Descripción
`clientId`	Cadena	Requerido. ID de la aplicación (cliente) de Azure AD. Debe pasarse como un secreto. Vea cómo registrar una aplicación de Azure .
`clientSecret`	Cadena	Requerido. Secreto de cliente de Azure AD. Debe pasarse como un secreto. Vea cómo registrar una aplicación de Azure .
`tenantId`	Cadena	Requerido. El identificador de inquilino de Azure AD. Se puede pasar como un secreto.
`accountName`	Cadena	Requerido. El nombre de la cuenta de Cosmos DB. Por ejemplo, `"my-cosmos-account"` .
`databaseId`	Cadena	Requerido. La base de datos que se va a describir. Por ejemplo, `"TestDb"` .
`selectors`	Lista	Opcional. Una lista de selectores utilizados para extraer valores específicos de la respuesta. Por ejemplo, `[{"name": "id", "expression": ".response.id"}]` .

Producción	Tipo	Descripción
`success`	Booleano	`true` en caso de éxito, `false` en caso de error o base de datos no encontrada.
`errorMessage`	Cadena	Motivo del error como mensaje.
`response`	Objeto	El recurso de la base de datos, incluidos campos como `id` , `_rid` , `_self` , `_ts` , `_colls` y `_users` . Para obtener más información, consulte la API REST Azure Cosmos DB - Obtener base de datos .
`eTag`	Cadena	El ETag del recurso de base de datos.

name: cosmosDescribeDatabaseWorkflow
description: ''
steps:
  - name: describeDatabase
    type: action
    action: azure.cosmos.describeDatabase
    version: 1
    inputs:
      clientId: ${{ :secrets:azure-client-id }}
      clientSecret: ${{ :secrets:azure-client-secret }}
      tenantId: ${{ :secrets:azure-client-tenant }}
      accountName: my-cosmos-account
      databaseId: TestDb
      selectors:
        - name: database
          expression: ".response"
        - name: id
          expression: ".response.id"
        - name: eTag
          expression: ".eTag"
  - name: logResult
    type: action
    action: newrelic.ingest.sendLogs
    version: 1
    inputs:
      logs:
        - message: 'azure.cosmos.describeDatabase database: ${{ .steps.describeDatabase.outputs.database | tostring }}'
          attributes:
            success: ${{ .steps.describeDatabase.outputs.success }}
            id: ${{ .steps.describeDatabase.outputs.id }}
            eTag: ${{ .steps.describeDatabase.outputs.eTag }}
    next: end

Te ofrecemos esta traducción automática para facilitar la lectura.

Obtener un elemento .css-21sua1{background:none;border:none;width:0;padding:0;}

Crear un elemento

Actualizar un elemento

Eliminar un elemento

Describe una base de datos

Obtener un elemento