Projects interface

Package:

@azure/arm-devcenter

Interface representing a Projects.

Methods

beginCreateOrUpdate(string, string, Project, ProjectsCreateOrUpdateOptionalParams)	Creates or updates a project.
beginCreateOrUpdateAndWait(string, string, Project, ProjectsCreateOrUpdateOptionalParams)	Creates or updates a project.
beginDelete(string, string, ProjectsDeleteOptionalParams)	Deletes a project resource.
beginDeleteAndWait(string, string, ProjectsDeleteOptionalParams)	Deletes a project resource.
beginUpdate(string, string, ProjectUpdate, ProjectsUpdateOptionalParams)	Partially updates a project.
beginUpdateAndWait(string, string, ProjectUpdate, ProjectsUpdateOptionalParams)	Partially updates a project.
get(string, string, ProjectsGetOptionalParams)	Gets a specific project.
listByResourceGroup(string, ProjectsListByResourceGroupOptionalParams)	Lists all projects in the resource group.
listBySubscription(ProjectsListBySubscriptionOptionalParams)	Lists all projects in the subscription.

Method Details

beginCreateOrUpdate(string, string, Project, ProjectsCreateOrUpdateOptionalParams)

Creates or updates a project.

function beginCreateOrUpdate(resourceGroupName: string, projectName: string, body: Project, options?: ProjectsCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Project>, Project>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

projectName

string

The name of the project.

body

Project

Represents a project.

options

ProjectsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Project>, Project>>

beginCreateOrUpdateAndWait(string, string, Project, ProjectsCreateOrUpdateOptionalParams)

Creates or updates a project.

function beginCreateOrUpdateAndWait(resourceGroupName: string, projectName: string, body: Project, options?: ProjectsCreateOrUpdateOptionalParams): Promise<Project>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

projectName

string

The name of the project.

body

Project

Represents a project.

options

ProjectsCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<Project>

beginDelete(string, string, ProjectsDeleteOptionalParams)

Deletes a project resource.

function beginDelete(resourceGroupName: string, projectName: string, options?: ProjectsDeleteOptionalParams): Promise<SimplePollerLike<OperationState<ProjectsDeleteHeaders>, ProjectsDeleteHeaders>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

projectName

string

The name of the project.

options

ProjectsDeleteOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ProjectsDeleteHeaders>, ProjectsDeleteHeaders>>

beginDeleteAndWait(string, string, ProjectsDeleteOptionalParams)

Deletes a project resource.

function beginDeleteAndWait(resourceGroupName: string, projectName: string, options?: ProjectsDeleteOptionalParams): Promise<ProjectsDeleteHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

projectName

string

The name of the project.

options

ProjectsDeleteOptionalParams

The options parameters.

Returns

Promise<ProjectsDeleteHeaders>

beginUpdate(string, string, ProjectUpdate, ProjectsUpdateOptionalParams)

Partially updates a project.

function beginUpdate(resourceGroupName: string, projectName: string, body: ProjectUpdate, options?: ProjectsUpdateOptionalParams): Promise<SimplePollerLike<OperationState<Project>, Project>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

projectName

string

The name of the project.

body

ProjectUpdate

Updatable project properties.

options

ProjectsUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<Project>, Project>>

beginUpdateAndWait(string, string, ProjectUpdate, ProjectsUpdateOptionalParams)

Partially updates a project.

function beginUpdateAndWait(resourceGroupName: string, projectName: string, body: ProjectUpdate, options?: ProjectsUpdateOptionalParams): Promise<Project>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

projectName

string

The name of the project.

body

ProjectUpdate

Updatable project properties.

options

ProjectsUpdateOptionalParams

The options parameters.

Returns

Promise<Project>

get(string, string, ProjectsGetOptionalParams)

Gets a specific project.

function get(resourceGroupName: string, projectName: string, options?: ProjectsGetOptionalParams): Promise<Project>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

projectName

string

The name of the project.

options

ProjectsGetOptionalParams

The options parameters.

Returns

Promise<Project>

listByResourceGroup(string, ProjectsListByResourceGroupOptionalParams)

Lists all projects in the resource group.

function listByResourceGroup(resourceGroupName: string, options?: ProjectsListByResourceGroupOptionalParams): PagedAsyncIterableIterator<Project, Project[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

options

ProjectsListByResourceGroupOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Project, Project[], PageSettings>

listBySubscription(ProjectsListBySubscriptionOptionalParams)

Lists all projects in the subscription.

function listBySubscription(options?: ProjectsListBySubscriptionOptionalParams): PagedAsyncIterableIterator<Project, Project[], PageSettings>

Parameters

options

ProjectsListBySubscriptionOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<Project, Project[], PageSettings>