vmware_collectors_operations

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

Overview

Name	vmware_collectors_operations
Type	Resource
Id	azure.migration_assessment.vmware_collectors_operations

Fields

The following fields are returned by SELECT queries:

get

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
agentProperties	object	Gets or sets the collector agent properties.
createdTimestamp	string (date-time)	Gets the Timestamp when collector was created.
discoverySiteId	string	Gets the discovery site id.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updatedTimestamp	string (date-time)	Timestamp when collector was last updated.

list_by_assessment_project

Name	Datatype	Description
id	string	Fully qualified resource ID for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}. # pylint: disable=line-too-long
name	string	The name of the resource.
agentProperties	object	Gets or sets the collector agent properties.
createdTimestamp	string (date-time)	Gets the Timestamp when collector was created.
discoverySiteId	string	Gets the discovery site id.
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updatedTimestamp	string (date-time)	Timestamp when collector was last updated.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, project_name, vm_ware_collector_name, subscription_id		Get a VmwareCollector.
list_by_assessment_project	select	resource_group_name, project_name, subscription_id		List VmwareCollector resources by AssessmentProject.
create	insert	resource_group_name, project_name, vm_ware_collector_name, subscription_id		Create a VmwareCollector.
delete	delete	resource_group_name, project_name, vm_ware_collector_name, subscription_id		Delete a VmwareCollector.

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
project_name	string	Assessment Project Name. Required.
resource_group_name	string	The name of the resource group. The name is case insensitive. Required.
subscription_id	string
vm_ware_collector_name	string	VMware collector ARM name. Required.

SELECT examples

get

Get a VmwareCollector.

SELECT
id,
name,
agentProperties,
createdTimestamp,
discoverySiteId,
provisioningState,
systemData,
type,
updatedTimestamp
FROM azure.migration_assessment.vmware_collectors_operations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND vm_ware_collector_name = '{{ vm_ware_collector_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_assessment_project

List VmwareCollector resources by AssessmentProject.

SELECT
id,
name,
agentProperties,
createdTimestamp,
discoverySiteId,
provisioningState,
systemData,
type,
updatedTimestamp
FROM azure.migration_assessment.vmware_collectors_operations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a VmwareCollector.

INSERT INTO azure.migration_assessment.vmware_collectors_operations (
properties,
resource_group_name,
project_name,
vm_ware_collector_name,
subscription_id
)
SELECT 
'{{ properties }}',
'{{ resource_group_name }}',
'{{ project_name }}',
'{{ vm_ware_collector_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
properties,
systemData,
type
;

Manifest

# Description fields are for documentation purposes
- name: vmware_collectors_operations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the vmware_collectors_operations resource.
  - name: project_name
    value: "{{ project_name }}"
    description: Required parameter for the vmware_collectors_operations resource.
  - name: vm_ware_collector_name
    value: "{{ vm_ware_collector_name }}"
    description: Required parameter for the vmware_collectors_operations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the vmware_collectors_operations resource.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      agentProperties:
        id: "{{ id }}"
        version: "{{ version }}"
        lastHeartbeatUtc: "{{ lastHeartbeatUtc }}"
        spnDetails:
          authority: "{{ authority }}"
          applicationId: "{{ applicationId }}"
          audience: "{{ audience }}"
          objectId: "{{ objectId }}"
          tenantId: "{{ tenantId }}"
      discoverySiteId: "{{ discoverySiteId }}"
      createdTimestamp: "{{ createdTimestamp }}"
      updatedTimestamp: "{{ updatedTimestamp }}"

DELETE examples

delete

Delete a VmwareCollector.

DELETE FROM azure.migration_assessment.vmware_collectors_operations
WHERE resource_group_name = '{{ resource_group_name }}' --required
AND project_name = '{{ project_name }}' --required
AND vm_ware_collector_name = '{{ vm_ware_collector_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
;