Cloud Keys 2020 Python Edition

Questions / Feedback?

send_custom_request Method

Sends a custom request to the server.

Syntax

def send_custom_request(http_method: str, path: str) -> None: ...

Remarks

This method can be used to send arbitrary requests to the server.

Valid values for HttpMethod are:

  • GET (default if empty)
  • HEAD
  • POST
  • PUT
  • PATCH
  • DELETE

Path is optional, and if non-empty must be specified without a leading forward slash (/).

When this method is called, the class does the following:

  1. Builds a request URL, including query parameters, based on the following:
    • The base URL https://{Vault}.vault.azure.net/keys, where {Vault} is vault.
    • The specified Path, if any.
    • An api-version query parameter whose value is APIVersion.
    • All query parameters from QueryParam*.
  2. Adds an Authorization header with the value specified by authorization.
  3. Adds any request headers from other_headers.
  4. Adds any request body supplied via the specified input_file or input_data.
  5. Sends the request to the server.
  6. Stores the response headers in the ParsedHeader* properties; and the response body in the specified output_file or output_data.

If the response body is JSON data, the XPath, XText, and other X* configuration settings can then be used to navigate and extract information from it.

Copyright (c) 2022 /n software inc. - All rights reserved.
Cloud Keys 2020 Python Edition - Version 20.0 [Build 8157]