Azure Cosmos DBアクション

Azure Cosmos DBアクションを使用すると、ワークフローから直接、Azure Cosmos DB内のドキュメントやデータベースの読み取り、書き込み、管理を行うことができます。すべてのアクションは、Azure ADサービスプリンシパルを使用して認証を行い、Cosmos DBデータプレーンと通信します。

アイテムの取得

このアクションは、Azure Cosmos DB - Get Document REST APIを使用して、Azure Cosmos DBコンテナからIDで単一のドキュメントを読み取ります。

入力	タイプ	説明
`clientId`	弦	必須。 Azure ADアプリ（クライアント）ID。シークレットとして渡す必要があります。 Azureアプリを登録する方法を参照してください。
`clientSecret`	弦	必須。 Azure ADクライアントシークレット。シークレットとして渡す必要があります。 Azureアプリを登録する方法を参照してください。
`tenantId`	弦	必須。 Azure ADテナント識別子。シークレットとして渡すことができます。
`accountName`	弦	必須。 Cosmos DBアカウント名。例： `"my-cosmos-account"` 。
`databaseId`	弦	必須。データベース識別子。例： `"TestDb"` 。
`collectionId`	弦	必須。コンテナ（コレクション）識別子。例： `"Items"` 。
`itemId`	弦	必須。読み取るドキュメント `id` 。たとえば、 `"121"` 。
`partitionKey`	弦	必須。ドキュメントのパーティションキーの値。例： `"beta"` 。
`selectors`	リスト	オプション。レスポンスから特定の値を抽出するために使用されるセレクターのリスト。例： `[{"name": "item", "expression": ".response"}]` 。

出力	タイプ	説明
`success`	ブール値	`true` 成功時は、エラーまたはドキュメントが見つからない場合は `false` 。
`errorMessage`	弦	メッセージとしての失敗理由。
`response`	オブジェクト	ドキュメントボディ。詳細については、 Azure Cosmos DB - Get Document REST APIを参照してください。
`eTag`	弦	楽観的同時実行制御に使用される、返されたドキュメントのETag。
`requestCharge`	弦	操作によって消費された要求ユニット（RU）。

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

アイテムの作成

このアクションは、Azure Cosmos DB - Create Document REST APIを使用して、Azure Cosmos DBコンテナに新しいドキュメントを作成します。

入力	タイプ	説明
`clientId`	弦	必須。 Azure ADアプリ（クライアント）ID。シークレットとして渡す必要があります。 Azureアプリを登録する方法を参照してください。
`clientSecret`	弦	必須。 Azure ADクライアントシークレット。シークレットとして渡す必要があります。 Azureアプリを登録する方法を参照してください。
`tenantId`	弦	必須。 Azure ADテナント識別子。シークレットとして渡すことができます。
`accountName`	弦	必須。 Cosmos DBアカウント名。例： `"my-cosmos-account"` 。
`databaseId`	弦	必須。データベース識別子。例： `"TestDb"` 。
`collectionId`	弦	必須。コンテナ（コレクション）識別子。例： `"Items"` 。
`partitionKey`	弦	必須。新しいドキュメントのパーティションキーの値。ドキュメントのパーティションキープロパティの値と一致する必要があります。例： `"beta"` 。
`item`	地図	必須。作成するドキュメント。 `partitionKey` と同じ値に設定されたパーティションキープロパティ（たとえば、 `pk` ）、および通常は `id` を含める必要があります。
`selectors`	リスト	オプション。レスポンスから特定の値を抽出するために使用されるセレクターのリスト。例： `[{"name": "newId", "expression": ".response.id"}]` 。

出力	タイプ	説明
`success`	ブール値	`true` 201 Created時、エラー時は `false` 。
`errorMessage`	弦	メッセージとしての失敗理由。
`response`	オブジェクト	システムフィールドを含めて保存された、作成されたドキュメント。詳細については、 Azure Cosmos DB - ドキュメント作成 REST API を参照してください。
`eTag`	弦	作成されたドキュメントのETag。楽観的同時実行制御に使用されます。
`requestCharge`	弦	操作によって消費された要求ユニット（RU）。

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

アイテムの更新

このアクションは、Azure Cosmos DB - Replace Document REST APIを使用して、Azure Cosmos DBコンテナ内のドキュメントを置換またはアップサートします。デフォルト（upsert: false）では、ドキュメントがすでに存在している必要があります。upsert: trueを設定すると、ドキュメントが存在しない場合は作成されます。

入力	タイプ	説明
`clientId`	弦	必須。 Azure ADアプリ（クライアント）ID。シークレットとして渡す必要があります。 Azureアプリを登録する方法を参照してください。
`clientSecret`	弦	必須。 Azure ADクライアントシークレット。シークレットとして渡す必要があります。 Azureアプリを登録する方法を参照してください。
`tenantId`	弦	必須。 Azure ADテナント識別子。シークレットとして渡すことができます。
`accountName`	弦	必須。 Cosmos DBアカウント名。例： `"my-cosmos-account"` 。
`databaseId`	弦	必須。データベース識別子。例： `"TestDb"` 。
`collectionId`	弦	必須。コンテナ（コレクション）識別子。例： `"Items"` 。
`itemId`	弦	必須。置換対象の文書 `id` 。例： `"323"` 。
`partitionKey`	弦	必須。ドキュメントのパーティションキーの値。例： `"beta"` 。
`item`	地図	必須。完全な置換ドキュメント。既存のドキュメントと同じ `id` とパーティションキーの値を含める必要があります。
`upsert`	ブール値	オプション。 `false` （デフォルト）の場合、ドキュメントを置換し、存在しない場合はエラーを返します。 `true` の場合、ドキュメントが存在しない場合は作成されます。 `true` または `false` を受け入れます。
`selectors`	リスト	オプション。レスポンスから特定の値を抽出するために使用されるセレクターのリスト。例： `[{"name": "updatedId", "expression": ".response.id"}]` 。

出力	タイプ	説明
`success`	ブール値	`true` 成功時は `false` 、エラー時は。
`errorMessage`	弦	メッセージとしての失敗理由。
`response`	オブジェクト	書き込み後に保存されたドキュメント。詳細については、 Azure Cosmos DB - Replace Document REST APIを参照してください。
`eTag`	弦	楽観的同時実行制御に使用される、書き込み後に保存されたドキュメントのETag。
`requestCharge`	弦	操作によって消費された要求ユニット（RU）。

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

アイテムの削除

このアクションは、Azure Cosmos DB - Delete Document REST APIを使用して、Azure Cosmos DBコンテナからドキュメントを削除します。

入力	タイプ	説明
`clientId`	弦	必須。 Azure ADアプリ（クライアント）ID。シークレットとして渡す必要があります。 Azureアプリを登録する方法を参照してください。
`clientSecret`	弦	必須。 Azure ADクライアントシークレット。シークレットとして渡す必要があります。 Azureアプリを登録する方法を参照してください。
`tenantId`	弦	必須。 Azure ADテナント識別子。シークレットとして渡すことができます。
`accountName`	弦	必須。 Cosmos DBアカウント名。例： `"my-cosmos-account"` 。
`databaseId`	弦	必須。データベース識別子。例： `"TestDb"` 。
`collectionId`	弦	必須。コンテナ（コレクション）識別子。例： `"Items"` 。
`itemId`	弦	必須。削除するドキュメント `id` 。例： `"121"` 。
`partitionKey`	弦	必須。ドキュメントのパーティションキーの値。ドキュメントのパーティションキープロパティの値と一致する必要があります。例： `"beta"` 。
`selectors`	リスト	オプション。レスポンスから特定の値を抽出するために使用されるセレクターのリスト。例： `[{"name": "statusCode", "expression": ".response.status_code"}]` 。

出力	タイプ	説明
`success`	ブール値	`true` 204 No Content時、エラー時は `false` 。
`errorMessage`	弦	メッセージとしての失敗理由。
`response`	オブジェクト	削除レスポンス。通常、成功時は空です。ステータスを確認するには、 `.response.status_code` などのセレクタを使用します。詳細については、 Azure Cosmos DB - Delete Document REST APIを参照してください。
`requestCharge`	弦	操作によって消費された要求ユニット（RU）。

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

データベースの記述

このアクションは、Azure Cosmos DB - Get Database REST APIを使用して、Azure Cosmos DBデータベースのメタデータを取得します。

入力	タイプ	説明
`clientId`	弦	必須。 Azure ADアプリ（クライアント）ID。シークレットとして渡す必要があります。 Azureアプリを登録する方法を参照してください。
`clientSecret`	弦	必須。 Azure ADクライアントシークレット。シークレットとして渡す必要があります。 Azureアプリを登録する方法を参照してください。
`tenantId`	弦	必須。 Azure ADテナント識別子。シークレットとして渡すことができます。
`accountName`	弦	必須。 Cosmos DBアカウント名。例： `"my-cosmos-account"` 。
`databaseId`	弦	必須。記述するデータベース。例： `"TestDb"` 。
`selectors`	リスト	オプション。レスポンスから特定の値を抽出するために使用されるセレクターのリスト。例： `[{"name": "id", "expression": ".response.id"}]` 。

出力	タイプ	説明
`success`	ブール値	`true` 成功した場合は `false` 、エラーまたはデータベースが見つからない場合は。
`errorMessage`	弦	メッセージとしての失敗理由。
`response`	オブジェクト	`id` 、 `_rid` 、 `_self` 、 `_ts` 、 `_colls` 、 `_users` などのフィールドを含むデータベースリソース。詳細については、 Azure Cosmos DB - Get Database REST APIを参照してください。
`eTag`	弦	データベースリソースのETag。

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

この機械翻訳は、参考として提供されています。

アイテムの取得 .css-21sua1{background:none;border:none;width:0;padding:0;}

アイテムの作成

アイテムの更新

アイテムの削除

データベースの記述

アイテムの取得