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

Resources

Data Sources

Others

Resources

Resource Group

class Group extends CustomResource

This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/container_group.html.markdown.

constructor

new Group(name: string, args: GroupArgs, opts?: pulumi.CustomResourceOptions)

Create a Group resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: GroupState, opts?: pulumi.CustomResourceOptions): Group

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of Group. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property containers

public containers: pulumi.Output<outputs.containerservice.GroupContainer[]>;

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.

property diagnostics

public diagnostics: pulumi.Output<outputs.containerservice.GroupDiagnostics | undefined>;

A diagnostics block as documented below.

property dnsNameLabel

public dnsNameLabel: pulumi.Output<string | undefined>;

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

property fqdn

public fqdn: pulumi.Output<string>;

The FQDN of the container group derived from dnsNameLabel.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property identity

public identity: pulumi.Output<outputs.containerservice.GroupIdentity>;

An identity block as defined below.

property imageRegistryCredentials

public imageRegistryCredentials: pulumi.Output<outputs.containerservice.GroupImageRegistryCredential[] | undefined>;

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

property ipAddress

public ipAddress: pulumi.Output<string>;

The IP address allocated to the container group.

property ipAddressType

public ipAddressType: pulumi.Output<string | undefined>;

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

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property networkProfileId

public networkProfileId: pulumi.Output<string | undefined>;

Network profile ID for deploying to virtual network.

property osType

public osType: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property restartPolicy

public restartPolicy: pulumi.Output<string | undefined>;

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

property tags

public tags: pulumi.Output<{[key: string]: any}>;

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

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource KubernetesCluster

class KubernetesCluster extends CustomResource

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.

This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/kubernetes_cluster.html.markdown.

constructor

new KubernetesCluster(name: string, args: KubernetesClusterArgs, opts?: pulumi.CustomResourceOptions)

Create a KubernetesCluster resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: KubernetesClusterState, opts?: pulumi.CustomResourceOptions): KubernetesCluster

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of KubernetesCluster. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property addonProfile

public addonProfile: pulumi.Output<outputs.containerservice.KubernetesClusterAddonProfile>;

property agentPoolProfiles

public agentPoolProfiles: pulumi.Output<outputs.containerservice.KubernetesClusterAgentPoolProfile[]>;

One or more agentPoolProfile blocks as defined below.

property apiServerAuthorizedIpRanges

public apiServerAuthorizedIpRanges: pulumi.Output<string[] | undefined>;

property dnsPrefix

public dnsPrefix: pulumi.Output<string>;

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

property enablePodSecurityPolicy

public enablePodSecurityPolicy: pulumi.Output<boolean>;

property fqdn

public fqdn: pulumi.Output<string>;

The FQDN of the Azure Kubernetes Managed Cluster.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property kubeAdminConfig

public kubeAdminConfig: pulumi.Output<outputs.containerservice.KubernetesClusterKubeAdminConfig>;

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

property kubeAdminConfigRaw

public kubeAdminConfigRaw: pulumi.Output<string>;

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.

property kubeConfig

public kubeConfig: pulumi.Output<outputs.containerservice.KubernetesClusterKubeConfig>;

A kubeConfig block as defined below.

property kubeConfigRaw

public kubeConfigRaw: pulumi.Output<string>;

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

property kubernetesVersion

public kubernetesVersion: pulumi.Output<string>;

property linuxProfile

public linuxProfile: pulumi.Output<outputs.containerservice.KubernetesClusterLinuxProfile | undefined>;

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property networkProfile

public networkProfile: pulumi.Output<outputs.containerservice.KubernetesClusterNetworkProfile>;

property nodeResourceGroup

public nodeResourceGroup: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property roleBasedAccessControl

public roleBasedAccessControl: pulumi.Output<outputs.containerservice.KubernetesClusterRoleBasedAccessControl>;

property servicePrincipal

public servicePrincipal: pulumi.Output<outputs.containerservice.KubernetesClusterServicePrincipal>;

A servicePrincipal block as documented below.

property tags

public tags: pulumi.Output<{[key: string]: any}>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

property windowsProfile

public windowsProfile: pulumi.Output<outputs.containerservice.KubernetesClusterWindowsProfile | undefined>;

Resource Registry

class Registry extends CustomResource

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.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const rg = new azure.core.ResourceGroup("rg", {
    location: "West US",
    name: "resourceGroup1",
});
const acr = new azure.containerservice.Registry("acr", {
    adminEnabled: false,
    georeplicationLocations: [
        "East US",
        "West Europe",
    ],
    location: rg.location,
    name: "containerRegistry1",
    resourceGroupName: rg.name,
    sku: "Premium",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/container_registry.html.markdown.

constructor

new Registry(name: string, args: RegistryArgs, opts?: pulumi.CustomResourceOptions)

Create a Registry resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RegistryState, opts?: pulumi.CustomResourceOptions): Registry

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of Registry. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property adminEnabled

public adminEnabled: pulumi.Output<boolean | undefined>;

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

property adminPassword

public adminPassword: pulumi.Output<string>;

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

property adminUsername

public adminUsername: pulumi.Output<string>;

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

property georeplicationLocations

public georeplicationLocations: pulumi.Output<string[] | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

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

property loginServer

public loginServer: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property networkRuleSet

public networkRuleSet: pulumi.Output<outputs.containerservice.RegistryNetworkRuleSet>;

A networkRuleSet block as documented below.

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property sku

public sku: pulumi.Output<string | undefined>;

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

property storageAccount

public storageAccount: pulumi.Output<outputs.containerservice.RegistryStorageAccount | undefined>;

property storageAccountId

public storageAccountId: pulumi.Output<string | undefined>;

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

property tags

public tags: pulumi.Output<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource RegistryWebook

class RegistryWebook extends CustomResource

Manages an Azure Container Registry Webhook.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const rg = new azure.core.ResourceGroup("rg", {
    location: "West US",
    name: "resourceGroup1",
});
const acr = new azure.containerservice.Registry("acr", {
    adminEnabled: false,
    location: rg.location,
    name: "containerRegistry1",
    resourceGroupName: rg.name,
    sku: "Standard",
});
const webhook = new azure.containerservice.RegistryWebook("webhook", {
    actions: ["push"],
    customHeaders: {
        "Content-Type": "application/json",
    },
    location: rg.location,
    name: "mywebhook",
    registryName: acr.name,
    resourceGroupName: rg.name,
    scope: "mytag:*",
    serviceUri: "https://mywebhookreceiver.example/mytag",
    status: "enabled",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/container_registry_webhook.html.markdown.

constructor

new RegistryWebook(name: string, args: RegistryWebookArgs, opts?: pulumi.CustomResourceOptions)

Create a RegistryWebook resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: RegistryWebookState, opts?: pulumi.CustomResourceOptions): RegistryWebook

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of RegistryWebook. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property actions

public actions: pulumi.Output<string[]>;

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, chartPush, chartDelete

property customHeaders

public customHeaders: pulumi.Output<{[key: string]: string} | undefined>;

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

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property location

public location: pulumi.Output<string>;

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

property name

public name: pulumi.Output<string>;

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

property registryName

public registryName: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property scope

public scope: pulumi.Output<string | undefined>;

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.

property serviceUri

public serviceUri: pulumi.Output<string>;

Specifies the service URI for the Webhook to post notifications.

property status

public status: pulumi.Output<string | undefined>;

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

property tags

public tags: pulumi.Output<{[key: string]: any}>;

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource Service

class Service extends CustomResource

This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/r/container_service.html.markdown.

constructor

new Service(name: string, args: ServiceArgs, opts?: pulumi.CustomResourceOptions)

Create a Service resource with the given unique name, arguments, and options.

  • name The unique name of the resource.
  • args The arguments to use to populate this resource's properties.
  • opts A bag of options that control this resource's behavior.

method get

public static get(name: string, id: pulumi.Input<pulumi.ID>, state?: ServiceState, opts?: pulumi.CustomResourceOptions): Service

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

method getProvider

getProvider(moduleMember: string): ProviderResource | undefined

method isInstance

public static isInstance(obj: any): boolean

Returns true if the given object is an instance of Service. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property agentPoolProfile

public agentPoolProfile: pulumi.Output<outputs.containerservice.ServiceAgentPoolProfile>;

A Agent Pool Profile’s block as documented below.

property diagnosticsProfile

public diagnosticsProfile: pulumi.Output<outputs.containerservice.ServiceDiagnosticsProfile>;

A VM Diagnostics Profile block as documented below.

property id

id: Output<ID>;

id is the provider-assigned unique ID for this managed resource. It is set during deployments and may be missing (undefined) during planning phases.

property linuxProfile

public linuxProfile: pulumi.Output<outputs.containerservice.ServiceLinuxProfile>;

A Linux Profile block as documented below.

property location

public location: pulumi.Output<string>;

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

property masterProfile

public masterProfile: pulumi.Output<outputs.containerservice.ServiceMasterProfile>;

A Master Profile block as documented below.

property name

public name: pulumi.Output<string>;

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

property orchestrationPlatform

public orchestrationPlatform: pulumi.Output<string>;

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

property resourceGroupName

public resourceGroupName: pulumi.Output<string>;

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

property servicePrincipal

public servicePrincipal: pulumi.Output<outputs.containerservice.ServiceServicePrincipal | undefined>;

A Service Principal block as documented below.

property tags

public tags: pulumi.Output<{[key: string]: any}>;

A mapping of tags to assign to the resource.

property urn

urn: Output<URN>;

urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Data Sources

Data Source getKubernetesCluster

getKubernetesCluster(args: GetKubernetesClusterArgs, opts?: pulumi.InvokeOptions): Promise<GetKubernetesClusterResult> & GetKubernetesClusterResult

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.

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const test = azure.containerservice.getKubernetesCluster({
    name: "myakscluster",
    resourceGroupName: "my-example-resource-group",
});

This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/d/kubernetes_cluster.html.markdown.

Data Source getKubernetesServiceVersions

getKubernetesServiceVersions(args: GetKubernetesServiceVersionsArgs, opts?: pulumi.InvokeOptions): Promise<GetKubernetesServiceVersionsResult> & GetKubernetesServiceVersionsResult

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const current = azure.containerservice.getKubernetesServiceVersions({
    location: "West Europe",
});

export const versions = current.versions;
export const latestVersion = current.latestVersion;

This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/d/kubernetes_service_versions.html.markdown.

Data Source getRegistry

getRegistry(args: GetRegistryArgs, opts?: pulumi.InvokeOptions): Promise<GetRegistryResult> & GetRegistryResult

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

Example Usage

import * as pulumi from "@pulumi/pulumi";
import * as azure from "@pulumi/azure";

const test = azure.containerservice.getRegistry({
    name: "testacr",
    resourceGroupName: "test",
});

export const loginServer = test.loginServer;

This content is derived from https://github.com/terraform-providers/terraform-provider-azurerm/blob/master/website/docs/d/container_registry.html.markdown.

Others

interface GetKubernetesClusterArgs

interface GetKubernetesClusterArgs

A collection of arguments for invoking getKubernetesCluster.

property name

name: string;

The name of the managed Kubernetes Cluster.

property resourceGroupName

resourceGroupName: string;

The name of the Resource Group in which the managed Kubernetes Cluster exists.

interface GetKubernetesClusterResult

interface GetKubernetesClusterResult

A collection of values returned by getKubernetesCluster.

property addonProfiles

addonProfiles: outputs.containerservice.GetKubernetesClusterAddonProfile[];

A addonProfile block as documented below.

property agentPoolProfiles

agentPoolProfiles: outputs.containerservice.GetKubernetesClusterAgentPoolProfile[];

An agentPoolProfile block as documented below.

property dnsPrefix

dnsPrefix: string;

The DNS Prefix of the managed Kubernetes cluster.

property fqdn

fqdn: string;

The FQDN of the Azure Kubernetes Managed Cluster.

property id

id: string;

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

property kubeAdminConfigRaw

kubeAdminConfigRaw: string;

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.

property kubeAdminConfigs

kubeAdminConfigs: outputs.containerservice.GetKubernetesClusterKubeAdminConfig[];

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

property kubeConfigRaw

kubeConfigRaw: string;

Base64 encoded Kubernetes configuration.

property kubeConfigs

kubeConfigs: outputs.containerservice.GetKubernetesClusterKubeConfig[];

A kubeConfig block as defined below.

property kubernetesVersion

kubernetesVersion: string;

The version of Kubernetes used on the managed Kubernetes Cluster.

property linuxProfiles

linuxProfiles: outputs.containerservice.GetKubernetesClusterLinuxProfile[];

A linuxProfile block as documented below.

property location

location: string;

The Azure Region in which the managed Kubernetes Cluster exists.

property name

name: string;

The name assigned to this pool of agents.

property networkProfiles

networkProfiles: outputs.containerservice.GetKubernetesClusterNetworkProfile[];

A networkProfile block as documented below.

property nodeResourceGroup

nodeResourceGroup: string;

Auto-generated Resource Group containing AKS Cluster resources.

property resourceGroupName

resourceGroupName: string;

property roleBasedAccessControls

roleBasedAccessControls: outputs.containerservice.GetKubernetesClusterRoleBasedAccessControl[];

A roleBasedAccessControl block as documented below.

property servicePrincipals

servicePrincipals: outputs.containerservice.GetKubernetesClusterServicePrincipal[];

A servicePrincipal block as documented below.

property tags

tags: {[key: string]: string};

A mapping of tags assigned to this resource.

property windowsProfiles

windowsProfiles: outputs.containerservice.GetKubernetesClusterWindowsProfile[];

A windowsProfile block as documented below.

interface GetKubernetesServiceVersionsArgs

interface GetKubernetesServiceVersionsArgs

A collection of arguments for invoking getKubernetesServiceVersions.

property location

location: string;

Specifies the location in which to query for versions.

property versionPrefix

versionPrefix?: undefined | string;

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.

interface GetKubernetesServiceVersionsResult

interface GetKubernetesServiceVersionsResult

A collection of values returned by getKubernetesServiceVersions.

property id

id: string;

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

property latestVersion

latestVersion: string;

The most recent version available.

property location

location: string;

property versionPrefix

versionPrefix?: undefined | string;

property versions

versions: string[];

The list of all supported versions.

interface GetRegistryArgs

interface GetRegistryArgs

A collection of arguments for invoking getRegistry.

property name

name: string;

The name of the Container Registry.

property resourceGroupName

resourceGroupName: string;

The Name of the Resource Group where this Container Registry exists.

interface GetRegistryResult

interface GetRegistryResult

A collection of values returned by getRegistry.

property adminEnabled

adminEnabled: boolean;

Is the Administrator account enabled for this Container Registry.

property adminPassword

adminPassword: string;

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

property adminUsername

adminUsername: string;

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

property id

id: string;

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

property location

location: string;

The Azure Region in which this Container Registry exists.

property loginServer

loginServer: string;

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

property name

name: string;

property resourceGroupName

resourceGroupName: string;

property sku

sku: string;

The SKU of this Container Registry, such as Basic.

property storageAccountId

storageAccountId: string;

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

property tags

tags: {[key: string]: string};

A map of tags assigned to the Container Registry.

interface GroupArgs

interface GroupArgs

The set of arguments for constructing a Group resource.

property containers

containers: pulumi.Input<pulumi.Input<inputs.containerservice.GroupContainer>[]>;

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.

property diagnostics

diagnostics?: pulumi.Input<inputs.containerservice.GroupDiagnostics>;

A diagnostics block as documented below.

property dnsNameLabel

dnsNameLabel?: pulumi.Input<string>;

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

property identity

identity?: pulumi.Input<inputs.containerservice.GroupIdentity>;

An identity block as defined below.

property imageRegistryCredentials

imageRegistryCredentials?: pulumi.Input<pulumi.Input<inputs.containerservice.GroupImageRegistryCredential>[]>;

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

property ipAddressType

ipAddressType?: pulumi.Input<string>;

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

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property networkProfileId

networkProfileId?: pulumi.Input<string>;

Network profile ID for deploying to virtual network.

property osType

osType: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property restartPolicy

restartPolicy?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: any}>;

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

interface GroupState

interface GroupState

Input properties used for looking up and filtering Group resources.

property containers

containers?: pulumi.Input<pulumi.Input<inputs.containerservice.GroupContainer>[]>;

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.

property diagnostics

diagnostics?: pulumi.Input<inputs.containerservice.GroupDiagnostics>;

A diagnostics block as documented below.

property dnsNameLabel

dnsNameLabel?: pulumi.Input<string>;

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

property fqdn

fqdn?: pulumi.Input<string>;

The FQDN of the container group derived from dnsNameLabel.

property identity

identity?: pulumi.Input<inputs.containerservice.GroupIdentity>;

An identity block as defined below.

property imageRegistryCredentials

imageRegistryCredentials?: pulumi.Input<pulumi.Input<inputs.containerservice.GroupImageRegistryCredential>[]>;

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

property ipAddress

ipAddress?: pulumi.Input<string>;

The IP address allocated to the container group.

property ipAddressType

ipAddressType?: pulumi.Input<string>;

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

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property networkProfileId

networkProfileId?: pulumi.Input<string>;

Network profile ID for deploying to virtual network.

property osType

osType?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property restartPolicy

restartPolicy?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: any}>;

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

interface KubernetesClusterArgs

interface KubernetesClusterArgs

The set of arguments for constructing a KubernetesCluster resource.

property addonProfile

addonProfile?: pulumi.Input<inputs.containerservice.KubernetesClusterAddonProfile>;

property agentPoolProfiles

agentPoolProfiles: pulumi.Input<pulumi.Input<inputs.containerservice.KubernetesClusterAgentPoolProfile>[]>;

One or more agentPoolProfile blocks as defined below.

property apiServerAuthorizedIpRanges

apiServerAuthorizedIpRanges?: pulumi.Input<pulumi.Input<string>[]>;

property dnsPrefix

dnsPrefix: pulumi.Input<string>;

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

property enablePodSecurityPolicy

enablePodSecurityPolicy?: pulumi.Input<boolean>;

property kubernetesVersion

kubernetesVersion?: pulumi.Input<string>;

property linuxProfile

linuxProfile?: pulumi.Input<inputs.containerservice.KubernetesClusterLinuxProfile>;

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property networkProfile

networkProfile?: pulumi.Input<inputs.containerservice.KubernetesClusterNetworkProfile>;

property nodeResourceGroup

nodeResourceGroup?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property roleBasedAccessControl

roleBasedAccessControl?: pulumi.Input<inputs.containerservice.KubernetesClusterRoleBasedAccessControl>;

property servicePrincipal

servicePrincipal: pulumi.Input<inputs.containerservice.KubernetesClusterServicePrincipal>;

A servicePrincipal block as documented below.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

property windowsProfile

windowsProfile?: pulumi.Input<inputs.containerservice.KubernetesClusterWindowsProfile>;

interface KubernetesClusterState

interface KubernetesClusterState

Input properties used for looking up and filtering KubernetesCluster resources.

property addonProfile

addonProfile?: pulumi.Input<inputs.containerservice.KubernetesClusterAddonProfile>;

property agentPoolProfiles

agentPoolProfiles?: pulumi.Input<pulumi.Input<inputs.containerservice.KubernetesClusterAgentPoolProfile>[]>;

One or more agentPoolProfile blocks as defined below.

property apiServerAuthorizedIpRanges

apiServerAuthorizedIpRanges?: pulumi.Input<pulumi.Input<string>[]>;

property dnsPrefix

dnsPrefix?: pulumi.Input<string>;

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

property enablePodSecurityPolicy

enablePodSecurityPolicy?: pulumi.Input<boolean>;

property fqdn

fqdn?: pulumi.Input<string>;

The FQDN of the Azure Kubernetes Managed Cluster.

property kubeAdminConfig

kubeAdminConfig?: pulumi.Input<inputs.containerservice.KubernetesClusterKubeAdminConfig>;

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

property kubeAdminConfigRaw

kubeAdminConfigRaw?: pulumi.Input<string>;

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.

property kubeConfig

kubeConfig?: pulumi.Input<inputs.containerservice.KubernetesClusterKubeConfig>;

A kubeConfig block as defined below.

property kubeConfigRaw

kubeConfigRaw?: pulumi.Input<string>;

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

property kubernetesVersion

kubernetesVersion?: pulumi.Input<string>;

property linuxProfile

linuxProfile?: pulumi.Input<inputs.containerservice.KubernetesClusterLinuxProfile>;

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property networkProfile

networkProfile?: pulumi.Input<inputs.containerservice.KubernetesClusterNetworkProfile>;

property nodeResourceGroup

nodeResourceGroup?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property roleBasedAccessControl

roleBasedAccessControl?: pulumi.Input<inputs.containerservice.KubernetesClusterRoleBasedAccessControl>;

property servicePrincipal

servicePrincipal?: pulumi.Input<inputs.containerservice.KubernetesClusterServicePrincipal>;

A servicePrincipal block as documented below.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

property windowsProfile

windowsProfile?: pulumi.Input<inputs.containerservice.KubernetesClusterWindowsProfile>;

interface RegistryArgs

interface RegistryArgs

The set of arguments for constructing a Registry resource.

property adminEnabled

adminEnabled?: pulumi.Input<boolean>;

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

property georeplicationLocations

georeplicationLocations?: pulumi.Input<pulumi.Input<string>[]>;

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

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property networkRuleSet

networkRuleSet?: pulumi.Input<inputs.containerservice.RegistryNetworkRuleSet>;

A networkRuleSet block as documented below.

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property sku

sku?: pulumi.Input<string>;

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

property storageAccount

storageAccount?: pulumi.Input<inputs.containerservice.RegistryStorageAccount>;

property storageAccountId

storageAccountId?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

interface RegistryState

interface RegistryState

Input properties used for looking up and filtering Registry resources.

property adminEnabled

adminEnabled?: pulumi.Input<boolean>;

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

property adminPassword

adminPassword?: pulumi.Input<string>;

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

property adminUsername

adminUsername?: pulumi.Input<string>;

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

property georeplicationLocations

georeplicationLocations?: pulumi.Input<pulumi.Input<string>[]>;

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

property location

location?: pulumi.Input<string>;

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

property loginServer

loginServer?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property networkRuleSet

networkRuleSet?: pulumi.Input<inputs.containerservice.RegistryNetworkRuleSet>;

A networkRuleSet block as documented below.

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property sku

sku?: pulumi.Input<string>;

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

property storageAccount

storageAccount?: pulumi.Input<inputs.containerservice.RegistryStorageAccount>;

property storageAccountId

storageAccountId?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

interface RegistryWebookArgs

interface RegistryWebookArgs

The set of arguments for constructing a RegistryWebook resource.

property actions

actions: pulumi.Input<pulumi.Input<string>[]>;

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, chartPush, chartDelete

property customHeaders

customHeaders?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

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

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property registryName

registryName: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property scope

scope?: pulumi.Input<string>;

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.

property serviceUri

serviceUri: pulumi.Input<string>;

Specifies the service URI for the Webhook to post notifications.

property status

status?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: any}>;

interface RegistryWebookState

interface RegistryWebookState

Input properties used for looking up and filtering RegistryWebook resources.

property actions

actions?: pulumi.Input<pulumi.Input<string>[]>;

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, chartPush, chartDelete

property customHeaders

customHeaders?: pulumi.Input<{[key: string]: pulumi.Input<string>}>;

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

property location

location?: pulumi.Input<string>;

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

property name

name?: pulumi.Input<string>;

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

property registryName

registryName?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property scope

scope?: pulumi.Input<string>;

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.

property serviceUri

serviceUri?: pulumi.Input<string>;

Specifies the service URI for the Webhook to post notifications.

property status

status?: pulumi.Input<string>;

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

property tags

tags?: pulumi.Input<{[key: string]: any}>;

interface ServiceArgs

interface ServiceArgs

The set of arguments for constructing a Service resource.

property agentPoolProfile

agentPoolProfile: pulumi.Input<inputs.containerservice.ServiceAgentPoolProfile>;

A Agent Pool Profile’s block as documented below.

property diagnosticsProfile

diagnosticsProfile: pulumi.Input<inputs.containerservice.ServiceDiagnosticsProfile>;

A VM Diagnostics Profile block as documented below.

property linuxProfile

linuxProfile: pulumi.Input<inputs.containerservice.ServiceLinuxProfile>;

A Linux Profile block as documented below.

property location

location?: pulumi.Input<string>;

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

property masterProfile

masterProfile: pulumi.Input<inputs.containerservice.ServiceMasterProfile>;

A Master Profile block as documented below.

property name

name?: pulumi.Input<string>;

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

property orchestrationPlatform

orchestrationPlatform: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName: pulumi.Input<string>;

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

property servicePrincipal

servicePrincipal?: pulumi.Input<inputs.containerservice.ServiceServicePrincipal>;

A Service Principal block as documented below.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.

interface ServiceState

interface ServiceState

Input properties used for looking up and filtering Service resources.

property agentPoolProfile

agentPoolProfile?: pulumi.Input<inputs.containerservice.ServiceAgentPoolProfile>;

A Agent Pool Profile’s block as documented below.

property diagnosticsProfile

diagnosticsProfile?: pulumi.Input<inputs.containerservice.ServiceDiagnosticsProfile>;

A VM Diagnostics Profile block as documented below.

property linuxProfile

linuxProfile?: pulumi.Input<inputs.containerservice.ServiceLinuxProfile>;

A Linux Profile block as documented below.

property location

location?: pulumi.Input<string>;

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

property masterProfile

masterProfile?: pulumi.Input<inputs.containerservice.ServiceMasterProfile>;

A Master Profile block as documented below.

property name

name?: pulumi.Input<string>;

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

property orchestrationPlatform

orchestrationPlatform?: pulumi.Input<string>;

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

property resourceGroupName

resourceGroupName?: pulumi.Input<string>;

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

property servicePrincipal

servicePrincipal?: pulumi.Input<inputs.containerservice.ServiceServicePrincipal>;

A Service Principal block as documented below.

property tags

tags?: pulumi.Input<{[key: string]: any}>;

A mapping of tags to assign to the resource.