Ações do Azure Cosmos DB

As ações do Azure Cosmos DB permitem ler, gravar e gerenciar documentos e bancos de dados no Azure Cosmos DB diretamente dos seus fluxos de trabalho. Todas as ações se autenticam usando uma entidade de serviço do Azure AD e se comunicam com o plano de dados do Cosmos DB.

Obter um item

Esta ação lê um único documento por ID de um contêiner do Azure Cosmos DB usando a API REST Azure Cosmos DB - Get Document.

Entrada	Tipo	Descrição
`clientId`	Corda	Obrigatório. ID do aplicativo (cliente) do Azure AD. Deve ser passado como um segredo. Veja como registrar um aplicativo do Azure .
`clientSecret`	Corda	Obrigatório. Segredo do cliente do Azure AD. Deve ser passado como um segredo. Veja como registrar um aplicativo do Azure .
`tenantId`	Corda	Obrigatório. O identificador do locatário do Azure AD. Pode ser passado como um segredo.
`accountName`	Corda	Obrigatório. O nome da conta do Cosmos DB. Por exemplo, `"my-cosmos-account"` .
`databaseId`	Corda	Obrigatório. O identificador do banco de dados. Por exemplo, `"TestDb"` .
`collectionId`	Corda	Obrigatório. O identificador do contêiner (coleção). Por exemplo, `"Items"` .
`itemId`	Corda	Obrigatório. O documento `id` para ler. Por exemplo, `"121"` .
`partitionKey`	Corda	Obrigatório. O valor principal de partição para o documento. Por exemplo, `"beta"` .
`selectors`	Lista	Opcional. Uma lista de seletores usados para extrair valores específicos da resposta. Por exemplo, `[{"name": "item", "expression": ".response"}]` .

Saída	Tipo	Descrição
`success`	Boleano	`true` em caso de sucesso, `false` em caso de erro ou documento não encontrado.
`errorMessage`	Corda	Motivo da falha como uma mensagem.
`response`	Objeto	O corpo do documento. Para obter mais informações, consulte a API REST Azure Cosmos DB - Get Document .
`eTag`	Corda	A ETag do documento retornado, usada para controle de concorrência otimista.
`requestCharge`	Corda	As unidades de solicitação (RU) consumidas pela operação.

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

Criar um item

Esta ação cria um novo documento em um contêiner do Azure Cosmos DB usando a API REST Azure Cosmos DB - Create Document.

Entrada	Tipo	Descrição
`clientId`	Corda	Obrigatório. ID do aplicativo (cliente) do Azure AD. Deve ser passado como um segredo. Veja como registrar um aplicativo do Azure .
`clientSecret`	Corda	Obrigatório. Segredo do cliente do Azure AD. Deve ser passado como um segredo. Veja como registrar um aplicativo do Azure .
`tenantId`	Corda	Obrigatório. O identificador do locatário do Azure AD. Pode ser passado como um segredo.
`accountName`	Corda	Obrigatório. O nome da conta do Cosmos DB. Por exemplo, `"my-cosmos-account"` .
`databaseId`	Corda	Obrigatório. O identificador do banco de dados. Por exemplo, `"TestDb"` .
`collectionId`	Corda	Obrigatório. O identificador do contêiner (coleção). Por exemplo, `"Items"` .
`partitionKey`	Corda	Obrigatório. O valor principal de partição para o novo documento. Deve corresponder ao valor da propriedade da chave de partição do documento. Por exemplo, `"beta"` .
`item`	Mapa	Obrigatório. O documento a ser criado. Deve incluir a propriedade de chave de partição (por exemplo, `pk` ) definida com o mesmo valor de `partitionKey` , e normalmente um `id` .
`selectors`	Lista	Opcional. Uma lista de seletores usados para extrair valores específicos da resposta. Por exemplo, `[{"name": "newId", "expression": ".response.id"}]` .

Saída	Tipo	Descrição
`success`	Boleano	`true` em 201 Created, `false` em caso de erro.
`errorMessage`	Corda	Motivo da falha como uma mensagem.
`response`	Objeto	O documento criado conforme armazenado, incluindo campos do sistema. Para obter mais informações, consulte a API REST Azure Cosmos DB - Create Document .
`eTag`	Corda	O ETag do documento criado, usado para controle de simultaneidade otimista.
`requestCharge`	Corda	As unidades de solicitação (RU) consumidas pela operação.

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

Atualizar um item

Esta ação substitui ou faz upsert de um documento em um contêiner do Azure Cosmos DB usando a API REST Azure Cosmos DB - Replace Document. Por padrão (upsert: false) o documento já deve existir. Defina upsert: true para criar o documento se ele não existir.

Entrada	Tipo	Descrição
`clientId`	Corda	Obrigatório. ID do aplicativo (cliente) do Azure AD. Deve ser passado como um segredo. Veja como registrar um aplicativo do Azure .
`clientSecret`	Corda	Obrigatório. Segredo do cliente do Azure AD. Deve ser passado como um segredo. Veja como registrar um aplicativo do Azure .
`tenantId`	Corda	Obrigatório. O identificador do locatário do Azure AD. Pode ser passado como um segredo.
`accountName`	Corda	Obrigatório. O nome da conta do Cosmos DB. Por exemplo, `"my-cosmos-account"` .
`databaseId`	Corda	Obrigatório. O identificador do banco de dados. Por exemplo, `"TestDb"` .
`collectionId`	Corda	Obrigatório. O identificador do contêiner (coleção). Por exemplo, `"Items"` .
`itemId`	Corda	Obrigatório. O documento `id` a ser substituído. Por exemplo, `"323"` .
`partitionKey`	Corda	Obrigatório. O valor principal de partição para o documento. Por exemplo, `"beta"` .
`item`	Mapa	Obrigatório. O documento de substituição completo. Deve incluir o mesmo `id` e valor principal de partição do documento existente.
`upsert`	Boleano	Opcional. Quando `false` (padrão), substitui o documento e retorna um erro se ele não existir. Quando `true` , cria o documento se ele não existir. Aceita `true` ou `false` .
`selectors`	Lista	Opcional. Uma lista de seletores usados para extrair valores específicos da resposta. Por exemplo, `[{"name": "updatedId", "expression": ".response.id"}]` .

Saída	Tipo	Descrição
`success`	Boleano	`true` em caso de sucesso, `false` em caso de erro.
`errorMessage`	Corda	Motivo da falha como uma mensagem.
`response`	Objeto	O documento armazenado após a gravação. Para obter mais informações, consulte a API REST Azure Cosmos DB - Replace Document .
`eTag`	Corda	O ETag do documento armazenado após a gravação, usado para controle de simultaneidade otimista.
`requestCharge`	Corda	As unidades de solicitação (RU) consumidas pela operação.

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

Excluir um item

Esta ação exclui um documento de um contêiner do Azure Cosmos DB usando a API REST Azure Cosmos DB - Delete Document.

Entrada	Tipo	Descrição
`clientId`	Corda	Obrigatório. ID do aplicativo (cliente) do Azure AD. Deve ser passado como um segredo. Veja como registrar um aplicativo do Azure .
`clientSecret`	Corda	Obrigatório. Segredo do cliente do Azure AD. Deve ser passado como um segredo. Veja como registrar um aplicativo do Azure .
`tenantId`	Corda	Obrigatório. O identificador do locatário do Azure AD. Pode ser passado como um segredo.
`accountName`	Corda	Obrigatório. O nome da conta do Cosmos DB. Por exemplo, `"my-cosmos-account"` .
`databaseId`	Corda	Obrigatório. O identificador do banco de dados. Por exemplo, `"TestDb"` .
`collectionId`	Corda	Obrigatório. O identificador do contêiner (coleção). Por exemplo, `"Items"` .
`itemId`	Corda	Obrigatório. O documento `id` a ser excluído. Por exemplo, `"121"` .
`partitionKey`	Corda	Obrigatório. O valor principal da chave de partição para o documento. Deve corresponder ao valor da propriedade da chave de partição do documento. Por exemplo, `"beta"` .
`selectors`	Lista	Opcional. Uma lista de seletores usados para extrair valores específicos da resposta. Por exemplo, `[{"name": "statusCode", "expression": ".response.status_code"}]` .

Saída	Tipo	Descrição
`success`	Boleano	`true` em 204 No Content, `false` em caso de erro.
`errorMessage`	Corda	Motivo da falha como uma mensagem.
`response`	Objeto	A resposta de exclusão. Normalmente vazia em caso de sucesso. Use um seletor como `.response.status_code` para confirmar o status. Para obter mais informações, consulte a API REST Azure Cosmos DB - Delete Document .
`requestCharge`	Corda	As unidades de solicitação (RU) consumidas pela operação.

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

Descrever um banco de dados

Esta ação recupera metadados para um banco de dados do Azure Cosmos DB usando a API REST Azure Cosmos DB - Obter banco de dados.

Entrada	Tipo	Descrição
`clientId`	Corda	Obrigatório. ID do aplicativo (cliente) do Azure AD. Deve ser passado como um segredo. Veja como registrar um aplicativo do Azure .
`clientSecret`	Corda	Obrigatório. Segredo do cliente do Azure AD. Deve ser passado como um segredo. Veja como registrar um aplicativo do Azure .
`tenantId`	Corda	Obrigatório. O identificador do locatário do Azure AD. Pode ser passado como um segredo.
`accountName`	Corda	Obrigatório. O nome da conta do Cosmos DB. Por exemplo, `"my-cosmos-account"` .
`databaseId`	Corda	Obrigatório. O banco de dados a ser descrito. Por exemplo, `"TestDb"` .
`selectors`	Lista	Opcional. Uma lista de seletores usados para extrair valores específicos da resposta. Por exemplo, `[{"name": "id", "expression": ".response.id"}]` .

Saída	Tipo	Descrição
`success`	Boleano	`true` em caso de sucesso, `false` em caso de erro ou banco de dados não encontrado.
`errorMessage`	Corda	Motivo da falha como uma mensagem.
`response`	Objeto	O recurso de banco de dados, incluindo campos como `id` , `_rid` , `_self` , `_ts` , `_colls` e `_users` . Para obter mais informações, consulte a API REST Azure Cosmos DB - Obter banco de dados .
`eTag`	Corda	A ETag do recurso de banco de dados.

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

Esta tradução de máquina é fornecida para sua comodidade.

Obter um item .css-21sua1{background:none;border:none;width:0;padding:0;}

Criar um item

Atualizar um item

Excluir um item

Descrever um banco de dados

Obter um item