datastores

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

Overview

Name	datastores
Type	Resource
Id	azure_isv.connectedvmware.datastores

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Gets or sets the Id.
name	string	Gets or sets the name.
capacityGB	integer	Gets or sets Maximum capacity of this datastore in GBs.
customResourceName	string	Gets the name of the corresponding resource in Kubernetes.
extendedLocation	object	Gets or sets the extended location.
freeSpaceGB	integer	Gets or sets Available space of this datastore in GBs.
inventoryItemId	string	Gets or sets the inventory Item ID for the datastore.
kind	string	Metadata 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.
location	string	Gets or sets the location. Required.
moName	string	Gets or sets the vCenter Managed Object name for the datastore.
moRefId	string	Gets or sets the vCenter MoRef (Managed Object Reference) ID for the datastore.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", and "Created".
statuses	array	The resource status information.
systemData	object	The system data.
tags	object	Gets or sets the Resource tags.
type	string	Gets or sets the type of the resource.
uuid	string	Gets or sets a unique identifier for this resource.
vCenterId	string	Gets or sets the ARM Id of the vCenter resource in which this datastore resides.

list_by_resource_group

Name	Datatype	Description
id	string	Gets or sets the Id.
name	string	Gets or sets the name.
capacityGB	integer	Gets or sets Maximum capacity of this datastore in GBs.
customResourceName	string	Gets the name of the corresponding resource in Kubernetes.
extendedLocation	object	Gets or sets the extended location.
freeSpaceGB	integer	Gets or sets Available space of this datastore in GBs.
inventoryItemId	string	Gets or sets the inventory Item ID for the datastore.
kind	string	Metadata 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.
location	string	Gets or sets the location. Required.
moName	string	Gets or sets the vCenter Managed Object name for the datastore.
moRefId	string	Gets or sets the vCenter MoRef (Managed Object Reference) ID for the datastore.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", and "Created".
statuses	array	The resource status information.
systemData	object	The system data.
tags	object	Gets or sets the Resource tags.
type	string	Gets or sets the type of the resource.
uuid	string	Gets or sets a unique identifier for this resource.
vCenterId	string	Gets or sets the ARM Id of the vCenter resource in which this datastore resides.

list

Name	Datatype	Description
id	string	Gets or sets the Id.
name	string	Gets or sets the name.
capacityGB	integer	Gets or sets Maximum capacity of this datastore in GBs.
customResourceName	string	Gets the name of the corresponding resource in Kubernetes.
extendedLocation	object	Gets or sets the extended location.
freeSpaceGB	integer	Gets or sets Available space of this datastore in GBs.
inventoryItemId	string	Gets or sets the inventory Item ID for the datastore.
kind	string	Metadata 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.
location	string	Gets or sets the location. Required.
moName	string	Gets or sets the vCenter Managed Object name for the datastore.
moRefId	string	Gets or sets the vCenter MoRef (Managed Object Reference) ID for the datastore.
provisioningState	string	Provisioning state of the resource. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", "Accepted", and "Created".
statuses	array	The resource status information.
systemData	object	The system data.
tags	object	Gets or sets the Resource tags.
type	string	Gets or sets the type of the resource.
uuid	string	Gets or sets a unique identifier for this resource.
vCenterId	string	Gets or sets the ARM Id of the vCenter resource in which this datastore resides.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, datastore_name, subscription_id		Gets a datastore. Implements datastore GET method.
list_by_resource_group	select	resource_group_name, subscription_id		Implements GET datastores in a resource group. List of datastores in a resource group.
list	select	subscription_id		Implements GET datastores in a subscription. List of datastores in a subscription.
create	insert	resource_group_name, datastore_name, subscription_id, location		Implements datastore PUT method. Create Or Update datastore.
update	update	resource_group_name, datastore_name, subscription_id		Updates a datastore. API to update certain properties of the datastore resource.
delete	delete	resource_group_name, datastore_name, subscription_id	force	Deletes an datastore. Implements datastore 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.

Name	Datatype	Description
datastore_name	string	Name of the datastore. Required.
resource_group_name	string	The Resource Group Name. Required.
subscription_id	string
force	boolean	Whether force delete was specified. Default value is None.

SELECT examples

get

Gets a datastore. Implements datastore GET method.

SELECT
id,
name,
capacityGB,
customResourceName,
extendedLocation,
freeSpaceGB,
inventoryItemId,
kind,
location,
moName,
moRefId,
provisioningState,
statuses,
systemData,
tags,
type,
uuid,
vCenterId
FROM azure_isv.connectedvmware.datastores
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND datastore_name = '{{ datastore_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

Implements GET datastores in a resource group. List of datastores in a resource group.

SELECT
id,
name,
capacityGB,
customResourceName,
extendedLocation,
freeSpaceGB,
inventoryItemId,
kind,
location,
moName,
moRefId,
provisioningState,
statuses,
systemData,
tags,
type,
uuid,
vCenterId
FROM azure_isv.connectedvmware.datastores
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list

Implements GET datastores in a subscription. List of datastores in a subscription.

SELECT
id,
name,
capacityGB,
customResourceName,
extendedLocation,
freeSpaceGB,
inventoryItemId,
kind,
location,
moName,
moRefId,
provisioningState,
statuses,
systemData,
tags,
type,
uuid,
vCenterId
FROM azure_isv.connectedvmware.datastores
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Implements datastore PUT method. Create Or Update datastore.

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

Manifest

# Description fields are for documentation purposes
- name: datastores
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the datastores resource.
  - name: datastore_name
    value: "{{ datastore_name }}"
    description: Required parameter for the datastores resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the datastores resource.
  - name: location
    value: "{{ location }}"
    description: |
      Gets or sets the location. Required.
  - name: extendedLocation
    description: |
      Gets or sets the extended location.
    value:
      type: "{{ type }}"
      name: "{{ name }}"
  - name: tags
    value: "{{ tags }}"
    description: |
      Gets or sets the Resource tags.
  - name: kind
    value: "{{ kind }}"
    description: |
      Metadata 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.
  - name: properties
    value:
      vCenterId: "{{ vCenterId }}"
      moRefId: "{{ moRefId }}"
      inventoryItemId: "{{ inventoryItemId }}"

UPDATE examples

update

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

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

DELETE examples

delete

Deletes an datastore. Implements datastore DELETE method.

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