variables

async idem_vra.exec.vra.pipeline.variables.create_variable_using_post(hub, ctx, name, type, value, **kwargs)

Create a Variable Creates a Variable based on project name Performs POST /codestream/api/variables

Parameters:

• name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option

• type (string) – (required in body) The type of this Variable. Ex: REGULAR / SECRET / RESTRICTED

• value (string) – (required in body) The value for this Variable.

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

• description (string) – (optional in body) A human-friendly description.

• isMultiLine (boolean) – (optional in body) Check box that indicates if the value of the Variable should be saved in a multi line format.

• project (string) – (optional in body) The project this entity belongs to.

async idem_vra.exec.vra.pipeline.variables.delete_variable_by_id_using_delete(hub, ctx, p_id, **kwargs)

Deletes a Variable by Id Deletes a Variable with the given Id Performs DELETE /codestream/api/variables/{id}

Parameters:

• p_id (string) – (required in path) The ID of the Variable

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

async idem_vra.exec.vra.pipeline.variables.delete_variable_by_name_using_delete(hub, ctx, p_name, p_project, **kwargs)

Deletes a Variable by project and name Deletes a Variable with the given name Performs DELETE /codestream/api/variables/{project}/{name}

Parameters:

• p_name (string) – (required in path) The name of the Variable

• p_project (string) – (required in path) The project the Variable belongs to

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

async idem_vra.exec.vra.pipeline.variables.get_all_variables_using_get(hub, ctx, **kwargs)

Get all Variables Get all Variables with specified paging and filter parameters. Performs GET /codestream/api/variables

Parameters:

• filter (string) – (optional in query) To list Variables with OData like filter

• orderby (string) – (optional in query) Order by attribute

• skip (string) – (optional in query) To skip ‘n’ Variables for listing

• top (string) – (optional in query) To list top ‘n’ Variables for listing

• page (string) – (optional in query) To select ‘n’th page for listing

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

async idem_vra.exec.vra.pipeline.variables.get_variable_by_id_using_get(hub, ctx, p_id, **kwargs)

Gets a Variable Gets a Variable with the given id Performs GET /codestream/api/variables/{id}

Parameters:

• p_id (string) – (required in path) The ID of the Variable

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

async idem_vra.exec.vra.pipeline.variables.get_variable_by_name_using_get(hub, ctx, p_name, p_project, **kwargs)

Gets a Variable by project and name Get an Variable with the given project and name Performs GET /codestream/api/variables/{project}/{name}

Parameters:

• p_name (string) – (required in path) The name of the Variable

• p_project (string) – (required in path) The project the Variable belongs to

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

async idem_vra.exec.vra.pipeline.variables.update_variable_by_id_using_put(hub, ctx, p_id, name, type, value, **kwargs)

Update a Variable by id Updates a Variable with the given id Performs PUT /codestream/api/variables/{id}

Parameters:

• p_id (string) – (required in path) The ID of the Variable

• name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option

• type (string) – (required in body) The type of this Variable. Ex: REGULAR / SECRET / RESTRICTED

• value (string) – (required in body) The value for this Variable.

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

• description (string) – (optional in body) A human-friendly description.

• isMultiLine (boolean) – (optional in body) Check box that indicates if the value of the Variable should be saved in a multi line format.

• project (string) – (optional in body) The project this entity belongs to.

async idem_vra.exec.vra.pipeline.variables.update_variable_by_name_using_put(hub, ctx, p_name, p_project, name, type, value, **kwargs)

Updates a Variable by project and name Update an Variable with the given project and name Performs PUT /codestream/api/variables/{project}/{name}

Parameters:

• p_name (string) – (required in path) The name of the Variable

• p_project (string) – (required in path) The project the Variable belongs to

• name (string) – (required in body) A human-friendly name used as an identifier in APIs that support this option

• type (string) – (required in body) The type of this Variable. Ex: REGULAR / SECRET / RESTRICTED

• value (string) – (required in body) The value for this Variable.

• apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). For versioning information please refer to /codestream/api/about

• Authorization (string) – (optional in header) Bearer token

• description (string) – (optional in body) A human-friendly description.

• isMultiLine (boolean) – (optional in body) Check box that indicates if the value of the Variable should be saved in a multi line format.

• project (string) – (optional in body) The project this entity belongs to.