containerservice

This provider is a derived work of the Terraform Provider distributed under MPL 2.0. If you encounter a bug or missing feature, first check the pulumi/pulumi-azure repo; however, if that doesn’t turn up anything, please consult the source terraform-providers/terraform-provider-azurerm repo.

class pulumi_azure.containerservice.AwaitableGetKubernetesClusterResult(addon_profiles=None, agent_pool_profiles=None, dns_prefix=None, fqdn=None, kube_admin_configs=None, kube_admin_config_raw=None, kube_configs=None, kube_config_raw=None, kubernetes_version=None, linux_profiles=None, location=None, name=None, network_profiles=None, node_resource_group=None, resource_group_name=None, role_based_access_controls=None, service_principals=None, tags=None, windows_profiles=None, id=None)
class pulumi_azure.containerservice.AwaitableGetKubernetesServiceVersionsResult(latest_version=None, location=None, version_prefix=None, versions=None, id=None)
class pulumi_azure.containerservice.AwaitableGetRegistryResult(admin_enabled=None, admin_password=None, admin_username=None, location=None, login_server=None, name=None, resource_group_name=None, sku=None, storage_account_id=None, tags=None, id=None)
class pulumi_azure.containerservice.GetKubernetesClusterResult(addon_profiles=None, agent_pool_profiles=None, dns_prefix=None, fqdn=None, kube_admin_configs=None, kube_admin_config_raw=None, kube_configs=None, kube_config_raw=None, kubernetes_version=None, linux_profiles=None, location=None, name=None, network_profiles=None, node_resource_group=None, resource_group_name=None, role_based_access_controls=None, service_principals=None, tags=None, windows_profiles=None, id=None)

A collection of values returned by getKubernetesCluster.

addon_profiles = None

A addon_profile block as documented below.

agent_pool_profiles = None

An agent_pool_profile block as documented below.

dns_prefix = None

The DNS Prefix of the managed Kubernetes cluster.

fqdn = None

The FQDN of the Azure Kubernetes Managed Cluster.

kube_admin_configs = None

A kube_admin_config block as defined below. This is only available when Role Based Access Control with Azure Active Directory is enabled.

kube_admin_config_raw = None

Raw Kubernetes config for the admin account to be used by kubectl and other compatible tools. This is only available when Role Based Access Control with Azure Active Directory is enabled.

kube_configs = None

A kube_config block as defined below.

kube_config_raw = None

Base64 encoded Kubernetes configuration.

kubernetes_version = None

The version of Kubernetes used on the managed Kubernetes Cluster.

linux_profiles = None

A linux_profile block as documented below.

location = None

The Azure Region in which the managed Kubernetes Cluster exists.

name = None

The name assigned to this pool of agents.

network_profiles = None

A network_profile block as documented below.

node_resource_group = None

Auto-generated Resource Group containing AKS Cluster resources.

role_based_access_controls = None

A role_based_access_control block as documented below.

service_principals = None

A service_principal block as documented below.

tags = None

A mapping of tags assigned to this resource.

windows_profiles = None

A windows_profile block as documented below.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.containerservice.GetKubernetesServiceVersionsResult(latest_version=None, location=None, version_prefix=None, versions=None, id=None)

A collection of values returned by getKubernetesServiceVersions.

latest_version = None

The most recent version available.

versions = None

The list of all supported versions.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.containerservice.GetRegistryResult(admin_enabled=None, admin_password=None, admin_username=None, location=None, login_server=None, name=None, resource_group_name=None, sku=None, storage_account_id=None, tags=None, id=None)

A collection of values returned by getRegistry.

admin_enabled = None

Is the Administrator account enabled for this Container Registry.

admin_password = None

The Password associated with the Container Registry Admin account - if the admin account is enabled.

admin_username = None

The Username associated with the Container Registry Admin account - if the admin account is enabled.

location = None

The Azure Region in which this Container Registry exists.

login_server = None

The URL that can be used to log into the container registry.

sku = None

The SKU of this Container Registry, such as Basic.

storage_account_id = None

The ID of the Storage Account used for this Container Registry. This is only returned for Classic SKU’s.

tags = None

A map of tags assigned to the Container Registry.

id = None

id is the provider-assigned unique ID for this managed resource.

class pulumi_azure.containerservice.Group(resource_name, opts=None, containers=None, diagnostics=None, dns_name_label=None, identity=None, image_registry_credentials=None, ip_address_type=None, location=None, name=None, network_profile_id=None, os_type=None, resource_group_name=None, restart_policy=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages as an Azure Container Group instance.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • containers (pulumi.Input[list]) – The definition of a container that is part of the group as documented in the container block below. Changing this forces a new resource to be created.

  • diagnostics (pulumi.Input[dict]) – A diagnostics block as documented below.

  • dns_name_label (pulumi.Input[str]) – The DNS label/name for the container groups IP. Changing this forces a new resource to be created.

  • identity (pulumi.Input[dict]) – An identity block as defined below.

  • image_registry_credentials (pulumi.Input[list]) – A image_registry_credential block as documented below. Changing this forces a new resource to be created.

  • ip_address_type (pulumi.Input[str]) – Specifies the ip address type of the container. Public or Private. Changing this forces a new resource to be created. If set to Private, network_profile_id also needs to be set.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – Specifies the name of the Container Group. Changing this forces a new resource to be created.

  • network_profile_id (pulumi.Input[str]) – Network profile ID for deploying to virtual network.

  • os_type (pulumi.Input[str]) – The OS for the container group. Allowed values are Linux and Windows. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Container Group. Changing this forces a new resource to be created.

  • restart_policy (pulumi.Input[str]) – Restart policy for the container group. Allowed values are Always, Never, OnFailure. Defaults to Always. Changing this forces a new resource to be created.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

The containers object supports the following:

  • command (pulumi.Input[str])

  • commands (pulumi.Input[list])

  • cpu (pulumi.Input[float])

  • environmentVariables (pulumi.Input[dict])

  • gpu (pulumi.Input[dict])

    • count (pulumi.Input[float])

    • sku (pulumi.Input[str])

  • image (pulumi.Input[str])

  • livenessProbe (pulumi.Input[dict])

    • execs (pulumi.Input[list])

    • failureThreshold (pulumi.Input[float])

    • httpGets (pulumi.Input[list])

      • path (pulumi.Input[str])

      • port (pulumi.Input[float])

      • scheme (pulumi.Input[str])

    • initialDelaySeconds (pulumi.Input[float])

    • periodSeconds (pulumi.Input[float])

    • successThreshold (pulumi.Input[float])

    • timeoutSeconds (pulumi.Input[float])

  • memory (pulumi.Input[float])

  • name (pulumi.Input[str]) - Specifies the name of the Container Group. Changing this forces a new resource to be created.

  • port (pulumi.Input[float])

  • ports (pulumi.Input[list])

    • port (pulumi.Input[float])

    • protocol (pulumi.Input[str])

  • protocol (pulumi.Input[str])

  • readinessProbe (pulumi.Input[dict])

    • execs (pulumi.Input[list])

    • failureThreshold (pulumi.Input[float])

    • httpGets (pulumi.Input[list])

      • path (pulumi.Input[str])

      • port (pulumi.Input[float])

      • scheme (pulumi.Input[str])

    • initialDelaySeconds (pulumi.Input[float])

    • periodSeconds (pulumi.Input[float])

    • successThreshold (pulumi.Input[float])

    • timeoutSeconds (pulumi.Input[float])

  • secureEnvironmentVariables (pulumi.Input[dict])

  • volumes (pulumi.Input[list])

    • mountPath (pulumi.Input[str])

    • name (pulumi.Input[str]) - Specifies the name of the Container Group. Changing this forces a new resource to be created.

    • readOnly (pulumi.Input[bool])

    • shareName (pulumi.Input[str])

    • storageAccountKey (pulumi.Input[str])

    • storageAccountName (pulumi.Input[str])

The diagnostics object supports the following:

  • logAnalytics (pulumi.Input[dict])

    • logType (pulumi.Input[str])

    • metadata (pulumi.Input[dict])

    • workspaceId (pulumi.Input[str])

    • workspaceKey (pulumi.Input[str])

The identity object supports the following:

  • identityIds (pulumi.Input[list])

  • principal_id (pulumi.Input[str])

  • type (pulumi.Input[str])

The image_registry_credentials object supports the following:

  • password (pulumi.Input[str])

  • server (pulumi.Input[str])

  • username (pulumi.Input[str])

containers = None

The definition of a container that is part of the group as documented in the container block below. Changing this forces a new resource to be created.

  • command (str)

  • commands (list)

  • cpu (float)

  • environmentVariables (dict)

  • gpu (dict)

    • count (float)

    • sku (str)

  • image (str)

  • livenessProbe (dict)

    • execs (list)

    • failureThreshold (float)

    • httpGets (list)

      • path (str)

      • port (float)

      • scheme (str)

    • initialDelaySeconds (float)

    • periodSeconds (float)

    • successThreshold (float)

    • timeoutSeconds (float)

  • memory (float)

  • name (str) - Specifies the name of the Container Group. Changing this forces a new resource to be created.

  • port (float)

  • ports (list)

    • port (float)

    • protocol (str)

  • protocol (str)

  • readinessProbe (dict)

    • execs (list)

    • failureThreshold (float)

    • httpGets (list)

      • path (str)

      • port (float)

      • scheme (str)

    • initialDelaySeconds (float)

    • periodSeconds (float)

    • successThreshold (float)

    • timeoutSeconds (float)

  • secureEnvironmentVariables (dict)

  • volumes (list)

    • mountPath (str)

    • name (str) - Specifies the name of the Container Group. Changing this forces a new resource to be created.

    • readOnly (bool)

    • shareName (str)

    • storageAccountKey (str)

    • storageAccountName (str)

diagnostics = None

A diagnostics block as documented below.

  • logAnalytics (dict)

    • logType (str)

    • metadata (dict)

    • workspaceId (str)

    • workspaceKey (str)

dns_name_label = None

The DNS label/name for the container groups IP. Changing this forces a new resource to be created.

fqdn = None

The FQDN of the container group derived from dns_name_label.

identity = None

An identity block as defined below.

  • identityIds (list)

  • principal_id (str)

  • type (str)

image_registry_credentials = None

A image_registry_credential block as documented below. Changing this forces a new resource to be created.

  • password (str)

  • server (str)

  • username (str)

ip_address = None

The IP address allocated to the container group.

ip_address_type = None

Specifies the ip address type of the container. Public or Private. Changing this forces a new resource to be created. If set to Private, network_profile_id also needs to be set.

location = None

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name = None

Specifies the name of the Container Group. Changing this forces a new resource to be created.

network_profile_id = None

Network profile ID for deploying to virtual network.

os_type = None

The OS for the container group. Allowed values are Linux and Windows. Changing this forces a new resource to be created.

resource_group_name = None

The name of the resource group in which to create the Container Group. Changing this forces a new resource to be created.

restart_policy = None

Restart policy for the container group. Allowed values are Always, Never, OnFailure. Defaults to Always. Changing this forces a new resource to be created.

tags = None

A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

static get(resource_name, id, opts=None, containers=None, diagnostics=None, dns_name_label=None, fqdn=None, identity=None, image_registry_credentials=None, ip_address=None, ip_address_type=None, location=None, name=None, network_profile_id=None, os_type=None, resource_group_name=None, restart_policy=None, tags=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • containers (pulumi.Input[list]) – The definition of a container that is part of the group as documented in the container block below. Changing this forces a new resource to be created.

  • diagnostics (pulumi.Input[dict]) – A diagnostics block as documented below.

  • dns_name_label (pulumi.Input[str]) – The DNS label/name for the container groups IP. Changing this forces a new resource to be created.

  • fqdn (pulumi.Input[str]) – The FQDN of the container group derived from dns_name_label.

  • identity (pulumi.Input[dict]) – An identity block as defined below.

  • image_registry_credentials (pulumi.Input[list]) – A image_registry_credential block as documented below. Changing this forces a new resource to be created.

  • ip_address (pulumi.Input[str]) – The IP address allocated to the container group.

  • ip_address_type (pulumi.Input[str]) – Specifies the ip address type of the container. Public or Private. Changing this forces a new resource to be created. If set to Private, network_profile_id also needs to be set.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – Specifies the name of the Container Group. Changing this forces a new resource to be created.

  • network_profile_id (pulumi.Input[str]) – Network profile ID for deploying to virtual network.

  • os_type (pulumi.Input[str]) – The OS for the container group. Allowed values are Linux and Windows. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Container Group. Changing this forces a new resource to be created.

  • restart_policy (pulumi.Input[str]) – Restart policy for the container group. Allowed values are Always, Never, OnFailure. Defaults to Always. Changing this forces a new resource to be created.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource. Changing this forces a new resource to be created.

The containers object supports the following:

  • command (pulumi.Input[str])

  • commands (pulumi.Input[list])

  • cpu (pulumi.Input[float])

  • environmentVariables (pulumi.Input[dict])

  • gpu (pulumi.Input[dict])

    • count (pulumi.Input[float])

    • sku (pulumi.Input[str])

  • image (pulumi.Input[str])

  • livenessProbe (pulumi.Input[dict])

    • execs (pulumi.Input[list])

    • failureThreshold (pulumi.Input[float])

    • httpGets (pulumi.Input[list])

      • path (pulumi.Input[str])

      • port (pulumi.Input[float])

      • scheme (pulumi.Input[str])

    • initialDelaySeconds (pulumi.Input[float])

    • periodSeconds (pulumi.Input[float])

    • successThreshold (pulumi.Input[float])

    • timeoutSeconds (pulumi.Input[float])

  • memory (pulumi.Input[float])

  • name (pulumi.Input[str]) - Specifies the name of the Container Group. Changing this forces a new resource to be created.

  • port (pulumi.Input[float])

  • ports (pulumi.Input[list])

    • port (pulumi.Input[float])

    • protocol (pulumi.Input[str])

  • protocol (pulumi.Input[str])

  • readinessProbe (pulumi.Input[dict])

    • execs (pulumi.Input[list])

    • failureThreshold (pulumi.Input[float])

    • httpGets (pulumi.Input[list])

      • path (pulumi.Input[str])

      • port (pulumi.Input[float])

      • scheme (pulumi.Input[str])

    • initialDelaySeconds (pulumi.Input[float])

    • periodSeconds (pulumi.Input[float])

    • successThreshold (pulumi.Input[float])

    • timeoutSeconds (pulumi.Input[float])

  • secureEnvironmentVariables (pulumi.Input[dict])

  • volumes (pulumi.Input[list])

    • mountPath (pulumi.Input[str])

    • name (pulumi.Input[str]) - Specifies the name of the Container Group. Changing this forces a new resource to be created.

    • readOnly (pulumi.Input[bool])

    • shareName (pulumi.Input[str])

    • storageAccountKey (pulumi.Input[str])

    • storageAccountName (pulumi.Input[str])

The diagnostics object supports the following:

  • logAnalytics (pulumi.Input[dict])

    • logType (pulumi.Input[str])

    • metadata (pulumi.Input[dict])

    • workspaceId (pulumi.Input[str])

    • workspaceKey (pulumi.Input[str])

The identity object supports the following:

  • identityIds (pulumi.Input[list])

  • principal_id (pulumi.Input[str])

  • type (pulumi.Input[str])

The image_registry_credentials object supports the following:

  • password (pulumi.Input[str])

  • server (pulumi.Input[str])

  • username (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.containerservice.KubernetesCluster(resource_name, opts=None, addon_profile=None, agent_pool_profiles=None, api_server_authorized_ip_ranges=None, dns_prefix=None, enable_pod_security_policy=None, kubernetes_version=None, linux_profile=None, location=None, name=None, network_profile=None, node_resource_group=None, resource_group_name=None, role_based_access_control=None, service_principal=None, tags=None, windows_profile=None, __props__=None, __name__=None, __opts__=None)

Manages a Managed Kubernetes Cluster (also known as AKS / Azure Kubernetes Service)

Note: All arguments including the client secret will be stored in the raw state as plain-text. Read more about sensitive data in state.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • agent_pool_profiles (pulumi.Input[list]) – One or more agent_pool_profile blocks as defined below.

  • dns_prefix (pulumi.Input[str]) – DNS prefix specified when creating the managed cluster. Changing this forces a new resource to be created.

  • location (pulumi.Input[str]) – The location where the Managed Kubernetes Cluster should be created. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – The name of the Managed Kubernetes Cluster to create. Changing this forces a new resource to be created.

  • node_resource_group (pulumi.Input[str]) – The auto-generated Resource Group which contains the resources for this Managed Kubernetes Cluster.

  • resource_group_name (pulumi.Input[str]) – Specifies the Resource Group where the Managed Kubernetes Cluster should exist. Changing this forces a new resource to be created.

  • service_principal (pulumi.Input[dict]) – A service_principal block as documented below.

The addon_profile object supports the following:

  • aciConnectorLinux (pulumi.Input[dict])

    • enabled (pulumi.Input[bool])

    • subnetName (pulumi.Input[str])

  • httpApplicationRouting (pulumi.Input[dict]) - A http_application_routing block as defined below.

    • enabled (pulumi.Input[bool])

    • httpApplicationRoutingZoneName (pulumi.Input[str]) - The Zone Name of the HTTP Application Routing.

  • kubeDashboard (pulumi.Input[dict])

    • enabled (pulumi.Input[bool])

  • omsAgent (pulumi.Input[dict])

    • enabled (pulumi.Input[bool])

    • logAnalyticsWorkspaceId (pulumi.Input[str])

The agent_pool_profiles object supports the following:

  • availabilityZones (pulumi.Input[list])

  • count (pulumi.Input[float])

  • dns_prefix (pulumi.Input[str]) - DNS prefix specified when creating the managed cluster. Changing this forces a new resource to be created.

  • enableAutoScaling (pulumi.Input[bool])

  • fqdn (pulumi.Input[str]) - The FQDN of the Azure Kubernetes Managed Cluster.

  • maxCount (pulumi.Input[float])

  • maxPods (pulumi.Input[float])

  • minCount (pulumi.Input[float])

  • name (pulumi.Input[str]) - The name of the Managed Kubernetes Cluster to create. Changing this forces a new resource to be created.

  • nodeTaints (pulumi.Input[list])

  • osDiskSizeGb (pulumi.Input[float])

  • os_type (pulumi.Input[str])

  • type (pulumi.Input[str])

  • vm_size (pulumi.Input[str])

  • vnetSubnetId (pulumi.Input[str])

The linux_profile object supports the following:

  • admin_username (pulumi.Input[str])

  • sshKey (pulumi.Input[dict])

    • keyData (pulumi.Input[str])

The network_profile object supports the following:

  • dnsServiceIp (pulumi.Input[str])

  • dockerBridgeCidr (pulumi.Input[str])

  • loadBalancerSku (pulumi.Input[str])

  • networkPlugin (pulumi.Input[str])

  • networkPolicy (pulumi.Input[str])

  • podCidr (pulumi.Input[str])

  • serviceCidr (pulumi.Input[str])

The role_based_access_control object supports the following:

  • azureActiveDirectory (pulumi.Input[dict])

    • clientAppId (pulumi.Input[str])

    • serverAppId (pulumi.Input[str])

    • serverAppSecret (pulumi.Input[str])

    • tenantId (pulumi.Input[str])

  • enabled (pulumi.Input[bool])

The service_principal object supports the following:

  • client_id (pulumi.Input[str])

  • client_secret (pulumi.Input[str])

The windows_profile object supports the following:

  • admin_password (pulumi.Input[str])

  • admin_username (pulumi.Input[str])

agent_pool_profiles = None

One or more agent_pool_profile blocks as defined below.

  • availabilityZones (list)

  • count (float)

  • dns_prefix (str) - DNS prefix specified when creating the managed cluster. Changing this forces a new resource to be created.

  • enableAutoScaling (bool)

  • fqdn (str) - The FQDN of the Azure Kubernetes Managed Cluster.

  • maxCount (float)

  • maxPods (float)

  • minCount (float)

  • name (str) - The name of the Managed Kubernetes Cluster to create. Changing this forces a new resource to be created.

  • nodeTaints (list)

  • osDiskSizeGb (float)

  • os_type (str)

  • type (str)

  • vm_size (str)

  • vnetSubnetId (str)

dns_prefix = None

DNS prefix specified when creating the managed cluster. Changing this forces a new resource to be created.

fqdn = None

The FQDN of the Azure Kubernetes Managed Cluster.

kube_admin_config = None

A kube_admin_config block as defined below. This is only available when Role Based Access Control with Azure Active Directory is enabled.

  • clientCertificate (str) - Base64 encoded public certificate used by clients to authenticate to the Kubernetes cluster.

  • clientKey (str) - Base64 encoded private key used by clients to authenticate to the Kubernetes cluster.

  • clusterCaCertificate (str) - Base64 encoded public CA certificate used as the root of trust for the Kubernetes cluster.

  • host (str) - The Kubernetes cluster server host.

  • password (str) - A password or token used to authenticate to the Kubernetes cluster.

  • username (str) - A username used to authenticate to the Kubernetes cluster.

kube_admin_config_raw = None

Raw Kubernetes config for the admin account to be used by kubectl and other compatible tools. This is only available when Role Based Access Control with Azure Active Directory is enabled.

kube_config = None

A kube_config block as defined below.

  • clientCertificate (str) - Base64 encoded public certificate used by clients to authenticate to the Kubernetes cluster.

  • clientKey (str) - Base64 encoded private key used by clients to authenticate to the Kubernetes cluster.

  • clusterCaCertificate (str) - Base64 encoded public CA certificate used as the root of trust for the Kubernetes cluster.

  • host (str) - The Kubernetes cluster server host.

  • password (str) - A password or token used to authenticate to the Kubernetes cluster.

  • username (str) - A username used to authenticate to the Kubernetes cluster.

kube_config_raw = None

Raw Kubernetes config to be used by kubectl and other compatible tools

location = None

The location where the Managed Kubernetes Cluster should be created. Changing this forces a new resource to be created.

name = None

The name of the Managed Kubernetes Cluster to create. Changing this forces a new resource to be created.

node_resource_group = None

The auto-generated Resource Group which contains the resources for this Managed Kubernetes Cluster.

resource_group_name = None

Specifies the Resource Group where the Managed Kubernetes Cluster should exist. Changing this forces a new resource to be created.

service_principal = None

A service_principal block as documented below.

  • client_id (str)

  • client_secret (str)

static get(resource_name, id, opts=None, addon_profile=None, agent_pool_profiles=None, api_server_authorized_ip_ranges=None, dns_prefix=None, enable_pod_security_policy=None, fqdn=None, kube_admin_config=None, kube_admin_config_raw=None, kube_config=None, kube_config_raw=None, kubernetes_version=None, linux_profile=None, location=None, name=None, network_profile=None, node_resource_group=None, resource_group_name=None, role_based_access_control=None, service_principal=None, tags=None, windows_profile=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • agent_pool_profiles (pulumi.Input[list]) – One or more agent_pool_profile blocks as defined below.

  • dns_prefix (pulumi.Input[str]) – DNS prefix specified when creating the managed cluster. Changing this forces a new resource to be created.

  • fqdn (pulumi.Input[str]) – The FQDN of the Azure Kubernetes Managed Cluster.

  • kube_admin_config (pulumi.Input[dict]) – A kube_admin_config block as defined below. This is only available when Role Based Access Control with Azure Active Directory is enabled.

  • kube_admin_config_raw (pulumi.Input[str]) –

    Raw Kubernetes config for the admin account to be used by kubectl and other compatible tools. This is only available when Role Based Access Control with Azure Active Directory is enabled.

  • kube_config (pulumi.Input[dict]) – A kube_config block as defined below.

  • kube_config_raw (pulumi.Input[str]) –

    Raw Kubernetes config to be used by kubectl and other compatible tools

  • location (pulumi.Input[str]) – The location where the Managed Kubernetes Cluster should be created. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – The name of the Managed Kubernetes Cluster to create. Changing this forces a new resource to be created.

  • node_resource_group (pulumi.Input[str]) – The auto-generated Resource Group which contains the resources for this Managed Kubernetes Cluster.

  • resource_group_name (pulumi.Input[str]) – Specifies the Resource Group where the Managed Kubernetes Cluster should exist. Changing this forces a new resource to be created.

  • service_principal (pulumi.Input[dict]) – A service_principal block as documented below.

The addon_profile object supports the following:

  • aciConnectorLinux (pulumi.Input[dict])

    • enabled (pulumi.Input[bool])

    • subnetName (pulumi.Input[str])

  • httpApplicationRouting (pulumi.Input[dict]) - A http_application_routing block as defined below.

    • enabled (pulumi.Input[bool])

    • httpApplicationRoutingZoneName (pulumi.Input[str]) - The Zone Name of the HTTP Application Routing.

  • kubeDashboard (pulumi.Input[dict])

    • enabled (pulumi.Input[bool])

  • omsAgent (pulumi.Input[dict])

    • enabled (pulumi.Input[bool])

    • logAnalyticsWorkspaceId (pulumi.Input[str])

The agent_pool_profiles object supports the following:

  • availabilityZones (pulumi.Input[list])

  • count (pulumi.Input[float])

  • dns_prefix (pulumi.Input[str]) - DNS prefix specified when creating the managed cluster. Changing this forces a new resource to be created.

  • enableAutoScaling (pulumi.Input[bool])

  • fqdn (pulumi.Input[str]) - The FQDN of the Azure Kubernetes Managed Cluster.

  • maxCount (pulumi.Input[float])

  • maxPods (pulumi.Input[float])

  • minCount (pulumi.Input[float])

  • name (pulumi.Input[str]) - The name of the Managed Kubernetes Cluster to create. Changing this forces a new resource to be created.

  • nodeTaints (pulumi.Input[list])

  • osDiskSizeGb (pulumi.Input[float])

  • os_type (pulumi.Input[str])

  • type (pulumi.Input[str])

  • vm_size (pulumi.Input[str])

  • vnetSubnetId (pulumi.Input[str])

The kube_admin_config object supports the following:

  • clientCertificate (pulumi.Input[str]) - Base64 encoded public certificate used by clients to authenticate to the Kubernetes cluster.

  • clientKey (pulumi.Input[str]) - Base64 encoded private key used by clients to authenticate to the Kubernetes cluster.

  • clusterCaCertificate (pulumi.Input[str]) - Base64 encoded public CA certificate used as the root of trust for the Kubernetes cluster.

  • host (pulumi.Input[str]) - The Kubernetes cluster server host.

  • password (pulumi.Input[str]) - A password or token used to authenticate to the Kubernetes cluster.

  • username (pulumi.Input[str]) - A username used to authenticate to the Kubernetes cluster.

The kube_config object supports the following:

  • clientCertificate (pulumi.Input[str]) - Base64 encoded public certificate used by clients to authenticate to the Kubernetes cluster.

  • clientKey (pulumi.Input[str]) - Base64 encoded private key used by clients to authenticate to the Kubernetes cluster.

  • clusterCaCertificate (pulumi.Input[str]) - Base64 encoded public CA certificate used as the root of trust for the Kubernetes cluster.

  • host (pulumi.Input[str]) - The Kubernetes cluster server host.

  • password (pulumi.Input[str]) - A password or token used to authenticate to the Kubernetes cluster.

  • username (pulumi.Input[str]) - A username used to authenticate to the Kubernetes cluster.

The linux_profile object supports the following:

  • admin_username (pulumi.Input[str])

  • sshKey (pulumi.Input[dict])

    • keyData (pulumi.Input[str])

The network_profile object supports the following:

  • dnsServiceIp (pulumi.Input[str])

  • dockerBridgeCidr (pulumi.Input[str])

  • loadBalancerSku (pulumi.Input[str])

  • networkPlugin (pulumi.Input[str])

  • networkPolicy (pulumi.Input[str])

  • podCidr (pulumi.Input[str])

  • serviceCidr (pulumi.Input[str])

The role_based_access_control object supports the following:

  • azureActiveDirectory (pulumi.Input[dict])

    • clientAppId (pulumi.Input[str])

    • serverAppId (pulumi.Input[str])

    • serverAppSecret (pulumi.Input[str])

    • tenantId (pulumi.Input[str])

  • enabled (pulumi.Input[bool])

The service_principal object supports the following:

  • client_id (pulumi.Input[str])

  • client_secret (pulumi.Input[str])

The windows_profile object supports the following:

  • admin_password (pulumi.Input[str])

  • admin_username (pulumi.Input[str])

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.containerservice.Registry(resource_name, opts=None, admin_enabled=None, georeplication_locations=None, location=None, name=None, network_rule_set=None, resource_group_name=None, sku=None, storage_account=None, storage_account_id=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages an Azure Container Registry.

Note: All arguments including the access key will be stored in the raw state as plain-text. Read more about sensitive data in state.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • admin_enabled (pulumi.Input[bool]) – Specifies whether the admin user is enabled. Defaults to false.

  • georeplication_locations (pulumi.Input[list]) – A list of Azure locations where the container registry should be geo-replicated.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – Specifies the name of the Container Registry. Changing this forces a new resource to be created.

  • network_rule_set (pulumi.Input[dict]) – A network_rule_set block as documented below.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Container Registry. Changing this forces a new resource to be created.

  • sku (pulumi.Input[str]) – The SKU name of the the container registry. Possible values are Classic (which was previously Basic), Basic, Standard and Premium.

  • storage_account_id (pulumi.Input[str]) – The ID of a Storage Account which must be located in the same Azure Region as the Container Registry.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The network_rule_set object supports the following:

  • defaultAction (pulumi.Input[str]) - The behaviour for requests matching no rules. Either Allow or Deny. Defaults to Allow

  • ipRules (pulumi.Input[list]) - One or more ip_rule blocks as defined below.

    • action (pulumi.Input[str]) - The behaviour for requests matching this rule. At this time the only supported value is Allow

    • ipRange (pulumi.Input[str]) - The CIDR block from which requests will match the rule.

  • virtualNetworks (pulumi.Input[list]) - One or more virtual_network blocks as defined below.

    • action (pulumi.Input[str]) - The behaviour for requests matching this rule. At this time the only supported value is Allow

    • subnetId (pulumi.Input[str]) - The subnet id from which requests will match the rule.

The storage_account object supports the following:

  • accessKey (pulumi.Input[str])

  • name (pulumi.Input[str]) - Specifies the name of the Container Registry. Changing this forces a new resource to be created.

admin_enabled = None

Specifies whether the admin user is enabled. Defaults to false.

admin_password = None

The Password associated with the Container Registry Admin account - if the admin account is enabled.

admin_username = None

The Username associated with the Container Registry Admin account - if the admin account is enabled.

georeplication_locations = None

A list of Azure locations where the container registry should be geo-replicated.

location = None

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

login_server = None

The URL that can be used to log into the container registry.

name = None

Specifies the name of the Container Registry. Changing this forces a new resource to be created.

network_rule_set = None

A network_rule_set block as documented below.

  • defaultAction (str) - The behaviour for requests matching no rules. Either Allow or Deny. Defaults to Allow

  • ipRules (list) - One or more ip_rule blocks as defined below.

    • action (str) - The behaviour for requests matching this rule. At this time the only supported value is Allow

    • ipRange (str) - The CIDR block from which requests will match the rule.

  • virtualNetworks (list) - One or more virtual_network blocks as defined below.

    • action (str) - The behaviour for requests matching this rule. At this time the only supported value is Allow

    • subnetId (str) - The subnet id from which requests will match the rule.

resource_group_name = None

The name of the resource group in which to create the Container Registry. Changing this forces a new resource to be created.

sku = None

The SKU name of the the container registry. Possible values are Classic (which was previously Basic), Basic, Standard and Premium.

storage_account_id = None

The ID of a Storage Account which must be located in the same Azure Region as the Container Registry.

tags = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, admin_enabled=None, admin_password=None, admin_username=None, georeplication_locations=None, location=None, login_server=None, name=None, network_rule_set=None, resource_group_name=None, sku=None, storage_account=None, storage_account_id=None, tags=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • admin_enabled (pulumi.Input[bool]) – Specifies whether the admin user is enabled. Defaults to false.

  • admin_password (pulumi.Input[str]) – The Password associated with the Container Registry Admin account - if the admin account is enabled.

  • admin_username (pulumi.Input[str]) – The Username associated with the Container Registry Admin account - if the admin account is enabled.

  • georeplication_locations (pulumi.Input[list]) – A list of Azure locations where the container registry should be geo-replicated.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • login_server (pulumi.Input[str]) – The URL that can be used to log into the container registry.

  • name (pulumi.Input[str]) – Specifies the name of the Container Registry. Changing this forces a new resource to be created.

  • network_rule_set (pulumi.Input[dict]) – A network_rule_set block as documented below.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Container Registry. Changing this forces a new resource to be created.

  • sku (pulumi.Input[str]) – The SKU name of the the container registry. Possible values are Classic (which was previously Basic), Basic, Standard and Premium.

  • storage_account_id (pulumi.Input[str]) – The ID of a Storage Account which must be located in the same Azure Region as the Container Registry.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The network_rule_set object supports the following:

  • defaultAction (pulumi.Input[str]) - The behaviour for requests matching no rules. Either Allow or Deny. Defaults to Allow

  • ipRules (pulumi.Input[list]) - One or more ip_rule blocks as defined below.

    • action (pulumi.Input[str]) - The behaviour for requests matching this rule. At this time the only supported value is Allow

    • ipRange (pulumi.Input[str]) - The CIDR block from which requests will match the rule.

  • virtualNetworks (pulumi.Input[list]) - One or more virtual_network blocks as defined below.

    • action (pulumi.Input[str]) - The behaviour for requests matching this rule. At this time the only supported value is Allow

    • subnetId (pulumi.Input[str]) - The subnet id from which requests will match the rule.

The storage_account object supports the following:

  • accessKey (pulumi.Input[str])

  • name (pulumi.Input[str]) - Specifies the name of the Container Registry. Changing this forces a new resource to be created.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.containerservice.RegistryWebook(resource_name, opts=None, actions=None, custom_headers=None, location=None, name=None, registry_name=None, resource_group_name=None, scope=None, service_uri=None, status=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages an Azure Container Registry Webhook.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • actions (pulumi.Input[list]) – A list of actions that trigger the Webhook to post notifications. At least one action needs to be specified. Valid values are: push, delete, quarantine, chart_push, chart_delete

  • custom_headers (pulumi.Input[dict]) – Custom headers that will be added to the webhook notifications request.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – Specifies the name of the Container Registry Webhook. Changing this forces a new resource to be created.

  • registry_name (pulumi.Input[str]) – The Name of Container registry this Webhook belongs to. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Container Registry Webhook. Changing this forces a new resource to be created.

  • scope (pulumi.Input[str]) – Specifies the scope of repositories that can trigger an event. For example, ‘foo:*’ means events for all tags under repository ‘foo’. ‘foo:bar’ means events for ‘foo:bar’ only. ‘foo’ is equivalent to ‘foo:latest’. Empty means all events.

  • service_uri (pulumi.Input[str]) – Specifies the service URI for the Webhook to post notifications.

  • status (pulumi.Input[str]) – Specifies if this Webhook triggers notifications or not. Valid values: enabled and disabled. Default is enabled.

actions = None

A list of actions that trigger the Webhook to post notifications. At least one action needs to be specified. Valid values are: push, delete, quarantine, chart_push, chart_delete

custom_headers = None

Custom headers that will be added to the webhook notifications request.

location = None

Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

name = None

Specifies the name of the Container Registry Webhook. Changing this forces a new resource to be created.

registry_name = None

The Name of Container registry this Webhook belongs to. Changing this forces a new resource to be created.

resource_group_name = None

The name of the resource group in which to create the Container Registry Webhook. Changing this forces a new resource to be created.

scope = None

Specifies the scope of repositories that can trigger an event. For example, ‘foo:*’ means events for all tags under repository ‘foo’. ‘foo:bar’ means events for ‘foo:bar’ only. ‘foo’ is equivalent to ‘foo:latest’. Empty means all events.

service_uri = None

Specifies the service URI for the Webhook to post notifications.

status = None

Specifies if this Webhook triggers notifications or not. Valid values: enabled and disabled. Default is enabled.

static get(resource_name, id, opts=None, actions=None, custom_headers=None, location=None, name=None, registry_name=None, resource_group_name=None, scope=None, service_uri=None, status=None, tags=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • actions (pulumi.Input[list]) – A list of actions that trigger the Webhook to post notifications. At least one action needs to be specified. Valid values are: push, delete, quarantine, chart_push, chart_delete

  • custom_headers (pulumi.Input[dict]) – Custom headers that will be added to the webhook notifications request.

  • location (pulumi.Input[str]) – Specifies the supported Azure location where the resource exists. Changing this forces a new resource to be created.

  • name (pulumi.Input[str]) – Specifies the name of the Container Registry Webhook. Changing this forces a new resource to be created.

  • registry_name (pulumi.Input[str]) – The Name of Container registry this Webhook belongs to. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – The name of the resource group in which to create the Container Registry Webhook. Changing this forces a new resource to be created.

  • scope (pulumi.Input[str]) – Specifies the scope of repositories that can trigger an event. For example, ‘foo:*’ means events for all tags under repository ‘foo’. ‘foo:bar’ means events for ‘foo:bar’ only. ‘foo’ is equivalent to ‘foo:latest’. Empty means all events.

  • service_uri (pulumi.Input[str]) – Specifies the service URI for the Webhook to post notifications.

  • status (pulumi.Input[str]) – Specifies if this Webhook triggers notifications or not. Valid values: enabled and disabled. Default is enabled.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

class pulumi_azure.containerservice.Service(resource_name, opts=None, agent_pool_profile=None, diagnostics_profile=None, linux_profile=None, location=None, master_profile=None, name=None, orchestration_platform=None, resource_group_name=None, service_principal=None, tags=None, __props__=None, __name__=None, __opts__=None)

Manages an Azure Container Service Instance

NOTE: All arguments including the client secret will be stored in the raw state as plain-text. Read more about sensitive data in state.

DEPRECATED: Azure Container Service (ACS) has been deprecated by Azure in favour of Azure (Managed) Kubernetes Service (AKS). Support for ACS will be removed in the next major version of the AzureRM Provider (2.0) - and we strongly recommend you consider using Azure Kubernetes Service (AKS) for new deployments.

Parameters
  • resource_name (str) – The name of the resource.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • agent_pool_profile (pulumi.Input[dict]) – A Agent Pool Profile’s block as documented below.

  • diagnostics_profile (pulumi.Input[dict]) – A VM Diagnostics Profile block as documented below.

  • linux_profile (pulumi.Input[dict]) – A Linux Profile block as documented below.

  • location (pulumi.Input[str]) – The location where the Container Service instance should be created. Changing this forces a new resource to be created.

  • master_profile (pulumi.Input[dict]) – A Master Profile block as documented below.

  • name (pulumi.Input[str]) – Unique name of the agent pool profile in the context of the subscription and resource group.

  • orchestration_platform (pulumi.Input[str]) – Specifies the Container Orchestration Platform to use. Currently can be either DCOS, Kubernetes or Swarm. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

  • service_principal (pulumi.Input[dict]) – A Service Principal block as documented below.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The agent_pool_profile object supports the following:

  • count (pulumi.Input[float]) - Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.

  • dns_prefix (pulumi.Input[str]) - The DNS Prefix given to Agents in this Agent Pool.

  • fqdn (pulumi.Input[str])

  • name (pulumi.Input[str]) - Unique name of the agent pool profile in the context of the subscription and resource group.

  • vm_size (pulumi.Input[str]) - The VM Size of each of the Agent Pool VM’s (e.g. Standard_F1 / Standard_D2v2).

The diagnostics_profile object supports the following:

  • enabled (pulumi.Input[bool]) - Should VM Diagnostics be enabled for the Container Service VM’s

  • storageUri (pulumi.Input[str])

The linux_profile object supports the following:

  • admin_username (pulumi.Input[str]) - The Admin Username for the Cluster.

  • sshKey (pulumi.Input[dict]) - An SSH Key block as documented below.

    • keyData (pulumi.Input[str]) - The Public SSH Key used to access the cluster.

The master_profile object supports the following:

  • count (pulumi.Input[float]) - Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.

  • dns_prefix (pulumi.Input[str]) - The DNS Prefix given to Agents in this Agent Pool.

  • fqdn (pulumi.Input[str])

The service_principal object supports the following:

  • client_id (pulumi.Input[str]) - The ID for the Service Principal.

  • client_secret (pulumi.Input[str]) - The secret password associated with the service principal.

agent_pool_profile = None

A Agent Pool Profile’s block as documented below.

  • count (float) - Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.

  • dns_prefix (str) - The DNS Prefix given to Agents in this Agent Pool.

  • fqdn (str)

  • name (str) - Unique name of the agent pool profile in the context of the subscription and resource group.

  • vm_size (str) - The VM Size of each of the Agent Pool VM’s (e.g. Standard_F1 / Standard_D2v2).

diagnostics_profile = None

A VM Diagnostics Profile block as documented below.

  • enabled (bool) - Should VM Diagnostics be enabled for the Container Service VM’s

  • storageUri (str)

linux_profile = None

A Linux Profile block as documented below.

  • admin_username (str) - The Admin Username for the Cluster.

  • sshKey (dict) - An SSH Key block as documented below.

    • keyData (str) - The Public SSH Key used to access the cluster.

location = None

The location where the Container Service instance should be created. Changing this forces a new resource to be created.

master_profile = None

A Master Profile block as documented below.

  • count (float) - Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.

  • dns_prefix (str) - The DNS Prefix given to Agents in this Agent Pool.

  • fqdn (str)

name = None

Unique name of the agent pool profile in the context of the subscription and resource group.

orchestration_platform = None

Specifies the Container Orchestration Platform to use. Currently can be either DCOS, Kubernetes or Swarm. Changing this forces a new resource to be created.

resource_group_name = None

Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

service_principal = None

A Service Principal block as documented below.

  • client_id (str) - The ID for the Service Principal.

  • client_secret (str) - The secret password associated with the service principal.

tags = None

A mapping of tags to assign to the resource.

static get(resource_name, id, opts=None, agent_pool_profile=None, diagnostics_profile=None, linux_profile=None, location=None, master_profile=None, name=None, orchestration_platform=None, resource_group_name=None, service_principal=None, tags=None)

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

Parameters
  • resource_name (str) – The unique name of the resulting resource.

  • id (str) – The unique provider ID of the resource to lookup.

  • opts (pulumi.ResourceOptions) – Options for the resource.

  • agent_pool_profile (pulumi.Input[dict]) – A Agent Pool Profile’s block as documented below.

  • diagnostics_profile (pulumi.Input[dict]) – A VM Diagnostics Profile block as documented below.

  • linux_profile (pulumi.Input[dict]) – A Linux Profile block as documented below.

  • location (pulumi.Input[str]) – The location where the Container Service instance should be created. Changing this forces a new resource to be created.

  • master_profile (pulumi.Input[dict]) – A Master Profile block as documented below.

  • name (pulumi.Input[str]) – Unique name of the agent pool profile in the context of the subscription and resource group.

  • orchestration_platform (pulumi.Input[str]) – Specifies the Container Orchestration Platform to use. Currently can be either DCOS, Kubernetes or Swarm. Changing this forces a new resource to be created.

  • resource_group_name (pulumi.Input[str]) – Specifies the resource group where the resource exists. Changing this forces a new resource to be created.

  • service_principal (pulumi.Input[dict]) – A Service Principal block as documented below.

  • tags (pulumi.Input[dict]) – A mapping of tags to assign to the resource.

The agent_pool_profile object supports the following:

  • count (pulumi.Input[float]) - Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.

  • dns_prefix (pulumi.Input[str]) - The DNS Prefix given to Agents in this Agent Pool.

  • fqdn (pulumi.Input[str])

  • name (pulumi.Input[str]) - Unique name of the agent pool profile in the context of the subscription and resource group.

  • vm_size (pulumi.Input[str]) - The VM Size of each of the Agent Pool VM’s (e.g. Standard_F1 / Standard_D2v2).

The diagnostics_profile object supports the following:

  • enabled (pulumi.Input[bool]) - Should VM Diagnostics be enabled for the Container Service VM’s

  • storageUri (pulumi.Input[str])

The linux_profile object supports the following:

  • admin_username (pulumi.Input[str]) - The Admin Username for the Cluster.

  • sshKey (pulumi.Input[dict]) - An SSH Key block as documented below.

    • keyData (pulumi.Input[str]) - The Public SSH Key used to access the cluster.

The master_profile object supports the following:

  • count (pulumi.Input[float]) - Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1.

  • dns_prefix (pulumi.Input[str]) - The DNS Prefix given to Agents in this Agent Pool.

  • fqdn (pulumi.Input[str])

The service_principal object supports the following:

  • client_id (pulumi.Input[str]) - The ID for the Service Principal.

  • client_secret (pulumi.Input[str]) - The secret password associated with the service principal.

translate_output_property(prop)

Provides subclasses of Resource an opportunity to translate names of output properties into a format of their choosing before writing those properties to the resource object.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

translate_input_property(prop)

Provides subclasses of Resource an opportunity to translate names of input properties into a format of their choosing before sending those properties to the Pulumi engine.

Parameters

prop (str) – A property name.

Returns

A potentially transformed property name.

Return type

str

pulumi_azure.containerservice.get_kubernetes_cluster(name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing Managed Kubernetes Cluster (AKS).

Note: All arguments including the client secret will be stored in the raw state as plain-text. Read more about sensitive data in state.

Parameters
  • name (str) – The name of the managed Kubernetes Cluster.

  • resource_group_name (str) – The name of the Resource Group in which the managed Kubernetes Cluster exists.

pulumi_azure.containerservice.get_kubernetes_service_versions(location=None, version_prefix=None, opts=None)

Use this data source to retrieve the version of Kubernetes supported by Azure Kubernetes Service.

Parameters
  • location (str) – Specifies the location in which to query for versions.

  • version_prefix (str) – A prefix filter for the versions of Kubernetes which should be returned; for example 1. will return 1.9 to 1.14, whereas 1.12 will return 1.12.2.

pulumi_azure.containerservice.get_registry(name=None, resource_group_name=None, opts=None)

Use this data source to access information about an existing Container Registry.

Parameters
  • name (str) – The name of the Container Registry.

  • resource_group_name (str) – The Name of the Resource Group where this Container Registry exists.