blueprintterraformintegrations#
- async idem_vra.exec.vra.blueprint.blueprintterraformintegrations.create_blueprint_from_mapping_using_post(hub, ctx, **kwargs)[source]#
- Creates a blueprint from a Terraform blueprint configuration (obtained from
/create-blueprint-mapping). Performs POST /blueprint/api/blueprint-integrations/terraform/create-blueprint-from-mapping
- Parameters:
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /blueprint/api/about
createdAt (string) – (optional in body) Created time
createdBy (string) – (optional in body) Created by
description (string) – (optional in body) Blueprint description.
id (string) – (optional in body) Object ID
name (string) – (optional in body) Blueprint name.
orgId (string) – (optional in body) Org ID
projectId (string) – (optional in body) Project ID
projectName (string) – (optional in body) Project Name
terraformToBlueprintMapping (Any) – (optional in body)
updatedAt (string) – (optional in body) Updated time
updatedBy (string) – (optional in body) Updated by
version (string) – (optional in body) Terraform runtime version.
- async idem_vra.exec.vra.blueprint.blueprintterraformintegrations.create_blueprint_mapping_using_post(hub, ctx, **kwargs)[source]#
- Retrieves and parses the specified Terraform configuration file(s) and returns
relevant information for blueprint construction. Performs POST /blueprint/api/blueprint-integrations/terraform/create-blueprint-mapping
- Parameters:
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /blueprint/api/about
commitId (string) – (optional in body) ID that identifies the commit that corresponds to the desired version of the remote file(s).
repositoryId (string) – (optional in body) The ID of the relevant configuration source repository.
sourceDirectory (string) – (optional in body) A path to the desired Terraform directory.
- async idem_vra.exec.vra.blueprint.blueprintterraformintegrations.create_terraform_version_using_post(hub, ctx, **kwargs)[source]#
Creates a version Performs POST /blueprint/api/blueprint-integrations/terraform/versions
- Parameters:
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /blueprint/api/about
authenticationType (string) – (optional in body) The type of authentication for the download url
createdAt (string) – (optional in body) Created time
createdBy (string) – (optional in body) Created by
description (string) – (optional in body) Version description
enabled (boolean) – (optional in body) Version status
id (string) – (optional in body) Version ID
orgId (string) – (optional in body) Org ID
password (string) – (optional in body) The password for basic authentication
sha256Checksum (string) – (optional in body) The sha256 checksum of the terraform binary
updatedAt (string) – (optional in body) Updated time
updatedBy (string) – (optional in body) Updated by
url (string) – (optional in body) Download url
username (string) – (optional in body) The user name for basic authentication
version (string) – (optional in body) The numeric version of terraform release
- async idem_vra.exec.vra.blueprint.blueprintterraformintegrations.delete_terraform_version_using_delete(hub, ctx, p_versionId, **kwargs)[source]#
Deletes a terraform version Performs DELETE /blueprint/api/blueprint-integrations/terraform/versions/{versionId}
- Parameters:
p_versionId (string) – (required in path) versionId
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /blueprint/api/about
- async idem_vra.exec.vra.blueprint.blueprintterraformintegrations.get_configuration_source_tree_using_get(hub, ctx, q_configurationSourceId, **kwargs)[source]#
- Shows directories of the configuration source repository that correspond to
Terraform configurations. Performs GET /blueprint/api/blueprint-integrations/terraform/get-configuration-source-tree
- Parameters:
q_configurationSourceId (string) – (required in query) The ID of the configuration source to inspect.
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /blueprint/api/about
commitId (string) – (optional in query) The commit ID corresponding to the version of the configuration source.
path (string) – (optional in query) A file path prefix. The prefix is interpreted in the context of the configuration source’s path prefix. Results will only include directories under this path.
- async idem_vra.exec.vra.blueprint.blueprintterraformintegrations.get_terraform_configuration_source_commit_list_using_get(hub, ctx, q_configurationSourceId, **kwargs)[source]#
Returns a paginated list of commits for a specified configuration source. Performs GET /blueprint/api/blueprint-integrations/terraform/get-configuration-source-commits
- Parameters:
q_configurationSourceId (string) – (required in query) A Configuration Source ID.
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /blueprint/api/about
- async idem_vra.exec.vra.blueprint.blueprintterraformintegrations.get_terraform_configuration_sources_using_get(hub, ctx, q_projects, **kwargs)[source]#
- Returns a paginated list of configuration sources configured as storage for
Terraform configurations. Performs GET /blueprint/api/blueprint-integrations/terraform/get-configuration-sources
- Parameters:
q_projects (array) – (required in query) A comma-separated list of project IDs. Results will be filtered so only configuration sources accessible from one or more of these projects will be returned.
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /blueprint/api/about
search (string) – (optional in query) A search parameter to search based on configuration source name or repository.
- async idem_vra.exec.vra.blueprint.blueprintterraformintegrations.get_terraform_version_using_get(hub, ctx, p_versionId, **kwargs)[source]#
Returns Terraform Version details Performs GET /blueprint/api/blueprint-integrations/terraform/versions/{versionId}
- Parameters:
p_versionId (string) – (required in path) versionId
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /blueprint/api/about
- async idem_vra.exec.vra.blueprint.blueprintterraformintegrations.list_terraform_versions_using_get(hub, ctx, **kwargs)[source]#
Lists terraform versions Performs GET /blueprint/api/blueprint-integrations/terraform/versions
- Parameters:
orderby (array) – (optional in query) Sorting criteria in the format: property (asc|desc). Default sort order is descending on updatedAt. Sorting is supported on fields createdAt, updatedAt, createdBy, updatedBy, version.
skip (integer) – (optional in query) Number of records you want to skip
top (integer) – (optional in query) Number of records you want
onlyEnabled (boolean) – (optional in query) Include only enabled versions
- async idem_vra.exec.vra.blueprint.blueprintterraformintegrations.update_terraform_version_using_patch(hub, ctx, p_versionId, **kwargs)[source]#
Updates a terraform version Performs PATCH /blueprint/api/blueprint-integrations/terraform/versions/{versionId}
- Parameters:
p_versionId (string) – (required in path) versionId
apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /blueprint/api/about
authenticationType (string) – (optional in body) The type of authentication for the download url
createdAt (string) – (optional in body) Created time
createdBy (string) – (optional in body) Created by
description (string) – (optional in body) Version description
enabled (boolean) – (optional in body) Version status
id (string) – (optional in body) Version ID
orgId (string) – (optional in body) Org ID
password (string) – (optional in body) The password for basic authentication
sha256Checksum (string) – (optional in body) The sha256 checksum of the terraform binary
updatedAt (string) – (optional in body) Updated time
updatedBy (string) – (optional in body) Updated by
url (string) – (optional in body) Download url
username (string) – (optional in body) The user name for basic authentication
version (string) – (optional in body) The numeric version of terraform release