Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Projects

Package version

Class representing a Projects.

Hierarchy

  • Projects

Index

Constructors

Methods

Constructors

constructor

Methods

create

  • create(resourceGroupName: string, projectName: string, options?: Models.ProjectsCreateOptionalParams): Promise<Models.ProjectsCreateResponse>
  • create(resourceGroupName: string, projectName: string, callback: msRest.ServiceCallback<Project>): void
  • create(resourceGroupName: string, projectName: string, options: ProjectsCreateOptionalParams, callback: msRest.ServiceCallback<Project>): void

  • Create a project with specified name. If a project already exists, update it.

    summary

    Create or update project.

    Parameters

    • resourceGroupName: string

      Name of the Azure Resource Group that project is part of.

    • projectName: string

      Name of the Azure Migrate project.

    • Optional options: Models.ProjectsCreateOptionalParams

    Returns Promise<Models.ProjectsCreateResponse>

    Promise<Models.ProjectsCreateResponse>

  • Parameters

    • resourceGroupName: string

      Name of the Azure Resource Group that project is part of.

    • projectName: string

      Name of the Azure Migrate project.

    • callback: msRest.ServiceCallback<Project>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      Name of the Azure Resource Group that project is part of.

    • projectName: string

      Name of the Azure Migrate project.

    • options: ProjectsCreateOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<Project>

      The callback

    Returns void

deleteMethod

  • deleteMethod(resourceGroupName: string, projectName: string, options?: msRest.RequestOptionsBase): Promise<Models.ProjectsDeleteResponse>
  • deleteMethod(resourceGroupName: string, projectName: string, callback: msRest.ServiceCallback<void>): void
  • deleteMethod(resourceGroupName: string, projectName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<void>): void

  • Delete the project. Deleting non-existent project is a no-operation.

    summary

    Delete the project

    Parameters

    • resourceGroupName: string

      Name of the Azure Resource Group that project is part of.

    • projectName: string

      Name of the Azure Migrate project.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ProjectsDeleteResponse>

    Promise<Models.ProjectsDeleteResponse>

  • Parameters

    • resourceGroupName: string

      Name of the Azure Resource Group that project is part of.

    • projectName: string

      Name of the Azure Migrate project.

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      Name of the Azure Resource Group that project is part of.

    • projectName: string

      Name of the Azure Migrate project.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<void>

      The callback

    Returns void

get

  • get(resourceGroupName: string, projectName: string, options?: msRest.RequestOptionsBase): Promise<Models.ProjectsGetResponse>
  • get(resourceGroupName: string, projectName: string, callback: msRest.ServiceCallback<Project>): void
  • get(resourceGroupName: string, projectName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<Project>): void

  • Get the project with the specified name.

    summary

    Get the specified project.

    Parameters

    • resourceGroupName: string

      Name of the Azure Resource Group that project is part of.

    • projectName: string

      Name of the Azure Migrate project.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ProjectsGetResponse>

    Promise<Models.ProjectsGetResponse>

  • Parameters

    • resourceGroupName: string

      Name of the Azure Resource Group that project is part of.

    • projectName: string

      Name of the Azure Migrate project.

    • callback: msRest.ServiceCallback<Project>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      Name of the Azure Resource Group that project is part of.

    • projectName: string

      Name of the Azure Migrate project.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<Project>

      The callback

    Returns void

getKeys

  • getKeys(resourceGroupName: string, projectName: string, options?: msRest.RequestOptionsBase): Promise<Models.ProjectsGetKeysResponse>
  • getKeys(resourceGroupName: string, projectName: string, callback: msRest.ServiceCallback<ProjectKey>): void
  • getKeys(resourceGroupName: string, projectName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ProjectKey>): void

  • Gets the Log Analytics Workspace ID and Primary Key for the specified project.

    summary

    Get shared keys for the project.

    Parameters

    • resourceGroupName: string

      Name of the Azure Resource Group that project is part of.

    • projectName: string

      Name of the Azure Migrate project.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ProjectsGetKeysResponse>

    Promise<Models.ProjectsGetKeysResponse>

  • Parameters

    • resourceGroupName: string

      Name of the Azure Resource Group that project is part of.

    • projectName: string

      Name of the Azure Migrate project.

    • callback: msRest.ServiceCallback<ProjectKey>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      Name of the Azure Resource Group that project is part of.

    • projectName: string

      Name of the Azure Migrate project.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ProjectKey>

      The callback

    Returns void

listByResourceGroup

  • listByResourceGroup(resourceGroupName: string, options?: msRest.RequestOptionsBase): Promise<Models.ProjectsListByResourceGroupResponse>
  • listByResourceGroup(resourceGroupName: string, callback: msRest.ServiceCallback<ProjectResultList>): void
  • listByResourceGroup(resourceGroupName: string, options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ProjectResultList>): void

  • Get all the projects in the resource group.

    summary

    Get all projects.

    Parameters

    • resourceGroupName: string

      Name of the Azure Resource Group that project is part of.

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ProjectsListByResourceGroupResponse>

    Promise<Models.ProjectsListByResourceGroupResponse>

  • Parameters

    • resourceGroupName: string

      Name of the Azure Resource Group that project is part of.

    • callback: msRest.ServiceCallback<ProjectResultList>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      Name of the Azure Resource Group that project is part of.

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ProjectResultList>

      The callback

    Returns void

listBySubscription

  • listBySubscription(options?: msRest.RequestOptionsBase): Promise<Models.ProjectsListBySubscriptionResponse>
  • listBySubscription(callback: msRest.ServiceCallback<ProjectResultList>): void
  • listBySubscription(options: msRest.RequestOptionsBase, callback: msRest.ServiceCallback<ProjectResultList>): void

  • Get all the projects in the subscription.

    summary

    Get all projects.

    Parameters

    • Optional options: msRest.RequestOptionsBase

    Returns Promise<Models.ProjectsListBySubscriptionResponse>

    Promise<Models.ProjectsListBySubscriptionResponse>

  • Parameters

    Returns void

  • Parameters

    • options: msRest.RequestOptionsBase

      The optional parameters

    • callback: msRest.ServiceCallback<ProjectResultList>

      The callback

    Returns void

update

  • update(resourceGroupName: string, projectName: string, options?: Models.ProjectsUpdateOptionalParams): Promise<Models.ProjectsUpdateResponse>
  • update(resourceGroupName: string, projectName: string, callback: msRest.ServiceCallback<Project>): void
  • update(resourceGroupName: string, projectName: string, options: ProjectsUpdateOptionalParams, callback: msRest.ServiceCallback<Project>): void

  • Update a project with specified name. Supports partial updates, for example only tags can be provided.

    summary

    Update project.

    Parameters

    • resourceGroupName: string

      Name of the Azure Resource Group that project is part of.

    • projectName: string

      Name of the Azure Migrate project.

    • Optional options: Models.ProjectsUpdateOptionalParams

    Returns Promise<Models.ProjectsUpdateResponse>

    Promise<Models.ProjectsUpdateResponse>

  • Parameters

    • resourceGroupName: string

      Name of the Azure Resource Group that project is part of.

    • projectName: string

      Name of the Azure Migrate project.

    • callback: msRest.ServiceCallback<Project>

      The callback

    Returns void

  • Parameters

    • resourceGroupName: string

      Name of the Azure Resource Group that project is part of.

    • projectName: string

      Name of the Azure Migrate project.

    • options: ProjectsUpdateOptionalParams

      The optional parameters

    • callback: msRest.ServiceCallback<Project>

      The callback

    Returns void

Generated using TypeDoc