Azure DevOps v2.7.0, Mar 27 23

azuredevops.ServiceEndpointKubernetes

Explore with Pulumi AI

Manages a Kubernetes service endpoint within Azure DevOps.

Relevant Links

Azure DevOps Service REST API 6.0 - Endpoints

Create ServiceEndpointKubernetes Resource

new ServiceEndpointKubernetes(name: string, args: ServiceEndpointKubernetesArgs, opts?: CustomResourceOptions);

@overload
def ServiceEndpointKubernetes(resource_name: str,
                              opts: Optional[ResourceOptions] = None,
                              apiserver_url: Optional[str] = None,
                              authorization: Optional[Mapping[str, str]] = None,
                              authorization_type: Optional[str] = None,
                              azure_subscriptions: Optional[Sequence[ServiceEndpointKubernetesAzureSubscriptionArgs]] = None,
                              description: Optional[str] = None,
                              kubeconfig: Optional[ServiceEndpointKubernetesKubeconfigArgs] = None,
                              project_id: Optional[str] = None,
                              service_account: Optional[ServiceEndpointKubernetesServiceAccountArgs] = None,
                              service_endpoint_name: Optional[str] = None)
@overload
def ServiceEndpointKubernetes(resource_name: str,
                              args: ServiceEndpointKubernetesArgs,
                              opts: Optional[ResourceOptions] = None)

func NewServiceEndpointKubernetes(ctx *Context, name string, args ServiceEndpointKubernetesArgs, opts ...ResourceOption) (*ServiceEndpointKubernetes, error)

public ServiceEndpointKubernetes(string name, ServiceEndpointKubernetesArgs args, CustomResourceOptions? opts = null)

public ServiceEndpointKubernetes(String name, ServiceEndpointKubernetesArgs args)
public ServiceEndpointKubernetes(String name, ServiceEndpointKubernetesArgs args, CustomResourceOptions options)

type: azuredevops:ServiceEndpointKubernetes
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.

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

resource_name str: The unique name of the resource.
args ServiceEndpointKubernetesArgs: The arguments to resource properties.
opts ResourceOptions: Bag of options to control resource's behavior.

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

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

name String: The unique name of the resource.
args ServiceEndpointKubernetesArgs: The arguments to resource properties.
options CustomResourceOptions: Bag of options to control resource's behavior.

ServiceEndpointKubernetes Resource Properties

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

Inputs

The ServiceEndpointKubernetes resource accepts the following input properties:

ApiserverUrl string: The hostname (in form of URI) of the Kubernetes API.
AuthorizationType string: The authentication method used to authenticate on the Kubernetes cluster. The value should be one of AzureSubscription, Kubeconfig, ServiceAccount.
ProjectId string: The ID of the project.
ServiceEndpointName string: The Service Endpoint name.
Authorization Dictionary<string, string>
AzureSubscriptions List<Pulumi.AzureDevOps.Inputs.ServiceEndpointKubernetesAzureSubscriptionArgs>: A azure_subscription block defined blow.
Description string
Kubeconfig Pulumi.AzureDevOps.Inputs.ServiceEndpointKubernetesKubeconfigArgs: A kubeconfig block defined blow.
ServiceAccount Pulumi.AzureDevOps.Inputs.ServiceEndpointKubernetesServiceAccountArgs: A service_account block defined blow.

ApiserverUrl string: The hostname (in form of URI) of the Kubernetes API.
AuthorizationType string: The authentication method used to authenticate on the Kubernetes cluster. The value should be one of AzureSubscription, Kubeconfig, ServiceAccount.
ProjectId string: The ID of the project.
ServiceEndpointName string: The Service Endpoint name.
Authorization map[string]string
AzureSubscriptions []ServiceEndpointKubernetesAzureSubscriptionArgs: A azure_subscription block defined blow.
Description string
Kubeconfig ServiceEndpointKubernetesKubeconfigArgs: A kubeconfig block defined blow.
ServiceAccount ServiceEndpointKubernetesServiceAccountArgs: A service_account block defined blow.

apiserverUrl String: The hostname (in form of URI) of the Kubernetes API.
authorizationType String: The authentication method used to authenticate on the Kubernetes cluster. The value should be one of AzureSubscription, Kubeconfig, ServiceAccount.
projectId String: The ID of the project.
serviceEndpointName String: The Service Endpoint name.
authorization Map<String,String>
azureSubscriptions List<ServiceEndpointKubernetesAzureSubscriptionArgs>: A azure_subscription block defined blow.
description String
kubeconfig ServiceEndpointKubernetesKubeconfigArgs: A kubeconfig block defined blow.
serviceAccount ServiceEndpointKubernetesServiceAccountArgs: A service_account block defined blow.

apiserverUrl string: The hostname (in form of URI) of the Kubernetes API.
authorizationType string: The authentication method used to authenticate on the Kubernetes cluster. The value should be one of AzureSubscription, Kubeconfig, ServiceAccount.
projectId string: The ID of the project.
serviceEndpointName string: The Service Endpoint name.
authorization {[key: string]: string}
azureSubscriptions ServiceEndpointKubernetesAzureSubscriptionArgs[]: A azure_subscription block defined blow.
description string
kubeconfig ServiceEndpointKubernetesKubeconfigArgs: A kubeconfig block defined blow.
serviceAccount ServiceEndpointKubernetesServiceAccountArgs: A service_account block defined blow.

apiserver_url str: The hostname (in form of URI) of the Kubernetes API.
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 ID of the project.
service_endpoint_name str: The Service Endpoint name.
authorization Mapping[str, str]
azure_subscriptions Sequence[ServiceEndpointKubernetesAzureSubscriptionArgs]: A azure_subscription block defined blow.
description str
kubeconfig ServiceEndpointKubernetesKubeconfigArgs: A kubeconfig block defined blow.
service_account ServiceEndpointKubernetesServiceAccountArgs: A service_account block defined blow.

apiserverUrl String: The hostname (in form of URI) of the Kubernetes API.
authorizationType String: The authentication method used to authenticate on the Kubernetes cluster. The value should be one of AzureSubscription, Kubeconfig, ServiceAccount.
projectId String: The ID of the project.
serviceEndpointName String: The Service Endpoint name.
authorization Map<String>
azureSubscriptions List<Property Map>: A azure_subscription block defined blow.
description String
kubeconfig Property Map: A kubeconfig block defined blow.
serviceAccount Property Map: A service_account block defined blow.

Outputs

All input properties are implicitly available as output properties. Additionally, the ServiceEndpointKubernetes 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 string: The provider-assigned unique ID for this managed resource.

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

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

Look up Existing ServiceEndpointKubernetes Resource

Get an existing ServiceEndpointKubernetes 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?: ServiceEndpointKubernetesState, opts?: CustomResourceOptions): ServiceEndpointKubernetes

@staticmethod
def get(resource_name: str,
        id: str,
        opts: Optional[ResourceOptions] = None,
        apiserver_url: Optional[str] = None,
        authorization: Optional[Mapping[str, str]] = None,
        authorization_type: Optional[str] = None,
        azure_subscriptions: Optional[Sequence[ServiceEndpointKubernetesAzureSubscriptionArgs]] = None,
        description: Optional[str] = None,
        kubeconfig: Optional[ServiceEndpointKubernetesKubeconfigArgs] = None,
        project_id: Optional[str] = None,
        service_account: Optional[ServiceEndpointKubernetesServiceAccountArgs] = None,
        service_endpoint_name: Optional[str] = None) -> ServiceEndpointKubernetes

func GetServiceEndpointKubernetes(ctx *Context, name string, id IDInput, state *ServiceEndpointKubernetesState, opts ...ResourceOption) (*ServiceEndpointKubernetes, error)

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

public static ServiceEndpointKubernetes get(String name, Output<String> id, ServiceEndpointKubernetesState state, CustomResourceOptions options)

Resource lookup is not supported in YAML

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.

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 hostname (in form of URI) of the Kubernetes API.
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.Inputs.ServiceEndpointKubernetesAzureSubscriptionArgs>: A azure_subscription block defined blow.
Description string
Kubeconfig Pulumi.AzureDevOps.Inputs.ServiceEndpointKubernetesKubeconfigArgs: A kubeconfig block defined blow.
ProjectId string: The ID of the project.
ServiceAccount Pulumi.AzureDevOps.Inputs.ServiceEndpointKubernetesServiceAccountArgs: A service_account block defined blow.
ServiceEndpointName string: The Service Endpoint name.

ApiserverUrl string: The hostname (in form of URI) of the Kubernetes API.
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 []ServiceEndpointKubernetesAzureSubscriptionArgs: A azure_subscription block defined blow.
Description string
Kubeconfig ServiceEndpointKubernetesKubeconfigArgs: A kubeconfig block defined blow.
ProjectId string: The ID of the project.
ServiceAccount ServiceEndpointKubernetesServiceAccountArgs: A service_account block defined blow.
ServiceEndpointName string: The Service Endpoint name.

apiserverUrl String: The hostname (in form of URI) of the Kubernetes API.
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 List<ServiceEndpointKubernetesAzureSubscriptionArgs>: A azure_subscription block defined blow.
description String
kubeconfig ServiceEndpointKubernetesKubeconfigArgs: A kubeconfig block defined blow.
projectId String: The ID of the project.
serviceAccount ServiceEndpointKubernetesServiceAccountArgs: A service_account block defined blow.
serviceEndpointName String: The Service Endpoint name.

apiserverUrl string: The hostname (in form of URI) of the Kubernetes API.
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 ServiceEndpointKubernetesAzureSubscriptionArgs[]: A azure_subscription block defined blow.
description string
kubeconfig ServiceEndpointKubernetesKubeconfigArgs: A kubeconfig block defined blow.
projectId string: The ID of the project.
serviceAccount ServiceEndpointKubernetesServiceAccountArgs: A service_account block defined blow.
serviceEndpointName string: The Service Endpoint name.

apiserver_url str: The hostname (in form of URI) of the Kubernetes API.
authorization Mapping[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 Sequence[ServiceEndpointKubernetesAzureSubscriptionArgs]: A azure_subscription block defined blow.
description str
kubeconfig ServiceEndpointKubernetesKubeconfigArgs: A kubeconfig block defined blow.
project_id str: The ID of the project.
service_account ServiceEndpointKubernetesServiceAccountArgs: A service_account block defined blow.
service_endpoint_name str: The Service Endpoint name.

apiserverUrl String: The hostname (in form of URI) of the Kubernetes API.
authorization Map<String>
authorizationType String: The authentication method used to authenticate on the Kubernetes cluster. The value should be one of AzureSubscription, Kubeconfig, ServiceAccount.
azureSubscriptions List<Property Map>: A azure_subscription block defined blow.
description String
kubeconfig Property Map: A kubeconfig block defined blow.
projectId String: The ID of the project.
serviceAccount Property Map: A service_account block defined blow.
serviceEndpointName String: The Service Endpoint name.

Supporting Types

ServiceEndpointKubernetesAzureSubscription

ClusterName string: The name of the Kubernetes cluster.
ResourcegroupId string: The resource group name, 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.
ClusterAdmin bool: Set this option to allow use cluster admin credentials.
Namespace string: The Kubernetes namespace. Default value is "default".

ClusterName string: The name of the Kubernetes cluster.
ResourcegroupId string: The resource group name, 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.
ClusterAdmin bool: Set this option to allow use cluster admin credentials.
Namespace string: The Kubernetes namespace. Default value is "default".

clusterName String: The name of the Kubernetes cluster.
resourcegroupId String: The resource group name, 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.
clusterAdmin Boolean: Set this option to allow use cluster admin credentials.
namespace String: The Kubernetes namespace. Default value is "default".

clusterName string: The name of the Kubernetes cluster.
resourcegroupId string: The resource group name, 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.
clusterAdmin boolean: Set this option to allow use cluster admin credentials.
namespace string: The Kubernetes namespace. Default value is "default".

cluster_name str: The name of the Kubernetes cluster.
resourcegroup_id str: The resource group name, to which the Kubernetes cluster is deployed.
subscription_id str: The id of the Azure subscription.
subscription_name str: The name of the Azure subscription.
tenant_id str: The id of the tenant used by the subscription.
azure_environment 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.
cluster_admin bool: Set this option to allow use cluster admin credentials.
namespace str: The Kubernetes namespace. Default value is "default".

clusterName String: The name of the Kubernetes cluster.
resourcegroupId String: The resource group name, 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.
clusterAdmin Boolean: Set this option to allow use cluster admin credentials.
namespace String: The Kubernetes namespace. Default value is "default".

ServiceEndpointKubernetesKubeconfig

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.

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.

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.

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.

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

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.

ServiceEndpointKubernetesServiceAccount

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 string: The certificate from a Kubernetes secret object.
token string: The token from a Kubernetes secret object.
caCertHash string
tokenHash string

ca_cert str: The certificate from a Kubernetes secret object.
token str: The token from a Kubernetes secret object.
ca_cert_hash str
token_hash str

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

Import

Azure DevOps Service Endpoint Kubernetes can be imported using projectID/serviceEndpointID or projectName/serviceEndpointID

 $ pulumi import azuredevops:index/serviceEndpointKubernetes:ServiceEndpointKubernetes example 00000000-0000-0000-0000-000000000000/00000000-0000-0000-0000-000000000000

Package Details

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