resources#

async idem_vra.exec.vra.catalog.resources.create_resource_using_post2(hub, ctx, name, type, **kwargs)[source]#

Create a new resource. Returns the resource request response. Performs POST /deployment/api/resources

Parameters:

  • name (string) – (required in body) Name of the resource

  • type (string) – (required in body) Type of the resource

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). If you do not specify explicitly an exact version, you will be calling the latest supported API version.

  • deploymentId (string) – (optional in body) Resource deployment id

  • projectId (string) – (optional in body) Resource project id

  • properties (object) – (optional in body) Resource properties

async idem_vra.exec.vra.catalog.resources.get_resource_by_id_using_get5(hub, ctx, p_resourceId, **kwargs)[source]#

Fetch a specific resource. Returns the resource with the supplied ID. Performs GET /deployment/api/resources/{resourceId}

Parameters:

  • p_resourceId (string) – (required in path) Resource ID

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). If you do not specify explicitly an exact version, you will be calling the latest supported API version.

  • expand (array) – (optional in query) The expanded details of the requested comma separated objects. Ex. project, deployment, currentRequest

async idem_vra.exec.vra.catalog.resources.get_resource_filter_by_id_using_get2(hub, ctx, p_filterId, **kwargs)[source]#

Returns the Resource filter with the supplied ID. Performs GET /deployment/api/resources/filters/{filterId}

Parameters:

  • p_filterId (string) – (required in path) Filter Id

  • orderby (array) – (optional in query) Sorting criteria in the format: property (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

  • skip (integer) – (optional in query) Number of records you want to skip

  • top (integer) – (optional in query) Number of records you want

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). If you do not specify explicitly an exact version, you will be calling the latest supported API version.

  • projects (array) – (optional in query) A comma-separated list. Results must be associated with one of these project IDs.

  • resourceTypes (array) – (optional in query) A comma-separated list. Only Resources with these types will be included in the results.

  • search (string) – (optional in query) Search string for filters

async idem_vra.exec.vra.catalog.resources.get_resource_filters_using_get2(hub, ctx, **kwargs)[source]#

Returns the Resource filters in context of given user. Performs GET /deployment/api/resources/filters

Parameters:

  • ISO3Country (string) – (optional in query)

  • ISO3Language (string) – (optional in query)

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). If you do not specify explicitly an exact version, you will be calling the latest supported API version.

  • country (string) – (optional in query)

  • displayCountry (string) – (optional in query)

  • displayLanguage (string) – (optional in query)

  • displayName (string) – (optional in query)

  • displayScript (string) – (optional in query)

  • displayVariant (string) – (optional in query)

  • language (string) – (optional in query)

  • resourceTypes (array) – (optional in query) A comma-separated list. Only Resources with these types will be included in the results.

  • script (string) – (optional in query)

  • unicodeLocaleAttributes (array) – (optional in query)

  • unicodeLocaleKeys (array) – (optional in query)

  • variant (string) – (optional in query)

async idem_vra.exec.vra.catalog.resources.get_resources_using_get2(hub, ctx, **kwargs)[source]#

Fetch all resources. Returns a paginated list of resources. Performs GET /deployment/api/resources

Parameters:

  • orderby (array) – (optional in query) Sorting criteria in the format: property (asc|desc). Default sort order is ascending. Multiple sort criteria are supported.

  • skip (integer) – (optional in query) Number of records you want to skip

  • top (integer) – (optional in query) Number of records you want

  • apiVersion (string) – (optional in query) The version of the API in yyyy-MM-dd format (UTC). If you do not specify explicitly an exact version, you will be calling the latest supported API version.

  • cloudAccounts (array) – (optional in query) A comma-separated list. Results must be associated with one of these cloud accounts.

  • cloudTypes (array) – (optional in query) A comma-separated list. Results must be associated with one of these cloud Types

  • expand (array) – (optional in query) The expanded details of the requested comma separated objects. Ex. project, deployment, currentRequest

  • projects (array) – (optional in query) A comma-separated list. Results must be associated with one of these project IDs.

  • resourceTypes (array) – (optional in query) A comma-separated list. Results must be associated with one of these resourceType Names.

  • search (string) – (optional in query) Given string should be part of a searchable field in one of the resources.

  • tags (array) – (optional in query) A comma-separated list. Results must be associated with one of these tags