containerservice

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, 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.

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, os_type=None, resource_group_name=None, restart_policy=None, tags=None, __name__=None, __opts__=None)

Manage 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 is the only acceptable value at this time. Changing this forces a new resource to be created.
  • 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.
  • 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.
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.

diagnostics = None

A diagnostics block as documented below.

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.

image_registry_credentials = None

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

ip_address = None

The IP address allocated to the container group.

ip_address_type = None

Specifies the ip address type of the container. Public is the only acceptable value at this time. Changing this forces a new resource to be created.

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.

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.

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, kubernetes_version=None, linux_profile=None, location=None, name=None, network_profile=None, resource_group_name=None, role_based_access_control=None, service_principal=None, tags=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.
  • addon_profile (pulumi.Input[dict]) – A addon_profile block.
  • agent_pool_profiles (pulumi.Input[list]) – One or more agent_pool_profile blocks as defined below.
  • api_server_authorized_ip_ranges (pulumi.Input[list]) – The IP ranges to whitelist for incoming traffic to the masters.
  • dns_prefix (pulumi.Input[str]) – DNS prefix specified when creating the managed cluster. Changing this forces a new resource to be created.
  • kubernetes_version (pulumi.Input[str]) – Version of Kubernetes specified when creating the AKS managed cluster. If not specified, the latest recommended version will be used at provisioning time (but won’t auto-upgrade).
  • linux_profile (pulumi.Input[dict]) – A linux_profile block.
  • 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.
  • network_profile (pulumi.Input[dict]) – A network_profile block.
  • 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.
  • role_based_access_control (pulumi.Input[dict]) – A role_based_access_control block. 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.
addon_profile = None

A addon_profile block.

agent_pool_profiles = None

One or more agent_pool_profile blocks as defined below.

api_server_authorized_ip_ranges = None

The IP ranges to whitelist for incoming traffic to the masters.

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.

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.

kube_config_raw = None

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

kubernetes_version = None

Version of Kubernetes specified when creating the AKS managed cluster. If not specified, the latest recommended version will be used at provisioning time (but won’t auto-upgrade).

linux_profile = None

A linux_profile block.

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.

network_profile = None

A network_profile block.

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.

role_based_access_control = None

A role_based_access_control block. Changing this forces a new resource to be created.

service_principal = None

A service_principal block as documented below.

tags = None

A mapping of tags to assign to the resource.

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, resource_group_name=None, sku=None, storage_account=None, storage_account_id=None, tags=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.
  • 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.
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.

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.

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, __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.
agent_pool_profile = None

A Agent Pool Profile’s block as documented below.

diagnostics_profile = None

A VM Diagnostics Profile block as documented below.

linux_profile = None

A Linux Profile block as documented below.

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.

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.

tags = None

A mapping of tags to assign to the resource.

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.
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.

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.