Skip to main content

resource_pools

Creates, updates, deletes, gets or lists a resource_pools resource.

Overview​

Nameresource_pools
TypeResource
Idazure_isv.connectedvmware.resource_pools

Fields​

The following fields are returned by SELECT queries:

NameDatatypeDescription
idstringGets or sets the Id.
namestringGets or sets the name.
cpuCapacityMHzintegerGets the max CPU usage across all cores on the pool in MHz.
cpuLimitMHzintegerGets or sets CPULimitMHz which specifies a CPU usage limit in MHz. Utilization will not exceed this limit even if there are available resources.
cpuOverallUsageMHzintegerGets the used CPU usage across all cores on the pool in MHz.
cpuReservationMHzintegerGets or sets CPUReservationMHz which specifies the CPU size in MHz that is guaranteed to be available.
cpuSharesLevelstringGets or sets CPUSharesLevel which specifies the CPU allocation level for this pool. This property is used in relative allocation between resource consumers.
customResourceNamestringGets the name of the corresponding resource in Kubernetes.
datastoreIdsarrayGets the datastore ARM ids.
extendedLocationobjectGets or sets the extended location.
inventoryItemIdstringGets or sets the inventory Item ID for the resource pool.
kindstringMetadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value.
locationstringGets or sets the location. Required.
memCapacityGBintegerGets the total amount of physical memory on the pool in GB.
memLimitMBintegerGets or sets MemLimitMB specifies a memory usage limit in megabytes. Utilization will not exceed the specified limit even if there are available resources.
memOverallUsageGBintegerGets the used physical memory on the pool in GB.
memReservationMBintegerGets or sets MemReservationMB which specifies the guaranteed available memory in megabytes.
memSharesLevelstringGets or sets CPUSharesLevel which specifies the memory allocation level for this pool. This property is used in relative allocation between resource consumers.
moNamestringGets or sets the vCenter Managed Object name for the resource pool.
moRefIdstringGets or sets the vCenter MoRef (Managed Object Reference) ID for the resource pool.
networkIdsarrayGets the network ARM ids.
provisioningStatestringGets the provisioning state. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", and "Created".
statusesarrayThe resource status information.
systemDataobjectThe system data.
tagsobjectGets or sets the Resource tags.
typestringGets or sets the type of the resource.
uuidstringGets or sets a unique identifier for this resource.
vCenterIdstringGets or sets the ARM Id of the vCenter resource in which this resource pool resides.

Methods​

The following methods are available for this resource:

NameAccessible byRequired ParamsOptional ParamsDescription
getselectresource_group_name, resource_pool_name, subscription_idGets a resourcePool. Implements resourcePool GET method.
list_by_resource_groupselectresource_group_name, subscription_idImplements GET resourcePools in a resource group. List of resourcePools in a resource group.
listselectsubscription_idImplements GET resourcePools in a subscription. List of resourcePools in a subscription.
createinsertresource_group_name, resource_pool_name, subscription_id, locationImplements resourcePool PUT method. Create Or Update resourcePool.
updateupdateresource_group_name, resource_pool_name, subscription_idUpdates a resourcePool. API to update certain properties of the resourcePool resource.
deletedeleteresource_group_name, resource_pool_name, subscription_idforceDeletes an resourcePool. Implements resourcePool DELETE method.

Parameters​

Parameters can be passed in the WHERE clause of a query. Check the Methods section to see which parameters are required or optional for each operation.

NameDatatypeDescription
resource_group_namestringThe Resource Group Name. Required.
resource_pool_namestringName of the resourcePool. Required.
subscription_idstring
forcebooleanWhether force delete was specified. Default value is None.

SELECT examples​

Gets a resourcePool. Implements resourcePool GET method.

SELECT
id,
name,
cpuCapacityMHz,
cpuLimitMHz,
cpuOverallUsageMHz,
cpuReservationMHz,
cpuSharesLevel,
customResourceName,
datastoreIds,
extendedLocation,
inventoryItemId,
kind,
location,
memCapacityGB,
memLimitMB,
memOverallUsageGB,
memReservationMB,
memSharesLevel,
moName,
moRefId,
networkIds,
provisioningState,
statuses,
systemData,
tags,
type,
uuid,
vCenterId
FROM azure_isv.connectedvmware.resource_pools
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND resource_pool_name = '{{ resource_pool_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples​

Implements resourcePool PUT method. Create Or Update resourcePool.

INSERT INTO azure_isv.connectedvmware.resource_pools (
location,
extendedLocation,
tags,
kind,
properties,
resource_group_name,
resource_pool_name,
subscription_id
)
SELECT 
'{{ location }}' /* required */,
'{{ extendedLocation }}',
'{{ tags }}',
'{{ kind }}',
'{{ properties }}',
'{{ resource_group_name }}',
'{{ resource_pool_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
extendedLocation,
kind,
location,
properties,
systemData,
tags,
type
;

UPDATE examples​

Updates a resourcePool. API to update certain properties of the resourcePool resource.

UPDATE azure_isv.connectedvmware.resource_pools
SET 
tags = '{{ tags }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND resource_pool_name = '{{ resource_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
extendedLocation,
kind,
location,
properties,
systemData,
tags,
type;

DELETE examples​

Deletes an resourcePool. Implements resourcePool DELETE method.

DELETE FROM azure_isv.connectedvmware.resource_pools
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND resource_pool_name = '{{ resource_pool_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
AND force = '{{ force }}'
;