Kubernetes

# azuredevops.ServiceEndpoint.Kubernetes

Manages a Kubernetes service endpoint within Azure DevOps.

Relevant Links

Azure DevOps Service REST API 5.1 - Endpoints

Example Usage

Coming soon!

Create a Kubernetes Resource

new Kubernetes(name: string, args: KubernetesArgs, opts?: CustomResourceOptions);

def Kubernetes(resource_name, opts=None, apiserver_url=None, authorization=None, authorization_type=None, azure_subscriptions=None, description=None, kubeconfigs=None, project_id=None, service_accounts=None, service_endpoint_name=None, __props__=None);

func NewKubernetes(ctx *Context, name string, args KubernetesArgs, opts ...ResourceOption) (*Kubernetes, error)

public Kubernetes(string name, KubernetesArgs args, CustomResourceOptions? opts = null)

name string: The unique name of the resource.
args KubernetesArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

resource_name str: The unique name of the resource.
opts ResourceOptions: A bag of options that control this resource's behavior.

ctx Context: Context object for the current deployment.
name string: The unique name of the resource.
args KubernetesArgs: The arguments to resource properties.
opts ResourceOption: Bag of options to control resource's behavior.

name string: The unique name of the resource.
args KubernetesArgs: The arguments to resource properties.
opts CustomResourceOptions: Bag of options to control resource's behavior.

Kubernetes Resource Properties

To learn more about resource properties and how to use them, see Inputs and Outputs in the Programming Model docs.

Inputs

The Kubernetes resource accepts the following input properties:

ApiserverUrl string: The Service Endpoint description.
AuthorizationType string: The authentication method used to authenticate on the Kubernetes cluster. The value should be one of AzureSubscription, Kubeconfig, ServiceAccount.
ProjectId string: The project ID or project name.
ServiceEndpointName string: The Service Endpoint name.
Authorization Dictionary<string, string>
AzureSubscriptions List<Pulumi.AzureDevOps.ServiceEndpoint.Inputs.KubernetesAzureSubscriptionArgs>: The configuration for authorization_type=“AzureSubscription”.
Description string
Kubeconfigs List<Pulumi.AzureDevOps.ServiceEndpoint.Inputs.KubernetesKubeconfigArgs>: The configuration for authorization_type=“Kubeconfig”.
ServiceAccounts List<Pulumi.AzureDevOps.ServiceEndpoint.Inputs.KubernetesServiceAccountArgs>: The configuration for authorization_type=“ServiceAccount”. This type uses the credentials of a service account currently deployed to the cluster.

ApiserverUrl string: The Service Endpoint description.
AuthorizationType string: The authentication method used to authenticate on the Kubernetes cluster. The value should be one of AzureSubscription, Kubeconfig, ServiceAccount.
ProjectId string: The project ID or project name.
ServiceEndpointName string: The Service Endpoint name.
Authorization map[string]string
AzureSubscriptions []KubernetesAzureSubscription: The configuration for authorization_type=“AzureSubscription”.
Description string
Kubeconfigs []KubernetesKubeconfig: The configuration for authorization_type=“Kubeconfig”.
ServiceAccounts []KubernetesServiceAccount: The configuration for authorization_type=“ServiceAccount”. This type uses the credentials of a service account currently deployed to the cluster.

apiserverUrl string: The Service Endpoint description.
authorizationType string: The authentication method used to authenticate on the Kubernetes cluster. The value should be one of AzureSubscription, Kubeconfig, ServiceAccount.
projectId string: The project ID or project name.
serviceEndpointName string: The Service Endpoint name.
authorization {[key: string]: string}
azureSubscriptions KubernetesAzureSubscription[]: The configuration for authorization_type=“AzureSubscription”.
description string
kubeconfigs KubernetesKubeconfig[]: The configuration for authorization_type=“Kubeconfig”.
serviceAccounts KubernetesServiceAccount[]: The configuration for authorization_type=“ServiceAccount”. This type uses the credentials of a service account currently deployed to the cluster.

apiserver_url str: The Service Endpoint description.
authorization_type str: The authentication method used to authenticate on the Kubernetes cluster. The value should be one of AzureSubscription, Kubeconfig, ServiceAccount.
project_id str: The project ID or project name.
service_endpoint_name str: The Service Endpoint name.
authorization Dict[str, str]
azure_subscriptions List[KubernetesAzureSubscription]: The configuration for authorization_type=“AzureSubscription”.
description str
kubeconfigs List[KubernetesKubeconfig]: The configuration for authorization_type=“Kubeconfig”.
service_accounts List[KubernetesServiceAccount]: The configuration for authorization_type=“ServiceAccount”. This type uses the credentials of a service account currently deployed to the cluster.

Outputs

All input properties are implicitly available as output properties. Additionally, the Kubernetes resource produces the following output properties:

Id string: The provider-assigned unique ID for this managed resource.

Id string: The provider-assigned unique ID for this managed resource.

id string: The provider-assigned unique ID for this managed resource.

id str: The provider-assigned unique ID for this managed resource.

Look up an Existing Kubernetes Resource

Get an existing Kubernetes resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.

public static get(name: string, id: Input<ID>, state?: KubernetesState, opts?: CustomResourceOptions): Kubernetes

static get(resource_name, id, opts=None, apiserver_url=None, authorization=None, authorization_type=None, azure_subscriptions=None, description=None, kubeconfigs=None, project_id=None, service_accounts=None, service_endpoint_name=None, __props__=None);

func GetKubernetes(ctx *Context, name string, id IDInput, state *KubernetesState, opts ...ResourceOption) (*Kubernetes, error)

public static Kubernetes Get(string name, Input<string> id, KubernetesState? state, CustomResourceOptions? opts = null)

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

resource_name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

name: The unique name of the resulting resource.
id: The unique provider ID of the resource to lookup.
state: Any extra arguments used during the lookup.
opts: A bag of options that control this resource's behavior.

The following state arguments are supported:

ApiserverUrl string: The Service Endpoint description.
Authorization Dictionary<string, string>
AuthorizationType string: The authentication method used to authenticate on the Kubernetes cluster. The value should be one of AzureSubscription, Kubeconfig, ServiceAccount.
AzureSubscriptions List<Pulumi.AzureDevOps.ServiceEndpoint.Inputs.KubernetesAzureSubscriptionArgs>: The configuration for authorization_type=“AzureSubscription”.
Description string
Kubeconfigs List<Pulumi.AzureDevOps.ServiceEndpoint.Inputs.KubernetesKubeconfigArgs>: The configuration for authorization_type=“Kubeconfig”.
ProjectId string: The project ID or project name.
ServiceAccounts List<Pulumi.AzureDevOps.ServiceEndpoint.Inputs.KubernetesServiceAccountArgs>: The configuration for authorization_type=“ServiceAccount”. This type uses the credentials of a service account currently deployed to the cluster.
ServiceEndpointName string: The Service Endpoint name.

ApiserverUrl string: The Service Endpoint description.
Authorization map[string]string
AuthorizationType string: The authentication method used to authenticate on the Kubernetes cluster. The value should be one of AzureSubscription, Kubeconfig, ServiceAccount.
AzureSubscriptions []KubernetesAzureSubscription: The configuration for authorization_type=“AzureSubscription”.
Description string
Kubeconfigs []KubernetesKubeconfig: The configuration for authorization_type=“Kubeconfig”.
ProjectId string: The project ID or project name.
ServiceAccounts []KubernetesServiceAccount: The configuration for authorization_type=“ServiceAccount”. This type uses the credentials of a service account currently deployed to the cluster.
ServiceEndpointName string: The Service Endpoint name.

apiserverUrl string: The Service Endpoint description.
authorization {[key: string]: string}
authorizationType string: The authentication method used to authenticate on the Kubernetes cluster. The value should be one of AzureSubscription, Kubeconfig, ServiceAccount.
azureSubscriptions KubernetesAzureSubscription[]: The configuration for authorization_type=“AzureSubscription”.
description string
kubeconfigs KubernetesKubeconfig[]: The configuration for authorization_type=“Kubeconfig”.
projectId string: The project ID or project name.
serviceAccounts KubernetesServiceAccount[]: The configuration for authorization_type=“ServiceAccount”. This type uses the credentials of a service account currently deployed to the cluster.
serviceEndpointName string: The Service Endpoint name.

apiserver_url str: The Service Endpoint description.
authorization Dict[str, str]
authorization_type str: The authentication method used to authenticate on the Kubernetes cluster. The value should be one of AzureSubscription, Kubeconfig, ServiceAccount.
azure_subscriptions List[KubernetesAzureSubscription]: The configuration for authorization_type=“AzureSubscription”.
description str
kubeconfigs List[KubernetesKubeconfig]: The configuration for authorization_type=“Kubeconfig”.
project_id str: The project ID or project name.
service_accounts List[KubernetesServiceAccount]: The configuration for authorization_type=“ServiceAccount”. This type uses the credentials of a service account currently deployed to the cluster.
service_endpoint_name str: The Service Endpoint name.

Supporting Types

KubernetesAzureSubscription

See the input and output API doc for this type.

ClusterName string: The name of the Kubernetes cluster.
ResourcegroupId string: The resource group id, to which the Kubernetes cluster is deployed.
SubscriptionId string: The id of the Azure subscription.
SubscriptionName string: The name of the Azure subscription.
TenantId string: The id of the tenant used by the subscription.
AzureEnvironment string: Azure environment refers to whether the public cloud offering or domestic (government) clouds are being used. Currently, only the public cloud is supported. The value must be AzureCloud. This is also the default-value.
Namespace string: The Kubernetes namespace. Default value is “default”.

ClusterName string: The name of the Kubernetes cluster.
ResourcegroupId string: The resource group id, to which the Kubernetes cluster is deployed.
SubscriptionId string: The id of the Azure subscription.
SubscriptionName string: The name of the Azure subscription.
TenantId string: The id of the tenant used by the subscription.
AzureEnvironment string: Azure environment refers to whether the public cloud offering or domestic (government) clouds are being used. Currently, only the public cloud is supported. The value must be AzureCloud. This is also the default-value.
Namespace string: The Kubernetes namespace. Default value is “default”.

clusterName string: The name of the Kubernetes cluster.
resourcegroupId string: The resource group id, to which the Kubernetes cluster is deployed.
subscriptionId string: The id of the Azure subscription.
subscriptionName string: The name of the Azure subscription.
tenantId string: The id of the tenant used by the subscription.
azureEnvironment string: Azure environment refers to whether the public cloud offering or domestic (government) clouds are being used. Currently, only the public cloud is supported. The value must be AzureCloud. This is also the default-value.
namespace string: The Kubernetes namespace. Default value is “default”.

clusterName str: The name of the Kubernetes cluster.
resourcegroupId str: The resource group id, to which the Kubernetes cluster is deployed.
subscriptionId str: The id of the Azure subscription.
subscriptionName str: The name of the Azure subscription.
tenantId str: The id of the tenant used by the subscription.
azureEnvironment str: Azure environment refers to whether the public cloud offering or domestic (government) clouds are being used. Currently, only the public cloud is supported. The value must be AzureCloud. This is also the default-value.
namespace str: The Kubernetes namespace. Default value is “default”.

KubernetesKubeconfig

See the input and output API doc for this type.

KubeConfig string: The content of the kubeconfig in yaml notation to be used to communicate with the API-Server of Kubernetes.
AcceptUntrustedCerts bool: Set this option to allow clients to accept a self-signed certificate.
ClusterContext string: Context within the kubeconfig file that is to be used for identifying the cluster. Default value is the current-context set in kubeconfig.
KubeConfigHash string

KubeConfig string: The content of the kubeconfig in yaml notation to be used to communicate with the API-Server of Kubernetes.
AcceptUntrustedCerts bool: Set this option to allow clients to accept a self-signed certificate.
ClusterContext string: Context within the kubeconfig file that is to be used for identifying the cluster. Default value is the current-context set in kubeconfig.
KubeConfigHash string

kubeConfig string: The content of the kubeconfig in yaml notation to be used to communicate with the API-Server of Kubernetes.
acceptUntrustedCerts boolean: Set this option to allow clients to accept a self-signed certificate.
clusterContext string: Context within the kubeconfig file that is to be used for identifying the cluster. Default value is the current-context set in kubeconfig.
kubeConfigHash string

kubeConfig str: The content of the kubeconfig in yaml notation to be used to communicate with the API-Server of Kubernetes.
acceptUntrustedCerts bool: Set this option to allow clients to accept a self-signed certificate.
clusterContext str: Context within the kubeconfig file that is to be used for identifying the cluster. Default value is the current-context set in kubeconfig.
kubeConfigHash str

KubernetesServiceAccount

See the input and output API doc for this type.

CaCert string: The certificate from a Kubernetes secret object.
Token string: The token from a Kubernetes secret object.
CaCertHash string
TokenHash string

CaCert string: The certificate from a Kubernetes secret object.
Token string: The token from a Kubernetes secret object.
CaCertHash string
TokenHash string

caCert string: The certificate from a Kubernetes secret object.
token string: The token from a Kubernetes secret object.
caCertHash string
tokenHash string

caCert str: The certificate from a Kubernetes secret object.
token str: The token from a Kubernetes secret object.
caCertHash str
tokenHash str

Package Details

Repository: https://github.com/pulumi/pulumi-azuredevops
License: Apache-2.0
Notes: This Pulumi package is based on the azuredevops Terraform Provider.

The Pulumi Platform

Get Started

Migrate to Pulumi

Solutions for All Teams and Engineers

Any Code

Any Cloud

Kubernetes

# azuredevops.ServiceEndpoint.Kubernetes

Relevant Links

Example Usage

Create a Kubernetes Resource

Kubernetes Resource Properties

Inputs

Outputs

Look up an Existing Kubernetes Resource

Supporting Types

KubernetesAzureSubscription

KubernetesKubeconfig

KubernetesServiceAccount

Package Details

On This Page