EnvironmentDefinitions interface

Package:

@azure/arm-devcenter

Interface representing a EnvironmentDefinitions.

Methods

get(string, string, string, string, EnvironmentDefinitionsGetOptionalParams)	Gets an environment definition from the catalog.
getByProjectCatalog(string, string, string, string, EnvironmentDefinitionsGetByProjectCatalogOptionalParams)	Gets an environment definition from the catalog.
getErrorDetails(string, string, string, string, EnvironmentDefinitionsGetErrorDetailsOptionalParams)	Gets Environment Definition error details
listByCatalog(string, string, string, EnvironmentDefinitionsListByCatalogOptionalParams)	List environment definitions in the catalog.
listByProjectCatalog(string, string, string, EnvironmentDefinitionsListByProjectCatalogOptionalParams)	Lists the environment definitions in this project catalog.

Method Details

get(string, string, string, string, EnvironmentDefinitionsGetOptionalParams)

Gets an environment definition from the catalog.

function get(resourceGroupName: string, devCenterName: string, catalogName: string, environmentDefinitionName: string, options?: EnvironmentDefinitionsGetOptionalParams): Promise<EnvironmentDefinition>

Parameters

resourceGroupName

string

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

devCenterName

string

The name of the devcenter.

catalogName

string

The name of the Catalog.

environmentDefinitionName

string

The name of the Environment Definition.

options

EnvironmentDefinitionsGetOptionalParams

The options parameters.

Returns

Promise<EnvironmentDefinition>

getByProjectCatalog(string, string, string, string, EnvironmentDefinitionsGetByProjectCatalogOptionalParams)

Gets an environment definition from the catalog.

function getByProjectCatalog(resourceGroupName: string, projectName: string, catalogName: string, environmentDefinitionName: string, options?: EnvironmentDefinitionsGetByProjectCatalogOptionalParams): Promise<EnvironmentDefinition>

Parameters

resourceGroupName

string

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

projectName

string

The name of the project.

catalogName

string

The name of the Catalog.

environmentDefinitionName

string

The name of the Environment Definition.

options

EnvironmentDefinitionsGetByProjectCatalogOptionalParams

The options parameters.

Returns

Promise<EnvironmentDefinition>

getErrorDetails(string, string, string, string, EnvironmentDefinitionsGetErrorDetailsOptionalParams)

Gets Environment Definition error details

function getErrorDetails(resourceGroupName: string, devCenterName: string, catalogName: string, environmentDefinitionName: string, options?: EnvironmentDefinitionsGetErrorDetailsOptionalParams): Promise<CatalogResourceValidationErrorDetails>

Parameters

resourceGroupName

string

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

devCenterName

string

The name of the devcenter.

catalogName

string

The name of the Catalog.

environmentDefinitionName

string

The name of the Environment Definition.

options

EnvironmentDefinitionsGetErrorDetailsOptionalParams

The options parameters.

Returns

Promise<CatalogResourceValidationErrorDetails>

listByCatalog(string, string, string, EnvironmentDefinitionsListByCatalogOptionalParams)

List environment definitions in the catalog.

function listByCatalog(resourceGroupName: string, devCenterName: string, catalogName: string, options?: EnvironmentDefinitionsListByCatalogOptionalParams): PagedAsyncIterableIterator<EnvironmentDefinition, EnvironmentDefinition[], PageSettings>

Parameters

resourceGroupName

string

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

devCenterName

string

The name of the devcenter.

catalogName

string

The name of the Catalog.

options

EnvironmentDefinitionsListByCatalogOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<EnvironmentDefinition, EnvironmentDefinition[], PageSettings>

listByProjectCatalog(string, string, string, EnvironmentDefinitionsListByProjectCatalogOptionalParams)

Lists the environment definitions in this project catalog.

function listByProjectCatalog(resourceGroupName: string, projectName: string, catalogName: string, options?: EnvironmentDefinitionsListByProjectCatalogOptionalParams): PagedAsyncIterableIterator<EnvironmentDefinition, EnvironmentDefinition[], PageSettings>

Parameters

resourceGroupName

string

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

projectName

string

The name of the project.

catalogName

string

The name of the Catalog.

options

EnvironmentDefinitionsListByProjectCatalogOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<EnvironmentDefinition, EnvironmentDefinition[], PageSettings>