Kubernetes - Add

POST https://dev.azure.com/{organization}/{project}/_apis/distributedtask/environments/{environmentId}/providers/kubernetes?api-version=7.1

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

api-version
query True

string

Version of the API to use. This should be set to '7.1' to use this version of the api.

Request Body

Name Type Description
clusterName

string

name

string

namespace

string

tags

string[]

Tags of the kubernetes resource.

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

Definitions

Name Description
EnvironmentReference
EnvironmentResourceType

Type of the resource.

IdentityRef
KubernetesResource
KubernetesResourceCreateParameters
ReferenceLinks

The class to represent a collection of REST reference links.

EnvironmentReference

Name Type Description
id

integer

name

string

EnvironmentResourceType

Type of the resource.

Name Type Description
generic

string

Unknown resource type

kubernetes

string

Kubernetes resource type

undefined

string

virtualMachine

string

Virtual machine resource type

IdentityRef

Name Type Description
_links

ReferenceLinks

This field contains zero or more interesting links about the graph subject. These links may be invoked to obtain additional relationships or more detailed information about this graph subject.

descriptor

string

The descriptor is the primary way to reference the graph subject while the system is running. This field will uniquely identify the same graph subject across both Accounts and Organizations.

directoryAlias

string

Deprecated - Can be retrieved by querying the Graph user referenced in the "self" entry of the IdentityRef "_links" dictionary

displayName

string

This is the non-unique display name of the graph subject. To change this field, you must alter its value in the source provider.

id

string

imageUrl

string

Deprecated - Available in the "avatar" entry of the IdentityRef "_links" dictionary

inactive

boolean

Deprecated - Can be retrieved by querying the Graph membership state referenced in the "membershipState" entry of the GraphUser "_links" dictionary

isAadIdentity

boolean

Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsAadUserType/Descriptor.IsAadGroupType)

isContainer

boolean

Deprecated - Can be inferred from the subject type of the descriptor (Descriptor.IsGroupType)

isDeletedInOrigin

boolean

profileUrl

string

Deprecated - not in use in most preexisting implementations of ToIdentityRef

uniqueName

string

Deprecated - use Domain+PrincipalName instead

url

string

This url is the full route to the source resource of this graph subject.

KubernetesResource

Name Type Description
clusterName

string

createdBy

IdentityRef

createdOn

string

environmentReference

EnvironmentReference

id

integer

lastModifiedBy

IdentityRef

lastModifiedOn

string

name

string

namespace

string

serviceEndpointId

string

tags

string[]

Tags of the Environment Resource.

type

EnvironmentResourceType

Environment resource type

KubernetesResourceCreateParameters

Name Type Description
clusterName

string

name

string

namespace

string

tags

string[]

Tags of the kubernetes resource.

The class to represent a collection of REST reference links.

Name Type Description
links

object

The readonly view of the links. Because Reference links are readonly, we only want to expose them as read only.