Share via

EnvironmentOutput interface

Package:
@azure-rest/developer-devcenter

Properties of an environment.

Properties

catalogName

Name of the catalog.
environmentDefinitionName

Name of the environment definition.
environmentType

Environment type.
error

Provisioning error details. Populated only for error states.
name

Environment name.
parameters

Parameters object for the environment.
provisioningState

The provisioning state of the environment.

Possible values: "Succeeded", "Failed", "Canceled", "Creating", "Accepted", "Deleting", "Updating", "Preparing", "Running", "Syncing", "MovingResources", "TransientFailure", "StorageProvisioningFailed"
resourceGroupId

The identifier of the resource group containing the environment's resources.
user

The AAD object id of the owner of this Environment.

Property Details

catalogName

Name of the catalog.

catalogName: string

Property Value

string

environmentDefinitionName

Name of the environment definition.

environmentDefinitionName: string

Property Value

string

environmentType

Environment type.

environmentType: string

Property Value

string

error

Provisioning error details. Populated only for error states.

error?: ErrorModel

Property Value

ErrorModel

name

Environment name.

name: string

Property Value

string

parameters

Parameters object for the environment.

parameters?: Record<string, any>

Property Value

Record<string, any>

provisioningState

The provisioning state of the environment.

Possible values: "Succeeded", "Failed", "Canceled", "Creating", "Accepted", "Deleting", "Updating", "Preparing", "Running", "Syncing", "MovingResources", "TransientFailure", "StorageProvisioningFailed"

provisioningState?: string

Property Value

string

resourceGroupId

The identifier of the resource group containing the environment's resources.

resourceGroupId?: string

Property Value

string

user

The AAD object id of the owner of this Environment.

user?: string

Property Value

string