1. Docs
  2. Reference
  3. API
  4. @pulumi/azure
  5. containerservice

Module containerservice

This page documents the language specification for the azure package. If you're looking for help working with the inputs, outputs, or functions of azure resources in a Pulumi program, please see the resource documentation for examples and API reference.

Resources

Functions

Others

Resources

Resource Group

class Group extends CustomResource

Manages as an Azure Container Group instance.

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleGroup = new azure.containerservice.Group("exampleGroup", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    ipAddressType: "public",
    dnsNameLabel: "aci-label",
    osType: "Linux",
    container: [
        {
            name: "hello-world",
            image: "microsoft/aci-helloworld:latest",
            cpu: "0.5",
            memory: "1.5",
            ports: [{
                port: 443,
                protocol: "TCP",
            }],
        },
        {
            name: "sidecar",
            image: "microsoft/aci-tutorial-sidecar",
            cpu: "0.5",
            memory: "1.5",
        },
    ],
    tags: {
        environment: "testing",
    },
});

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): obj is Group

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<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<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<GroupIdentity>;

An identity block as defined below.

property imageRegistryCredentials

public imageRegistryCredentials: pulumi.Output<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]: string} | undefined>;

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)

Example Usage

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

const exampleResourceGroup = new azure.core.ResourceGroup("exampleResourceGroup", {location: "West Europe"});
const exampleKubernetesCluster = new azure.containerservice.KubernetesCluster("exampleKubernetesCluster", {
    location: exampleResourceGroup.location,
    resourceGroupName: exampleResourceGroup.name,
    dnsPrefix: "exampleaks1",
    default_node_pool: {
        name: "default",
        nodeCount: 1,
        vmSize: "Standard_D2_v2",
    },
    identity: {
        type: "SystemAssigned",
    },
    tags: {
        Environment: "Production",
    },
});
export const clientCertificate = exampleKubernetesCluster.kubeConfigs.apply(kubeConfigs => kubeConfigs[0].clientCertificate);
export const kubeConfig = exampleKubernetesCluster.kubeConfigRaw;

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): obj is KubernetesCluster

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<KubernetesClusterAddonProfile>;

A addonProfile block as defined below.

property apiServerAuthorizedIpRanges

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

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

property autoScalerProfile

public autoScalerProfile: pulumi.Output<KubernetesClusterAutoScalerProfile>;

A autoScalerProfile block as defined below.

property defaultNodePool

public defaultNodePool: pulumi.Output<KubernetesClusterDefaultNodePool>;

A defaultNodePool block as defined below.

property diskEncryptionSetId

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

The ID of the Disk Encryption Set which should be used for the Nodes and Volumes. More information can be found in the documentation.

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 | undefined>;

Whether Pod Security Policies are enabled. Note that this also requires role based access control to be enabled.

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 identity

public identity: pulumi.Output<KubernetesClusterIdentity | undefined>;

A identity block as defined below. Changing this forces a new resource to be created.

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 kubeAdminConfigs

public kubeAdminConfigs: pulumi.Output<KubernetesClusterKubeAdminConfig[]>;

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

property kubeConfigRaw

public kubeConfigRaw: pulumi.Output<string>;

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

property kubeConfigs

public kubeConfigs: pulumi.Output<KubernetesClusterKubeConfig[]>;

A kubeConfig block as defined below.

property kubeletIdentities

public kubeletIdentities: pulumi.Output<KubernetesClusterKubeletIdentity[]>;

A kubeletIdentity block as defined below.

property kubernetesVersion

public kubernetesVersion: pulumi.Output<string>;

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

property linuxProfile

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

A linuxProfile block as defined below.

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<KubernetesClusterNetworkProfile>;

A networkProfile block as defined below.

property nodeResourceGroup

public nodeResourceGroup: pulumi.Output<string>;

The name of the Resource Group where the Kubernetes Nodes should exist. Changing this forces a new resource to be created.

property privateClusterEnabled

public privateClusterEnabled: pulumi.Output<boolean>;

Should this Kubernetes Cluster have it’s API server only exposed on internal IP addresses? This provides a Private IP Address for the Kubernetes API on the Virtual Network where the Kubernetes Cluster is located. Defaults to false. Changing this forces a new resource to be created.

property privateFqdn

public privateFqdn: pulumi.Output<string>;

The FQDN for the Kubernetes Cluster when private link has been enabled, which is only resolvable inside the Virtual Network used by the Kubernetes Cluster.

property privateLinkEnabled

DEPRECATED Deprecated in favor of `private_cluster_enabled`
public privateLinkEnabled: pulumi.Output<boolean>;

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<KubernetesClusterRoleBasedAccessControl>;
A `roleBasedAccessControl` block. Changing this forces a new resource to be created.

property servicePrincipal

public servicePrincipal: pulumi.Output<KubernetesClusterServicePrincipal | undefined>;
A `servicePrincipal` block as documented below.

property skuTier

public skuTier: pulumi.Output<string | undefined>;
The SKU Tier that should be used for this Kubernetes Cluster. Changing this forces a new resource to be created. Possible values are `Free` and `Paid` (which includes the Uptime SLA). Defaults to `Free`.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;
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.

property windowsProfile

public windowsProfile: pulumi.Output<KubernetesClusterWindowsProfile>;
A `windowsProfile` block as defined below.

Resource KubernetesClusterNodePool

class KubernetesClusterNodePool extends CustomResource

constructor

new KubernetesClusterNodePool(name: string, args: KubernetesClusterNodePoolArgs, opts?: pulumi.CustomResourceOptions)
Create a KubernetesClusterNodePool 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?: KubernetesClusterNodePoolState, opts?: pulumi.CustomResourceOptions): KubernetesClusterNodePool
Get an existing KubernetesClusterNodePool 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): obj is KubernetesClusterNodePool
Returns true if the given object is an instance of KubernetesClusterNodePool. This is designed to work even when multiple copies of the Pulumi SDK have been loaded into the same process.

property availabilityZones

public availabilityZones: pulumi.Output<string[] | undefined>;
A list of Availability Zones where the Nodes in this Node Pool should be created in.

property enableAutoScaling

public enableAutoScaling: pulumi.Output<boolean | undefined>;
Whether to enable [auto-scaler](https://docs.microsoft.com/en-us/azure/aks/cluster-autoscaler). Defaults to `false`.

property enableNodePublicIp

public enableNodePublicIp: pulumi.Output<boolean | undefined>;
Should each node have a Public IP Address? Defaults to `false`.

property evictionPolicy

public evictionPolicy: pulumi.Output<string | undefined>;
The Eviction Policy which should be used for Virtual Machines within the Virtual Machine Scale Set powering this Node Pool. Possible values are `Deallocate` and `Delete`. Changing this forces a new resource to be created.

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 kubernetesClusterId

public kubernetesClusterId: pulumi.Output<string>;
The ID of the Kubernetes Cluster where this Node Pool should exist. Changing this forces a new resource to be created.

property maxCount

public maxCount: pulumi.Output<number | undefined>;
The maximum number of nodes which should exist within this Node Pool. Valid values are between `1` and `100` and must be greater than or equal to `minCount`.

property maxPods

public maxPods: pulumi.Output<number>;
The maximum number of pods that can run on each agent. Changing this forces a new resource to be created.

property minCount

public minCount: pulumi.Output<number | undefined>;
The minimum number of nodes which should exist within this Node Pool. Valid values are between `1` and `100` and must be less than or equal to `maxCount`.

property mode

public mode: pulumi.Output<string | undefined>;
Should this Node Pool be used for System or User resources? Possible values are `System` and `User`. Defaults to `User`.

property name

public name: pulumi.Output<string>;
The name of the Node Pool which should be created within the Kubernetes Cluster. Changing this forces a new resource to be created.

property nodeCount

public nodeCount: pulumi.Output<number>;
The initial number of nodes which should exist within this Node Pool. Valid values are between `1` and `100` and must be a value in the range `minCount` - `maxCount`.

property nodeLabels

public nodeLabels: pulumi.Output<{[key: string]: string} | undefined>;
A map of Kubernetes labels which should be applied to nodes in this Node Pool. Changing this forces a new resource to be created.

property nodeTaints

public nodeTaints: pulumi.Output<string[] | undefined>;
A list of Kubernetes taints which should be applied to nodes in the agent pool (e.g `key=value:NoSchedule`). Changing this forces a new resource to be created.

property orchestratorVersion

public orchestratorVersion: pulumi.Output<string>;
Version of Kubernetes used for the Agents. If not specified, the latest recommended version will be used at provisioning time (but won't auto-upgrade)

property osDiskSizeGb

public osDiskSizeGb: pulumi.Output<number>;
The Agent Operating System disk size in GB. Changing this forces a new resource to be created.

property osType

public osType: pulumi.Output<string | undefined>;
The Operating System which should be used for this Node Pool. Changing this forces a new resource to be created. Possible values are `Linux` and `Windows`. Defaults to `Linux`.

property priority

public priority: pulumi.Output<string | undefined>;
The Priority for Virtual Machines within the Virtual Machine Scale Set that powers this Node Pool. Possible values are `Regular` and `Spot`. Defaults to `Regular`. Changing this forces a new resource to be created.

property spotMaxPrice

public spotMaxPrice: pulumi.Output<number | undefined>;
The maximum price you're willing to pay in USD per Virtual Machine. Valid values are `-1` (the current on-demand price for a Virtual Machine) or a positive value with up to five decimal places. Changing this forces a new resource to be created.

property tags

public tags: pulumi.Output<{[key: string]: string} | undefined>;
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.

property vmSize

public vmSize: pulumi.Output<string>;
The SKU which should be used for the Virtual Machines used in this Node Pool. Changing this forces a new resource to be created.

property vnetSubnetId

public vnetSubnetId: pulumi.Output<string | undefined>;
The ID of the Subnet where this Node Pool should exist.

Resource Registry

class Registry extends CustomResource
Manages an Azure Container Registry. #### Example Usage ```typescript import * as pulumi from "@pulumi/pulumi"; import * as azure from "@pulumi/azure"; const rg = new azure.core.ResourceGroup("rg", {location: "West US"}); const acr = new azure.containerservice.Registry("acr", { resourceGroupName: rg.name, location: rg.location, sku: "Premium", adminEnabled: false, georeplicationLocations: [ "East US", "West Europe", ], }); ```

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): obj is Registry
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<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 container registry. Possible values are `Basic`, `Standard` and `Premium`. `Classic` (which was previously `Basic`) is supported only for existing resources.

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]: string} | undefined>;
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 RegistryWebhook

class RegistryWebhook extends CustomResource
Manages an Azure Container Registry Webhook. #### Example Usage ```typescript import * as pulumi from "@pulumi/pulumi"; import * as azure from "@pulumi/azure"; const rg = new azure.core.ResourceGroup("rg", {location: "West US"}); const acr = new azure.containerservice.Registry("acr", { resourceGroupName: rg.name, location: rg.location, sku: "Standard", adminEnabled: false, }); const webhook = new azure.containerservice.RegistryWebhook("webhook", { resourceGroupName: rg.name, registryName: acr.name, location: rg.location, serviceUri: "https://mywebhookreceiver.example/mytag", status: "enabled", scope: "mytag:*", actions: ["push"], customHeaders: { "Content-Type": "application/json", }, }); ```

constructor

new RegistryWebhook(name: string, args: RegistryWebhookArgs, opts?: pulumi.CustomResourceOptions)
Create a RegistryWebhook 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?: RegistryWebhookState, opts?: pulumi.CustomResourceOptions): RegistryWebhook
Get an existing RegistryWebhook 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): obj is RegistryWebhook
Returns true if the given object is an instance of RegistryWebhook. 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]: string} | undefined>;

property urn

urn: Output<URN>;
urn is the stable logical URN used to distinctly address a resource, both before and after deployments.

Resource RegistryWebook

DEPRECATED azure.containerservice.RegistryWebook has been deprecated in favor of azure.containerservice.RegistryWebhook
class RegistryWebook extends CustomResource
Manages an Azure Container Registry Webhook. #### Example Usage ```typescript import * as pulumi from "@pulumi/pulumi"; import * as azure from "@pulumi/azure"; const rg = new azure.core.ResourceGroup("rg", {location: "West US"}); const acr = new azure.containerservice.Registry("acr", { resourceGroupName: rg.name, location: rg.location, sku: "Standard", adminEnabled: false, }); const webhook = new azure.containerservice.RegistryWebhook("webhook", { resourceGroupName: rg.name, registryName: acr.name, location: rg.location, serviceUri: "https://mywebhookreceiver.example/mytag", status: "enabled", scope: "mytag:*", actions: ["push"], customHeaders: { "Content-Type": "application/json", }, }); ```

constructor

DEPRECATED azure.containerservice.RegistryWebook has been deprecated in favor of azure.containerservice.RegistryWebhook

DEPRECATED azure.containerservice.RegistryWebook has been deprecated in favor of azure.containerservice.RegistryWebhook
new RegistryWebook(name: string, args: RegistryWebookArgs, opts?: pulumi.CustomResourceOptions)

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): obj is RegistryWebook

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]: string} | undefined>;

property urn

urn: Output<URN>;

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

Functions

Function getClusterNodePool

getClusterNodePool(args: GetClusterNodePoolArgs, opts?: pulumi.InvokeOptions): Promise<GetClusterNodePoolResult>

Use this data source to access information about an existing Kubernetes Cluster Node Pool.

Example Usage

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

const example = azure.containerservice.getClusterNodePool({
    name: "existing",
    kubernetesClusterName: "existing-cluster",
    resourceGroupName: "existing-resource-group",
});
export const id = example.then(example => example.id);

Function getKubernetesCluster

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

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

Example Usage

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

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

Function getKubernetesServiceVersions

getKubernetesServiceVersions(args: GetKubernetesServiceVersionsArgs, opts?: pulumi.InvokeOptions): Promise<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.then(current => current.versions);
export const latestVersion = current.then(current => current.latestVersion);

Function getRegistry

getRegistry(args: GetRegistryArgs, opts?: pulumi.InvokeOptions): Promise<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 example = azure.containerservice.getRegistry({
    name: "testacr",
    resourceGroupName: "test",
});
export const loginServer = example.then(example => example.loginServer);

Others

interface GetClusterNodePoolArgs

interface GetClusterNodePoolArgs

A collection of arguments for invoking getClusterNodePool.

property kubernetesClusterName

kubernetesClusterName: string;

The Name of the Kubernetes Cluster where this Node Pool is located.

property name

name: string;

The name of this Kubernetes Cluster Node Pool.

property resourceGroupName

resourceGroupName: string;

The name of the Resource Group where the Kubernetes Cluster exists.

interface GetClusterNodePoolResult

interface GetClusterNodePoolResult

A collection of values returned by getClusterNodePool.

property availabilityZones

availabilityZones: string[];

A list of Availability Zones in which the Nodes in this Node Pool exists.

property enableAutoScaling

enableAutoScaling: boolean;

Does this Node Pool have Auto-Scaling enabled?

property enableNodePublicIp

enableNodePublicIp: boolean;

Do nodes in this Node Pool have a Public IP Address?

property evictionPolicy

evictionPolicy: string;

The eviction policy used for Virtual Machines in the Virtual Machine Scale Set, when priority is set to Spot.

property id

id: string;

The provider-assigned unique ID for this managed resource.

property kubernetesClusterName

kubernetesClusterName: string;

property maxCount

maxCount: number;

The maximum number of Nodes allowed when auto-scaling is enabled.

property maxPods

maxPods: number;

The maximum number of Pods allowed on each Node in this Node Pool.

property minCount

minCount: number;

The minimum number of Nodes allowed when auto-scaling is enabled.

property mode

mode: string;

The Mode for this Node Pool, specifying how these Nodes should be used (for either System or User resources).

property name

name: string;

property nodeCount

nodeCount: number;

The current number of Nodes in the Node Pool.

property nodeLabels

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

A map of Kubernetes Labels applied to each Node in this Node Pool.

property nodeTaints

nodeTaints: string[];

A map of Kubernetes Taints applied to each Node in this Node Pool.

property orchestratorVersion

orchestratorVersion: string;

The version of Kubernetes configured on each Node in this Node Pool.

property osDiskSizeGb

osDiskSizeGb: number;

The size of the OS Disk on each Node in this Node Pool.

property osType

osType: string;

The operating system used on each Node in this Node Pool.

property priority

priority: string;

The priority of the Virtual Machines in the Virtual Machine Scale Set backing this Node Pool.

property resourceGroupName

resourceGroupName: string;

property spotMaxPrice

spotMaxPrice: number;

The maximum price being paid for Virtual Machines in this Scale Set. -1 means the current on-demand price for a Virtual Machine.

property tags

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

A mapping of tags assigned to the Kubernetes Cluster Node Pool.

property vmSize

vmSize: string;

The size of the Virtual Machines used in the Virtual Machine Scale Set backing this Node Pool.

property vnetSubnetId

vnetSubnetId: string;

The ID of the Subnet in which this Node Pool exists.

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: GetKubernetesClusterAddonProfile[];

A addonProfile block as documented below.

property agentPoolProfiles

agentPoolProfiles: GetKubernetesClusterAgentPoolProfile[];

An agentPoolProfile block as documented below.

property apiServerAuthorizedIpRanges

apiServerAuthorizedIpRanges: string[];

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

property diskEncryptionSetId

diskEncryptionSetId: string;

The ID of the Disk Encryption Set used for the Nodes and Volumes.

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;

The provider-assigned unique ID for this managed resource.

property identities

identities: GetKubernetesClusterIdentity[];

A identity block as documented below.

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: 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: GetKubernetesClusterKubeConfig[];

A kubeConfig block as defined below.

property kubeletIdentities

kubeletIdentities: GetKubernetesClusterKubeletIdentity[];

A kubeletIdentity block as documented below.

property kubernetesVersion

kubernetesVersion: string;

The version of Kubernetes used on the managed Kubernetes Cluster.

property linuxProfiles

linuxProfiles: 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: GetKubernetesClusterNetworkProfile[];

A networkProfile block as documented below.

property nodeResourceGroup

nodeResourceGroup: string;

Auto-generated Resource Group containing AKS Cluster resources.

property privateClusterEnabled

privateClusterEnabled: boolean;

If the cluster has the Kubernetes API only exposed on internal IP addresses.

property privateFqdn

privateFqdn: string;

The FQDN of this Kubernetes Cluster when private link has been enabled. This name is only resolvable inside the Virtual Network where the Azure Kubernetes Service is located

property privateLinkEnabled

DEPRECATED Deprecated in favor of private_cluster_enabled
privateLinkEnabled: boolean;

property resourceGroupName

resourceGroupName: string;

property roleBasedAccessControls

roleBasedAccessControls: GetKubernetesClusterRoleBasedAccessControl[];

A roleBasedAccessControl block as documented below.

property servicePrincipals

servicePrincipals: GetKubernetesClusterServicePrincipal[];

A servicePrincipal block as documented below.

property tags

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

A mapping of tags to assign to the resource.

property windowsProfiles

windowsProfiles: GetKubernetesClusterWindowsProfile[];

A windowsProfile block as documented below.

interface GetKubernetesServiceVersionsArgs

interface GetKubernetesServiceVersionsArgs

A collection of arguments for invoking getKubernetesServiceVersions.

property includePreview

includePreview?: undefined | false | true;

Should Preview versions of Kubernetes in AKS be included? Defaults to true

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;

The provider-assigned unique ID for this managed resource.

property includePreview

includePreview?: undefined | false | true;

property latestVersion

latestVersion: string;

The most recent version available. If includePreview == false, this is the most recent non-preview 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;

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<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<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<GroupIdentity>;

An identity block as defined below.

property imageRegistryCredentials

imageRegistryCredentials?: pulumi.Input<pulumi.Input<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]: pulumi.Input<string>}>;

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<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<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<GroupIdentity>;

An identity block as defined below.

property imageRegistryCredentials

imageRegistryCredentials?: pulumi.Input<pulumi.Input<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]: pulumi.Input<string>}>;

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<KubernetesClusterAddonProfile>;

A addonProfile block as defined below.

property apiServerAuthorizedIpRanges

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

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

property autoScalerProfile

autoScalerProfile?: pulumi.Input<KubernetesClusterAutoScalerProfile>;

A autoScalerProfile block as defined below.

property defaultNodePool

defaultNodePool: pulumi.Input<KubernetesClusterDefaultNodePool>;

A defaultNodePool block as defined below.

property diskEncryptionSetId

diskEncryptionSetId?: pulumi.Input<string>;

The ID of the Disk Encryption Set which should be used for the Nodes and Volumes. More information can be found in the documentation.

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

Whether Pod Security Policies are enabled. Note that this also requires role based access control to be enabled.

property identity

identity?: pulumi.Input<KubernetesClusterIdentity>;

A identity block as defined below. Changing this forces a new resource to be created.

property kubernetesVersion

kubernetesVersion?: pulumi.Input<string>;

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

property linuxProfile

linuxProfile?: pulumi.Input<KubernetesClusterLinuxProfile>;

A linuxProfile block as defined below.

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<KubernetesClusterNetworkProfile>;

A networkProfile block as defined below.

property nodeResourceGroup

nodeResourceGroup?: pulumi.Input<string>;

The name of the Resource Group where the Kubernetes Nodes should exist. Changing this forces a new resource to be created.

property privateClusterEnabled

privateClusterEnabled?: pulumi.Input<boolean>;

Should this Kubernetes Cluster have it’s API server only exposed on internal IP addresses? This provides a Private IP Address for the Kubernetes API on the Virtual Network where the Kubernetes Cluster is located. Defaults to false. Changing this forces a new resource to be created.

property privateLinkEnabled

DEPRECATED Deprecated in favor of private_cluster_enabled
privateLinkEnabled?: pulumi.Input<boolean>;

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<KubernetesClusterRoleBasedAccessControl>;

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

property servicePrincipal

servicePrincipal?: pulumi.Input<KubernetesClusterServicePrincipal>;

A servicePrincipal block as documented below.

property skuTier

skuTier?: pulumi.Input<string>;

The SKU Tier that should be used for this Kubernetes Cluster. Changing this forces a new resource to be created. Possible values are Free and Paid (which includes the Uptime SLA). Defaults to Free.

property tags

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

A mapping of tags to assign to the resource.

property windowsProfile

windowsProfile?: pulumi.Input<KubernetesClusterWindowsProfile>;

A windowsProfile block as defined below.

interface KubernetesClusterNodePoolArgs

interface KubernetesClusterNodePoolArgs

The set of arguments for constructing a KubernetesClusterNodePool resource.

property availabilityZones

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

A list of Availability Zones where the Nodes in this Node Pool should be created in.

property enableAutoScaling

enableAutoScaling?: pulumi.Input<boolean>;

Whether to enable auto-scaler. Defaults to false.

property enableNodePublicIp

enableNodePublicIp?: pulumi.Input<boolean>;

Should each node have a Public IP Address? Defaults to false.

property evictionPolicy

evictionPolicy?: pulumi.Input<string>;

The Eviction Policy which should be used for Virtual Machines within the Virtual Machine Scale Set powering this Node Pool. Possible values are Deallocate and Delete. Changing this forces a new resource to be created.

property kubernetesClusterId

kubernetesClusterId: pulumi.Input<string>;

The ID of the Kubernetes Cluster where this Node Pool should exist. Changing this forces a new resource to be created.

property maxCount

maxCount?: pulumi.Input<number>;

The maximum number of nodes which should exist within this Node Pool. Valid values are between 1 and 100 and must be greater than or equal to minCount.

property maxPods

maxPods?: pulumi.Input<number>;

The maximum number of pods that can run on each agent. Changing this forces a new resource to be created.

property minCount

minCount?: pulumi.Input<number>;

The minimum number of nodes which should exist within this Node Pool. Valid values are between 1 and 100 and must be less than or equal to maxCount.

property mode

mode?: pulumi.Input<string>;

Should this Node Pool be used for System or User resources? Possible values are System and User. Defaults to User.

property name

name?: pulumi.Input<string>;

The name of the Node Pool which should be created within the Kubernetes Cluster. Changing this forces a new resource to be created.

property nodeCount

nodeCount?: pulumi.Input<number>;

The initial number of nodes which should exist within this Node Pool. Valid values are between 1 and 100 and must be a value in the range minCount - maxCount.

property nodeLabels

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

A map of Kubernetes labels which should be applied to nodes in this Node Pool. Changing this forces a new resource to be created.

property nodeTaints

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

A list of Kubernetes taints which should be applied to nodes in the agent pool (e.g key=value:NoSchedule). Changing this forces a new resource to be created.

property orchestratorVersion

orchestratorVersion?: pulumi.Input<string>;

Version of Kubernetes used for the Agents. If not specified, the latest recommended version will be used at provisioning time (but won’t auto-upgrade)

property osDiskSizeGb

osDiskSizeGb?: pulumi.Input<number>;

The Agent Operating System disk size in GB. Changing this forces a new resource to be created.

property osType

osType?: pulumi.Input<string>;

The Operating System which should be used for this Node Pool. Changing this forces a new resource to be created. Possible values are Linux and Windows. Defaults to Linux.

property priority

priority?: pulumi.Input<string>;

The Priority for Virtual Machines within the Virtual Machine Scale Set that powers this Node Pool. Possible values are Regular and Spot. Defaults to Regular. Changing this forces a new resource to be created.

property spotMaxPrice

spotMaxPrice?: pulumi.Input<number>;

The maximum price you’re willing to pay in USD per Virtual Machine. Valid values are -1 (the current on-demand price for a Virtual Machine) or a positive value with up to five decimal places. Changing this forces a new resource to be created.

property tags

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

A mapping of tags to assign to the resource.

property vmSize

vmSize: pulumi.Input<string>;

The SKU which should be used for the Virtual Machines used in this Node Pool. Changing this forces a new resource to be created.

property vnetSubnetId

vnetSubnetId?: pulumi.Input<string>;

The ID of the Subnet where this Node Pool should exist.

interface KubernetesClusterNodePoolState

interface KubernetesClusterNodePoolState

Input properties used for looking up and filtering KubernetesClusterNodePool resources.

property availabilityZones

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

A list of Availability Zones where the Nodes in this Node Pool should be created in.

property enableAutoScaling

enableAutoScaling?: pulumi.Input<boolean>;

Whether to enable auto-scaler. Defaults to false.

property enableNodePublicIp

enableNodePublicIp?: pulumi.Input<boolean>;

Should each node have a Public IP Address? Defaults to false.

property evictionPolicy

evictionPolicy?: pulumi.Input<string>;

The Eviction Policy which should be used for Virtual Machines within the Virtual Machine Scale Set powering this Node Pool. Possible values are Deallocate and Delete. Changing this forces a new resource to be created.

property kubernetesClusterId

kubernetesClusterId?: pulumi.Input<string>;

The ID of the Kubernetes Cluster where this Node Pool should exist. Changing this forces a new resource to be created.

property maxCount

maxCount?: pulumi.Input<number>;

The maximum number of nodes which should exist within this Node Pool. Valid values are between 1 and 100 and must be greater than or equal to minCount.

property maxPods

maxPods?: pulumi.Input<number>;

The maximum number of pods that can run on each agent. Changing this forces a new resource to be created.

property minCount

minCount?: pulumi.Input<number>;

The minimum number of nodes which should exist within this Node Pool. Valid values are between 1 and 100 and must be less than or equal to maxCount.

property mode

mode?: pulumi.Input<string>;

Should this Node Pool be used for System or User resources? Possible values are System and User. Defaults to User.

property name

name?: pulumi.Input<string>;

The name of the Node Pool which should be created within the Kubernetes Cluster. Changing this forces a new resource to be created.

property nodeCount

nodeCount?: pulumi.Input<number>;

The initial number of nodes which should exist within this Node Pool. Valid values are between 1 and 100 and must be a value in the range minCount - maxCount.

property nodeLabels

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

A map of Kubernetes labels which should be applied to nodes in this Node Pool. Changing this forces a new resource to be created.

property nodeTaints

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

A list of Kubernetes taints which should be applied to nodes in the agent pool (e.g key=value:NoSchedule). Changing this forces a new resource to be created.

property orchestratorVersion

orchestratorVersion?: pulumi.Input<string>;

Version of Kubernetes used for the Agents. If not specified, the latest recommended version will be used at provisioning time (but won’t auto-upgrade)

property osDiskSizeGb

osDiskSizeGb?: pulumi.Input<number>;

The Agent Operating System disk size in GB. Changing this forces a new resource to be created.

property osType

osType?: pulumi.Input<string>;

The Operating System which should be used for this Node Pool. Changing this forces a new resource to be created. Possible values are Linux and Windows. Defaults to Linux.

property priority

priority?: pulumi.Input<string>;

The Priority for Virtual Machines within the Virtual Machine Scale Set that powers this Node Pool. Possible values are Regular and Spot. Defaults to Regular. Changing this forces a new resource to be created.

property spotMaxPrice

spotMaxPrice?: pulumi.Input<number>;

The maximum price you’re willing to pay in USD per Virtual Machine. Valid values are -1 (the current on-demand price for a Virtual Machine) or a positive value with up to five decimal places. Changing this forces a new resource to be created.

property tags

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

A mapping of tags to assign to the resource.

property vmSize

vmSize?: pulumi.Input<string>;

The SKU which should be used for the Virtual Machines used in this Node Pool. Changing this forces a new resource to be created.

property vnetSubnetId

vnetSubnetId?: pulumi.Input<string>;

The ID of the Subnet where this Node Pool should exist.

interface KubernetesClusterState

interface KubernetesClusterState

Input properties used for looking up and filtering KubernetesCluster resources.

property addonProfile

addonProfile?: pulumi.Input<KubernetesClusterAddonProfile>;

A addonProfile block as defined below.

property apiServerAuthorizedIpRanges

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

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

property autoScalerProfile

autoScalerProfile?: pulumi.Input<KubernetesClusterAutoScalerProfile>;

A autoScalerProfile block as defined below.

property defaultNodePool

defaultNodePool?: pulumi.Input<KubernetesClusterDefaultNodePool>;

A defaultNodePool block as defined below.

property diskEncryptionSetId

diskEncryptionSetId?: pulumi.Input<string>;

The ID of the Disk Encryption Set which should be used for the Nodes and Volumes. More information can be found in the documentation.

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

Whether Pod Security Policies are enabled. Note that this also requires role based access control to be enabled.

property fqdn

fqdn?: pulumi.Input<string>;

The FQDN of the Azure Kubernetes Managed Cluster.

property identity

identity?: pulumi.Input<KubernetesClusterIdentity>;

A identity block as defined below. Changing this forces a new resource to be created.

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 kubeAdminConfigs

kubeAdminConfigs?: pulumi.Input<pulumi.Input<KubernetesClusterKubeAdminConfig>[]>;

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

property kubeConfigRaw

kubeConfigRaw?: pulumi.Input<string>;

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

property kubeConfigs

kubeConfigs?: pulumi.Input<pulumi.Input<KubernetesClusterKubeConfig>[]>;

A kubeConfig block as defined below.

property kubeletIdentities

kubeletIdentities?: pulumi.Input<pulumi.Input<KubernetesClusterKubeletIdentity>[]>;

A kubeletIdentity block as defined below.

property kubernetesVersion

kubernetesVersion?: pulumi.Input<string>;

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

property linuxProfile

linuxProfile?: pulumi.Input<KubernetesClusterLinuxProfile>;

A linuxProfile block as defined below.

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<KubernetesClusterNetworkProfile>;

A networkProfile block as defined below.

property nodeResourceGroup

nodeResourceGroup?: pulumi.Input<string>;

The name of the Resource Group where the Kubernetes Nodes should exist. Changing this forces a new resource to be created.

property privateClusterEnabled

privateClusterEnabled?: pulumi.Input<boolean>;

Should this Kubernetes Cluster have it’s API server only exposed on internal IP addresses? This provides a Private IP Address for the Kubernetes API on the Virtual Network where the Kubernetes Cluster is located. Defaults to false. Changing this forces a new resource to be created.

property privateFqdn

privateFqdn?: pulumi.Input<string>;

The FQDN for the Kubernetes Cluster when private link has been enabled, which is only resolvable inside the Virtual Network used by the Kubernetes Cluster.

property privateLinkEnabled

DEPRECATED Deprecated in favor of private_cluster_enabled
privateLinkEnabled?: pulumi.Input<boolean>;

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<KubernetesClusterRoleBasedAccessControl>;

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

property servicePrincipal

servicePrincipal?: pulumi.Input<KubernetesClusterServicePrincipal>;

A servicePrincipal block as documented below.

property skuTier

skuTier?: pulumi.Input<string>;

The SKU Tier that should be used for this Kubernetes Cluster. Changing this forces a new resource to be created. Possible values are Free and Paid (which includes the Uptime SLA). Defaults to Free.

property tags

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

A mapping of tags to assign to the resource.

property windowsProfile

windowsProfile?: pulumi.Input<KubernetesClusterWindowsProfile>;

A windowsProfile block as defined below.

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<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 container registry. Possible values are Basic, Standard and Premium. Classic (which was previously Basic) is supported only for existing resources.

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]: pulumi.Input<string>}>;

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<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 container registry. Possible values are Basic, Standard and Premium. Classic (which was previously Basic) is supported only for existing resources.

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]: pulumi.Input<string>}>;

A mapping of tags to assign to the resource.

interface RegistryWebhookArgs

interface RegistryWebhookArgs

The set of arguments for constructing a RegistryWebhook 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]: pulumi.Input<string>}>;

interface RegistryWebhookState

interface RegistryWebhookState

Input properties used for looking up and filtering RegistryWebhook 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]: pulumi.Input<string>}>;

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]: pulumi.Input<string>}>;

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]: pulumi.Input<string>}>;