assessment_projects_operations

Creates, updates, deletes, gets or lists an assessment_projects_operations resource.

Overview

Name	assessment_projects_operations
Type	Resource
Id	azure.migration_assessment.assessment_projects_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.
assessmentSolutionId	string	Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects.
createdTimestamp	string (date-time)	Time when this project was created. Date-Time represented in ISO-8601 format.
customerStorageAccountArmId	string	The ARM id of the storage account used for interactions when public access is disabled.
customerWorkspaceId	string	The ARM id of service map workspace created by customer.
customerWorkspaceLocation	string	Location of service map workspace created by customer.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	The list of private endpoint connections to the project.
projectStatus	string	Assessment project status. Known values are: "Active" and "Inactive".
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".
publicNetworkAccess	string	This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method.
serviceEndpoint	string	Endpoint at which the collector agent can call agent REST API.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updatedTimestamp	string (date-time)	Time when this project was last updated. Date-Time represented in ISO-8601 format.

list_by_resource_group

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.
assessmentSolutionId	string	Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects.
createdTimestamp	string (date-time)	Time when this project was created. Date-Time represented in ISO-8601 format.
customerStorageAccountArmId	string	The ARM id of the storage account used for interactions when public access is disabled.
customerWorkspaceId	string	The ARM id of service map workspace created by customer.
customerWorkspaceLocation	string	Location of service map workspace created by customer.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	The list of private endpoint connections to the project.
projectStatus	string	Assessment project status. Known values are: "Active" and "Inactive".
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".
publicNetworkAccess	string	This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method.
serviceEndpoint	string	Endpoint at which the collector agent can call agent REST API.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updatedTimestamp	string (date-time)	Time when this project was last updated. Date-Time represented in ISO-8601 format.

list_by_subscription

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.
assessmentSolutionId	string	Assessment solution ARM id tracked by Microsoft.Migrate/migrateProjects.
createdTimestamp	string (date-time)	Time when this project was created. Date-Time represented in ISO-8601 format.
customerStorageAccountArmId	string	The ARM id of the storage account used for interactions when public access is disabled.
customerWorkspaceId	string	The ARM id of service map workspace created by customer.
customerWorkspaceLocation	string	Location of service map workspace created by customer.
location	string	The geo-location where the resource lives. Required.
privateEndpointConnections	array	The list of private endpoint connections to the project.
projectStatus	string	Assessment project status. Known values are: "Active" and "Inactive".
provisioningState	string	The status of the last operation. Known values are: "Succeeded", "Failed", "Canceled", "Provisioning", "Updating", "Deleting", and "Accepted".
publicNetworkAccess	string	This value can be set to 'enabled' to avoid breaking changes on existing customer resources and templates. If set to 'disabled', traffic over public interface is not allowed, and private endpoint connections would be the exclusive access method.
serviceEndpoint	string	Endpoint at which the collector agent can call agent REST API.
systemData	object	Azure Resource Manager metadata containing createdBy and modifiedBy information.
tags	object	Resource tags.
type	string	The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts".
updatedTimestamp	string (date-time)	Time when this project was last updated. Date-Time represented in ISO-8601 format.

Methods

The following methods are available for this resource:

Name	Accessible by	Required Params	Optional Params	Description
get	select	resource_group_name, project_name, subscription_id		Get a AssessmentProject.
list_by_resource_group	select	resource_group_name, subscription_id		List AssessmentProject resources by resource group.
list_by_subscription	select	subscription_id		List AssessmentProject resources by subscription ID.
create	insert	resource_group_name, project_name, subscription_id, location		Create a AssessmentProject.
update	update	resource_group_name, project_name, subscription_id		Update a AssessmentProject.
delete	delete	resource_group_name, project_name, subscription_id		Delete a AssessmentProject.

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

SELECT examples

get

Get a AssessmentProject.

SELECT
id,
name,
assessmentSolutionId,
createdTimestamp,
customerStorageAccountArmId,
customerWorkspaceId,
customerWorkspaceLocation,
location,
privateEndpointConnections,
projectStatus,
provisioningState,
publicNetworkAccess,
serviceEndpoint,
systemData,
tags,
type,
updatedTimestamp
FROM azure.migration_assessment.assessment_projects_operations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND project_name = '{{ project_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_resource_group

List AssessmentProject resources by resource group.

SELECT
id,
name,
assessmentSolutionId,
createdTimestamp,
customerStorageAccountArmId,
customerWorkspaceId,
customerWorkspaceLocation,
location,
privateEndpointConnections,
projectStatus,
provisioningState,
publicNetworkAccess,
serviceEndpoint,
systemData,
tags,
type,
updatedTimestamp
FROM azure.migration_assessment.assessment_projects_operations
WHERE resource_group_name = '{{ resource_group_name }}' -- required
AND subscription_id = '{{ subscription_id }}' -- required
;

list_by_subscription

List AssessmentProject resources by subscription ID.

SELECT
id,
name,
assessmentSolutionId,
createdTimestamp,
customerStorageAccountArmId,
customerWorkspaceId,
customerWorkspaceLocation,
location,
privateEndpointConnections,
projectStatus,
provisioningState,
publicNetworkAccess,
serviceEndpoint,
systemData,
tags,
type,
updatedTimestamp
FROM azure.migration_assessment.assessment_projects_operations
WHERE subscription_id = '{{ subscription_id }}' -- required
;

INSERT examples

create

Create a AssessmentProject.

INSERT INTO azure.migration_assessment.assessment_projects_operations (
tags,
location,
properties,
resource_group_name,
project_name,
subscription_id
)
SELECT 
'{{ tags }}',
'{{ location }}' /* required */,
'{{ properties }}',
'{{ resource_group_name }}',
'{{ project_name }}',
'{{ subscription_id }}'
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type
;

Manifest

# Description fields are for documentation purposes
- name: assessment_projects_operations
props:
  - name: resource_group_name
    value: "{{ resource_group_name }}"
    description: Required parameter for the assessment_projects_operations resource.
  - name: project_name
    value: "{{ project_name }}"
    description: Required parameter for the assessment_projects_operations resource.
  - name: subscription_id
    value: "{{ subscription_id }}"
    description: Required parameter for the assessment_projects_operations resource.
  - name: tags
    value: "{{ tags }}"
    description: |
      Resource tags.
  - name: location
    value: "{{ location }}"
    description: |
      The geo-location where the resource lives. Required.
  - name: properties
    description: |
      The resource-specific properties for this resource.
    value:
      provisioningState: "{{ provisioningState }}"
      createdTimestamp: "{{ createdTimestamp }}"
      updatedTimestamp: "{{ updatedTimestamp }}"
      serviceEndpoint: "{{ serviceEndpoint }}"
      assessmentSolutionId: "{{ assessmentSolutionId }}"
      projectStatus: "{{ projectStatus }}"
      customerWorkspaceId: "{{ customerWorkspaceId }}"
      customerWorkspaceLocation: "{{ customerWorkspaceLocation }}"
      publicNetworkAccess: "{{ publicNetworkAccess }}"
      privateEndpointConnections:
        - id: "{{ id }}"
          name: "{{ name }}"
          type: "{{ type }}"
          systemData:
            createdBy: "{{ createdBy }}"
            createdByType: "{{ createdByType }}"
            createdAt: "{{ createdAt }}"
            lastModifiedBy: "{{ lastModifiedBy }}"
            lastModifiedByType: "{{ lastModifiedByType }}"
            lastModifiedAt: "{{ lastModifiedAt }}"
          properties:
            groupIds:
              - "{{ groupIds }}"
            privateEndpoint:
              id: "{{ id }}"
            privateLinkServiceConnectionState:
              status: "{{ status }}"
              description: "{{ description }}"
              actionsRequired: "{{ actionsRequired }}"
            provisioningState: "{{ provisioningState }}"
      customerStorageAccountArmId: "{{ customerStorageAccountArmId }}"

UPDATE examples

update

Update a AssessmentProject.

UPDATE azure.migration_assessment.assessment_projects_operations
SET 
tags = '{{ tags }}',
properties = '{{ properties }}'
WHERE 
resource_group_name = '{{ resource_group_name }}' --required
AND project_name = '{{ project_name }}' --required
AND subscription_id = '{{ subscription_id }}' --required
RETURNING
id,
name,
location,
properties,
systemData,
tags,
type;

DELETE examples

delete

Delete a AssessmentProject.

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