Share via

Environments - Get Outputs

  • Reference
Service:
Dev Center
API Version:
2024-02-01

Gets Outputs from the environment.

GET {endpoint}/projects/{projectName}/users/{userId}/environments/{environmentName}/outputs?api-version=2024-02-01

URI Parameters

Name In Required Type Description
endpoint
 path True

string

uri

The DevCenter-specific URI to operate on.
environmentName
 path True

string

The name of the environment.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$
projectName
 path True

string

The DevCenter Project upon which to execute operations.

Regex pattern: ^[a-zA-Z0-9][a-zA-Z0-9-_.]{2,62}$
userId
 path True

string

The AAD object id of the user. If value is 'me', the identity is taken from the authentication context.

Regex pattern: ^[a-zA-Z0-9]{8}-([a-zA-Z0-9]{4}-){3}[a-zA-Z0-9]{12}$|^me$
api-version
 query True

string

The API version to use for this operation.

Responses

Name Type Description
200 OK

EnvironmentOutputs

The request has succeeded.
Other Status Codes

Azure.Core.Foundations.ErrorResponse

An unexpected error response.

Headers

x-ms-error-code: string

Security

OAuth2Auth

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
https://devcenter.azure.com/.default

Examples

Gets Outputs from the environment.

Sample request

GET https://8a40af38-3b4c-4672-a6a4-5e964b1870ed-contosodevcenter.centralus.devcenter.azure.com/projects/myProject/users/me/environments/mydevenv/outputs?api-version=2024-02-01

Sample response

Status code:
200 
{
  "outputs": {
    "stringOutput": {
      "type": "string",
      "value": "Output1 value",
      "sensitive": false
    },
    "arrayOutput": {
      "type": "array",
      "value": [
        1,
        2,
        3
      ],
      "sensitive": false
    },
    "boolOutput": {
      "type": "bool",
      "value": true,
      "sensitive": false
    },
    "intOutput": {
      "type": "int",
      "value": 1,
      "sensitive": false
    },
    "objectOutput": {
      "type": "object",
      "value": {
        "name": "name",
        "id": "id"
      },
      "sensitive": false
    }
  }
}

Definitions

Name Description
Azure.Core.Foundations.Error

The error object.
Azure.Core.Foundations.ErrorResponse

A response containing error details.
Azure.Core.Foundations.InnerError

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.
EnvironmentOutput

Output from environment deployment.
EnvironmentOutputs

Outputs from environment deployment.
EnvironmentOutputType

Type of the output value.

Azure.Core.Foundations.Error

The error object.

Name Type Description
code

string

One of a server-defined set of error codes.
details

Azure.Core.Foundations.Error[]

An array of details about specific errors that led to this reported error.
innererror

Azure.Core.Foundations.InnerError

An object containing more specific information than the current object about the error.
message

string

A human-readable representation of the error.
target

string

The target of the error.

Azure.Core.Foundations.ErrorResponse

A response containing error details.

Name Type Description
error

Azure.Core.Foundations.Error

The error object.

Azure.Core.Foundations.InnerError

An object containing more specific information about the error. As per Microsoft One API guidelines - https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses.

Name Type Description
code

string

One of a server-defined set of error codes.
innererror

Azure.Core.Foundations.InnerError

Inner error.

EnvironmentOutput

Output from environment deployment.

Name Type Description
sensitive

boolean

Indicates if the value is sensitive.
type

EnvironmentOutputType

Type of the output value.
value

The output value.

EnvironmentOutputs

Outputs from environment deployment.

Name Type Description
outputs

<string,  EnvironmentOutput>

The outputs Names and Values.

EnvironmentOutputType

Type of the output value.

Name Type Description
array

string

The output is an array of values.
boolean

string

The output is a boolean value.
number

string

The output is a number value.
object

string

The output is an object value.
string

string

The output is a string value.