Microsoft Azure Key Vault (beta) Query Vault Objects activity¶

Introduction¶

A Microsoft Azure Key Vault (beta) Query Vault Objects activity, using its Microsoft Azure Key Vault (beta) connection, retrieves a certificate, key, or secret from Microsoft Azure Key Vault and is intended to be used as a source to provide data in an operation.

Create a Microsoft Azure Key Vault (beta) Query Vault Objects activity¶

An instance of a Microsoft Azure Key Vault (beta) Query Vault Objects activity is created from a Microsoft Azure Key Vault (beta) connection using its Query Vault Objects activity type.

To create an instance of an activity, drag the activity type to the design canvas or copy the activity type and paste it on the design canvas. For details, see Creating an activity instance in Component reuse.

An existing Microsoft Azure Key Vault (beta) Query Vault Objects activity can be edited from these locations:

• The design canvas (see Component actions menu in Design canvas).
• The project pane's Components tab (see Component actions menu in Project pane Components tab).

Configure a Microsoft Azure Key Vault (beta) Query Vault Objects activity¶

Follow these steps to configure a Microsoft Azure Key Vault (beta) Query Vault Objects activity:

• Step 1: Enter a name and select a vault
  Provide a name for the activity and select a vault.

• Step 2: Select a vault object type
  Select a vault object type.

• Step 3: Specify or select a vault object
  Specify or select a vault object.

• Step 4: Select a query operation
  Select a query operation.

• Step 5: Review the data schemas
  Any request or response schemas are displayed.

Step 1: Enter a name and select a vault¶

In this step, provide a name for the activity and select a vault. Each user interface element of this step is described below.

• Name: Enter a name to identify the activity. The name must be unique for each Microsoft Azure Key Vault (beta) Query Vault Objects activity and must not contain forward slashes / or colons :.

• Select a vault: This section displays vaults available in the Microsoft Azure Key Vault (beta) endpoint.

  • Selected vault: After a vault is selected, it is listed here.

  • Search: Enter any column's value into the search box to filter the list of vaults. The search is not case-sensitive. If vaults are already displayed within the table, the table results are filtered in real time with each keystroke. To reload vaults from the endpoint when searching, enter search criteria and then refresh, as described below.

  • Refresh: Click the refresh icon or the word Refresh to reload vaults from the Microsoft Azure Key Vault (beta) endpoint. This may be useful if vaults have been added to Microsoft Azure Key Vault. This action refreshes all metadata used to build the table of vaults displayed in the configuration.

  • Selecting a vault: Within the table, click anywhere on a row to select a vault. Only one vault can be selected. The information available for each vault is fetched from the Microsoft Azure Key Vault (beta) endpoint:

    • Name: The name of the vault.

    • Location: The Azure region the vault is located in.

    • Resource group: The resource group of the vault.

  Tip

  If the table does not populate with available vaults, the Microsoft Azure Key Vault (beta) connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

• Optional settings: Click to expand additional optional settings:

  • Continue on error: Select to continue the activity execution if an error is encountered for a dataset in a batch request. If any errors are encountered, they are written to the operation log.

• Save & Exit: If enabled, click to save the configuration for this step and close the activity configuration.

• Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 2: Select a vault object type¶

In this step, select a vault object type. Each user interface element of this step is described below.

• Select an object type: This section displays vault object types available in the Microsoft Azure Key Vault (beta) endpoint. For more information on the supported Certificate, Key, and Store vault object types, refer to the the Microsoft Azure Key Vault REST API documentation.

  • Selected vault: The vault selected in the previous step is listed here.

  • Selected object type: After a vault object type is selected, it is listed here.

  • Search: Enter any column's value into the search box to filter the list of vault object types. The search is not case-sensitive. If vault object types are already displayed within the table, the table results are filtered in real time with each keystroke. To reload vault object types from the endpoint when searching, enter search criteria and then refresh, as described below.

  • Refresh: Click the refresh icon or the word Refresh to reload vault object types from the Microsoft Azure Key Vault (beta) endpoint. This may be useful if vault object types have been added to Microsoft Azure Key Vault. This action refreshes all metadata used to build the table of vault object types displayed in the configuration.

  • Selecting an object type: Within the table, click anywhere on a row to select a vault object type. Only one vault object type can be selected. The information available for each vault object type is fetched from the Microsoft Azure Key Vault (beta) endpoint:

    • Name: The name of the object type.

    • Description: The description of the object type.

  Tip

  If the table does not populate with available vault object types, the Microsoft Azure Key Vault (beta) connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

• Back: Click to temporarily store the configuration for this step and return to the previous step.

• Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 3: Specify or select a vault object¶

In this step, specify or select a vault object. Each user interface element of this step is described below.

• Choose activity: Specify the activity to be used, one of Inform object manually or Select existent object.

  If Inform object manually is selected for Choose activity, this interface is presented:

  • Object name: Name of the vault object.

  If Select existent object is selected for Choose activity, this interface is presented:

  

  • Select an object: This section displays vault objects available in the Microsoft Azure Key Vault (beta) endpoint.

    • Selected object type: The vault object type selected in the previous step is listed here.

    • Selected object: After an object is selected, it is listed here.

    • Search: Enter any column's value into the search box to filter the list of vault objects. The search is not case-sensitive. If vault objects are already displayed within the table, the table results are filtered in real time with each keystroke. To reload vault objects from the endpoint when searching, enter search criteria and then refresh, as described below.

    • Refresh: Click the refresh icon or the word Refresh to reload vault objects from the Microsoft Azure Key Vault (beta) endpoint. This may be useful if vault objects have been added to Microsoft Azure Key Vault. This action refreshes all metadata used to build the table of vault objects displayed in the configuration.

    • Selecting an object: Within the table, click anywhere on a row to select a vault object. Only one object type can be selected. The information available for each object is fetched from the Microsoft Azure Key Vault (beta) endpoint:

      • Name: The name of the object.

      • Description: The description of the object.

    Tip

    If the table does not populate with available vault objects, the Microsoft Azure Key Vault (beta) connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

• Back: Click to temporarily store the configuration for this step and return to the previous step.

• Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 4: Select a query operation¶

In this step, select a query operation. Each user interface element of this step is described below.

• Select an operation: This section displays query operations available in the Microsoft Azure Key Vault (beta) endpoint. For more information on operations, refer to the the Microsoft Azure Key Vault REST API documentation.

  • Selected vault: The vault selected in the previous step is listed here.

  • Selected operation: After a query operation is selected, it is listed here.

  • Search: Enter any column's value into the search box to filter the list of query operations. The search is not case-sensitive. If query operations are already displayed within the table, the table results are filtered in real time with each keystroke. To reload query operations from the endpoint when searching, enter search criteria and then refresh, as described below.

  • Refresh: Click the refresh icon or the word Refresh to reload query operations from the Microsoft Azure Key Vault (beta) endpoint. This may be useful if query operations have been added to Microsoft Azure Key Vault. This action refreshes all metadata used to build the table of query operations displayed in the configuration.

  • Selecting an operation: Within the table, click anywhere on a row to select a query operation. Only one query operation can be selected. The information available for each query operation is fetched from the Microsoft Azure Key Vault (beta) endpoint:

    • Name: The name of the query operation.

    • Description: The description of the query operation.

  Tip

  If the table does not populate with available query operations, the Microsoft Azure Key Vault (beta) connection may not be successful. Ensure you are connected by reopening the connection and retesting the credentials.

• Back: Click to temporarily store the configuration for this step and return to the previous step.

• Next: Click to temporarily store the configuration for this step and continue to the next step. The configuration will not be saved until you click the Finished button on the last step.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Step 5: Review the data schemas¶

Any request or response schemas are displayed. Each user interface element of this step is described below.

• Data schema: These data schemas are inherited by adjacent transformations and are displayed again during transformation mapping.

  The Microsoft Azure Key Vault (beta) connector uses the Microsoft Azure Key Vault REST API. Refer to the API documentation for information on the schema nodes and fields.

• Refresh: Click the refresh icon or the word Refresh to regenerate schemas from the Microsoft Azure Key Vault (beta) endpoint. This action also regenerates a schema in other locations throughout the project where the same schema is referenced, such as in an adjacent transformation.

• Back: Click to temporarily store the configuration for this step and return to the previous step.

• Finished: Click to save the configuration for all steps and close the activity configuration.

• Discard Changes: After making changes, click to close the configuration without saving changes made to any step. A message asks you to confirm that you want to discard changes.

Next steps¶

After configuring a Microsoft Azure Key Vault (beta) Query Vault Objects activity, complete the configuration of the operation by adding and configuring other activities, transformations, or scripts as operation steps. You can also configure the operation settings, which include the ability to chain operations together that are in the same or different workflows.

Menu actions for an activity are accessible from the project pane and the design canvas. For details, see Activity actions menu in Connector basics.

Microsoft Azure Key Vault (beta) Query Vault Objects activities can be used as a source with these operation patterns:

• Transformation pattern
• Two-target archive pattern (as the first source only)
• Two-target HTTP archive pattern (as the first source only)
• Two-transformation pattern (as the first source only)

To use the activity with scripting functions, write the data to a temporary location and then use that temporary location in the scripting function.

When ready, deploy and run the operation and validate behavior by checking the operation logs.