Share via


Kubernetes - Get

GET https://dev.azure.com/{organization}/{project}/_apis/pipelines/environments/{environmentId}/providers/kubernetes/{resourceId}?api-version=7.2-preview.2

URI Parameters

Name In Required Type Description
environmentId
path True

integer (int32)

organization
path True

string

The name of the Azure DevOps organization.

project
path True

string

Project ID or project name

resourceId
path True

integer (int32)

api-version
query True

string

Version of the API to use. This should be set to '7.2-preview.2' to use this version of the api.

Responses

Name Type Description
200 OK

KubernetesResource

successful operation

Security

oauth2

Type: oauth2
Flow: accessCode
Authorization URL: https://app.vssps.visualstudio.com/oauth2/authorize&response_type=Assertion
Token URL: https://app.vssps.visualstudio.com/oauth2/token?client_assertion_type=urn:ietf:params:oauth:client-assertion-type:jwt-bearer&grant_type=urn:ietf:params:oauth:grant-type:jwt-bearer

Scopes

Name Description
vso.environment_manage Provides ability to manage environment
vso.build Grants the ability to access build artifacts, including build results, definitions, and requests, and the ability to receive notifications about build events via service hooks.

Definitions

Name Description
EnvironmentReference
EnvironmentResourceType

Type of the resource.

IdentityRef
KubernetesResource
ReferenceLinks

EnvironmentReference

Name Type Description
id

integer (int32)

name

string

EnvironmentResourceType

Type of the resource.

Value Description
generic

Unknown resource type

kubernetes

Kubernetes resource type

undefined
virtualMachine

Virtual machine resource type

IdentityRef

Name Type Description
_links

ReferenceLinks

descriptor

string

directoryAlias

string

displayName

string

id

string

imageUrl

string

inactive

boolean

isAadIdentity

boolean

isContainer

boolean

isDeletedInOrigin

boolean

profileUrl

string

uniqueName

string

url

string

KubernetesResource

Name Type Description
clusterName

string

createdBy

IdentityRef

createdOn

string (date-time)

environmentReference

EnvironmentReference

id

integer (int32)

lastModifiedBy

IdentityRef

lastModifiedOn

string (date-time)

name

string

namespace

string

serviceEndpointId

string (uuid)

tags

string[]

Tags of the Environment Resource.

type

EnvironmentResourceType

Environment resource type

Name Type Description
links

object