Module types/input

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.

namespace analysisservices

namespace apimanagement

namespace appconfiguration

namespace appplatform

namespace appservice

namespace authorization

namespace automation

namespace backup

namespace batch

namespace blueprint

namespace bot

namespace cdn

namespace compute

namespace containerservice

namespace core

namespace cosmosdb

namespace costmanagement

namespace databricks

namespace datafactory

namespace datashare

namespace devtest

namespace dns

namespace eventgrid

namespace eventhub

namespace frontdoor

namespace hdinsight

namespace healthcare

namespace hpc

namespace iot

namespace keyvault

namespace kusto

namespace lb

namespace logicapps

namespace machinelearning

namespace managedapplication

namespace mariadb

namespace mediaservices

namespace monitoring

namespace mssql

namespace mysql

namespace netapp

namespace network

namespace notificationhub

namespace operationalinsights

namespace policy

namespace postgresql

namespace privatedns

namespace privatelink

namespace redis

namespace role

namespace search

namespace servicebus

namespace servicefabric

namespace signalr

namespace siterecovery

namespace sql

namespace storage

namespace streamanalytics

namespace trafficmanager

namespace waf

APIs

namespace analysisservices

interface ServerIpv4FirewallRule

interface ServerIpv4FirewallRule

property name

name: pulumi.Input<string>;

Specifies the name of the firewall rule.

property rangeEnd

rangeEnd: pulumi.Input<string>;

End of the firewall rule range as IPv4 address.

property rangeStart

rangeStart: pulumi.Input<string>;

Start of the firewall rule range as IPv4 address.

namespace apimanagement

interface ApiImport

interface ApiImport

property contentFormat

contentFormat: pulumi.Input<string>;

The format of the content from which the API Definition should be imported. Possible values are: openapi, openapi+json, openapi+json-link, openapi-link, swagger-json, swagger-link-json, wadl-link-json, wadl-xml, wsdl and wsdl-link.

property contentValue

contentValue: pulumi.Input<string>;

The Content from which the API Definition should be imported. When a contentFormat of *-link-* is specified this must be a URL, otherwise this must be defined inline.

property wsdlSelector

wsdlSelector?: pulumi.Input<ApiImportWsdlSelector>;

A wsdlSelector block as defined below, which allows you to limit the import of a WSDL to only a subset of the document. This can only be specified when contentFormat is wsdl or wsdl-link.

interface ApiImportWsdlSelector

interface ApiImportWsdlSelector

property endpointName

endpointName: pulumi.Input<string>;

The name of endpoint (port) to import from WSDL.

property serviceName

serviceName: pulumi.Input<string>;

The name of service to import from WSDL.

interface ApiOperationRequest

interface ApiOperationRequest

property description

description?: pulumi.Input<string>;

A description of the HTTP Request, which may include HTML tags.

property headers

headers?: pulumi.Input<pulumi.Input<ApiOperationRequestHeader>[]>;

One or more header blocks as defined above.

property queryParameters

queryParameters?: pulumi.Input<pulumi.Input<ApiOperationRequestQueryParameter>[]>;

One or more queryParameter blocks as defined above.

property representations

representations?: pulumi.Input<pulumi.Input<ApiOperationRequestRepresentation>[]>;

One or more representation blocks as defined below.

interface ApiOperationRequestHeader

interface ApiOperationRequestHeader

property defaultValue

defaultValue?: pulumi.Input<string>;

The default value for this Header.

property description

description?: pulumi.Input<string>;

A description of this Header.

property name

name: pulumi.Input<string>;

The Name of this Header.

property required

required: pulumi.Input<boolean>;

Is this Header Required?

property type

type: pulumi.Input<string>;

The Type of this Header, such as a string.

property values

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

One or more acceptable values for this Header.

interface ApiOperationRequestQueryParameter

interface ApiOperationRequestQueryParameter

property defaultValue

defaultValue?: pulumi.Input<string>;

The default value for this Query Parameter.

property description

description?: pulumi.Input<string>;

A description of this Query Parameter.

property name

name: pulumi.Input<string>;

The Name of this Query Parameter.

property required

required: pulumi.Input<boolean>;

Is this Query Parameter Required?

property type

type: pulumi.Input<string>;

The Type of this Query Parameter, such as a string.

property values

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

One or more acceptable values for this Query Parameter.

interface ApiOperationRequestRepresentation

interface ApiOperationRequestRepresentation

property contentType

contentType: pulumi.Input<string>;

The Content Type of this representation, such as application/json.

property formParameters

formParameters?: pulumi.Input<pulumi.Input<ApiOperationRequestRepresentationFormParameter>[]>;

One or more formParameter block as defined above.

property sample

sample?: pulumi.Input<string>;

An example of this representation.

property schemaId

schemaId?: pulumi.Input<string>;

The ID of an API Management Schema which represents this Response.

property typeName

typeName?: pulumi.Input<string>;

The Type Name defined by the Schema.

interface ApiOperationRequestRepresentationFormParameter

interface ApiOperationRequestRepresentationFormParameter

property defaultValue

defaultValue?: pulumi.Input<string>;

The default value for this Form Parameter.

property description

description?: pulumi.Input<string>;

A description of this Form Parameter.

property name

name: pulumi.Input<string>;

The Name of this Form Parameter.

property required

required: pulumi.Input<boolean>;

Is this Form Parameter Required?

property type

type: pulumi.Input<string>;

The Type of this Form Parameter, such as a string.

property values

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

One or more acceptable values for this Form Parameter.

interface ApiOperationResponse

interface ApiOperationResponse

property description

description?: pulumi.Input<string>;

A description of the HTTP Response, which may include HTML tags.

property headers

headers?: pulumi.Input<pulumi.Input<ApiOperationResponseHeader>[]>;

One or more header blocks as defined above.

property representations

representations?: pulumi.Input<pulumi.Input<ApiOperationResponseRepresentation>[]>;

One or more representation blocks as defined below.

property statusCode

statusCode: pulumi.Input<number>;

The HTTP Status Code.

interface ApiOperationResponseHeader

interface ApiOperationResponseHeader

property defaultValue

defaultValue?: pulumi.Input<string>;

The default value for this Header.

property description

description?: pulumi.Input<string>;

A description of this Header.

property name

name: pulumi.Input<string>;

The Name of this Header.

property required

required: pulumi.Input<boolean>;

Is this Header Required?

property type

type: pulumi.Input<string>;

The Type of this Header, such as a string.

property values

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

One or more acceptable values for this Header.

interface ApiOperationResponseRepresentation

interface ApiOperationResponseRepresentation

property contentType

contentType: pulumi.Input<string>;

The Content Type of this representation, such as application/json.

property formParameters

formParameters?: pulumi.Input<pulumi.Input<ApiOperationResponseRepresentationFormParameter>[]>;

One or more formParameter block as defined above.

property sample

sample?: pulumi.Input<string>;

An example of this representation.

property schemaId

schemaId?: pulumi.Input<string>;

The ID of an API Management Schema which represents this Response.

property typeName

typeName?: pulumi.Input<string>;

The Type Name defined by the Schema.

interface ApiOperationResponseRepresentationFormParameter

interface ApiOperationResponseRepresentationFormParameter

property defaultValue

defaultValue?: pulumi.Input<string>;

The default value for this Form Parameter.

property description

description?: pulumi.Input<string>;

A description of this Form Parameter.

property name

name: pulumi.Input<string>;

The Name of this Form Parameter.

property required

required: pulumi.Input<boolean>;

Is this Form Parameter Required?

property type

type: pulumi.Input<string>;

The Type of this Form Parameter, such as a string.

property values

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

One or more acceptable values for this Form Parameter.

interface ApiOperationTemplateParameter

interface ApiOperationTemplateParameter

property defaultValue

defaultValue?: pulumi.Input<string>;

The default value for this Template Parameter.

property description

description?: pulumi.Input<string>;

A description of this Template Parameter.

property name

name: pulumi.Input<string>;

The Name of this Template Parameter.

property required

required: pulumi.Input<boolean>;

Is this Template Parameter Required?

property type

type: pulumi.Input<string>;

The Type of this Template Parameter, such as a string.

property values

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

One or more acceptable values for this Template Parameter.

interface ApiSubscriptionKeyParameterNames

interface ApiSubscriptionKeyParameterNames

property header

header: pulumi.Input<string>;

The name of the HTTP Header which should be used for the Subscription Key.

property query

query: pulumi.Input<string>;

The name of the QueryString parameter which should be used for the Subscription Key.

interface AuthorizationServerTokenBodyParameter

interface AuthorizationServerTokenBodyParameter

property name

name: pulumi.Input<string>;

The Name of the Parameter.

property value

value: pulumi.Input<string>;

The Value of the Parameter.

interface BackendCredentials

interface BackendCredentials

property authorization

authorization?: pulumi.Input<BackendCredentialsAuthorization>;

An authorization block as defined below.

property certificates

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

A list of client certificate thumbprints to present to the backend host. The certificates must exist within the API Management Service.

property header

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

A mapping of header parameters to pass to the backend host. The keys are the header names and the values are a comma separated string of header values. This is converted to a list before being passed to the API.

property query

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

A mapping of query parameters to pass to the backend host. The keys are the query names and the values are a comma separated string of query values. This is converted to a list before being passed to the API.

interface BackendCredentialsAuthorization

interface BackendCredentialsAuthorization

property parameter

parameter?: pulumi.Input<string>;

The authentication Parameter value.

property scheme

scheme?: pulumi.Input<string>;

The authentication Scheme name.

interface BackendProxy

interface BackendProxy

property password

password?: pulumi.Input<string>;

The password to connect to the proxy server.

property url

url: pulumi.Input<string>;

The URL of the proxy server.

property username

username: pulumi.Input<string>;

The username to connect to the proxy server.

interface BackendServiceFabricCluster

interface BackendServiceFabricCluster

property clientCertificateThumbprint

clientCertificateThumbprint: pulumi.Input<string>;

The client certificate thumbprint for the management endpoint.

property managementEndpoints

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

A list of cluster management endpoints.

property maxPartitionResolutionRetries

maxPartitionResolutionRetries: pulumi.Input<number>;

The maximum number of retries when attempting resolve the partition.

property serverCertificateThumbprints

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

A list of thumbprints of the server certificates of the Service Fabric cluster.

property serverX509Names

serverX509Names?: pulumi.Input<pulumi.Input<BackendServiceFabricClusterServerX509Name>[]>;

One or more serverX509Name blocks as documented below.

interface BackendServiceFabricClusterServerX509Name

interface BackendServiceFabricClusterServerX509Name

property issuerCertificateThumbprint

issuerCertificateThumbprint: pulumi.Input<string>;

The thumbprint for the issuer of the certificate.

property name

name: pulumi.Input<string>;

The name of the API Management backend. Changing this forces a new resource to be created.

interface BackendTls

interface BackendTls

property validateCertificateChain

validateCertificateChain?: pulumi.Input<boolean>;

Flag indicating whether SSL certificate chain validation should be done when using self-signed certificates for the backend host.

property validateCertificateName

validateCertificateName?: pulumi.Input<boolean>;

Flag indicating whether SSL certificate name validation should be done when using self-signed certificates for the backend host.

interface LoggerApplicationInsights

interface LoggerApplicationInsights

property instrumentationKey

instrumentationKey: pulumi.Input<string>;

The instrumentation key used to push data to Application Insights.

interface LoggerEventhub

interface LoggerEventhub

property connectionString

connectionString: pulumi.Input<string>;

The connection string of an EventHub Namespace.

property name

name: pulumi.Input<string>;

The name of an EventHub.

interface ServiceAdditionalLocation

interface ServiceAdditionalLocation

property gatewayRegionalUrl

gatewayRegionalUrl?: pulumi.Input<string>;

The URL of the Regional Gateway for the API Management Service in the specified region.

property location

location: pulumi.Input<string>;

The name of the Azure Region in which the API Management Service should be expanded to.

property publicIpAddresses

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

Public Static Load Balanced IP addresses of the API Management service in the additional location. Available only for Basic, Standard and Premium SKU.

interface ServiceCertificate

interface ServiceCertificate

property certificatePassword

certificatePassword: pulumi.Input<string>;

The password for the certificate.

property encodedCertificate

encodedCertificate: pulumi.Input<string>;

The Base64 Encoded PFX Certificate.

property storeName

storeName: pulumi.Input<string>;

The name of the Certificate Store where this certificate should be stored. Possible values are CertificateAuthority and Root.

interface ServiceHostnameConfiguration

interface ServiceHostnameConfiguration

property developerPortals

developerPortals?: pulumi.Input<pulumi.Input<ServiceHostnameConfigurationDeveloperPortal>[]>;

One or more developerPortal blocks as documented below.

property managements

managements?: pulumi.Input<pulumi.Input<ServiceHostnameConfigurationManagement>[]>;

One or more management blocks as documented below.

property portals

portals?: pulumi.Input<pulumi.Input<ServiceHostnameConfigurationPortal>[]>;

One or more portal blocks as documented below.

property proxies

proxies?: pulumi.Input<pulumi.Input<ServiceHostnameConfigurationProxy>[]>;

One or more proxy blocks as documented below.

property scms

scms?: pulumi.Input<pulumi.Input<ServiceHostnameConfigurationScm>[]>;

One or more scm blocks as documented below.

interface ServiceHostnameConfigurationDeveloperPortal

interface ServiceHostnameConfigurationDeveloperPortal

property certificate

certificate?: pulumi.Input<string>;

One or more (up to 10) certificate blocks as defined below.

property certificatePassword

certificatePassword?: pulumi.Input<string>;

The password for the certificate.

property hostName

hostName: pulumi.Input<string>;

The Hostname to use for the Management API.

property keyVaultId

keyVaultId?: pulumi.Input<string>;

The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

property negotiateClientCertificate

negotiateClientCertificate?: pulumi.Input<boolean>;

Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

interface ServiceHostnameConfigurationManagement

interface ServiceHostnameConfigurationManagement

property certificate

certificate?: pulumi.Input<string>;

The Base64 Encoded Certificate.

property certificatePassword

certificatePassword?: pulumi.Input<string>;

The password associated with the certificate provided above.

property hostName

hostName: pulumi.Input<string>;

The Hostname to use for the Management API.

property keyVaultId

keyVaultId?: pulumi.Input<string>;

The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

property negotiateClientCertificate

negotiateClientCertificate?: pulumi.Input<boolean>;

Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

interface ServiceHostnameConfigurationPortal

interface ServiceHostnameConfigurationPortal

property certificate

certificate?: pulumi.Input<string>;

One or more (up to 10) certificate blocks as defined below.

property certificatePassword

certificatePassword?: pulumi.Input<string>;

The password for the certificate.

property hostName

hostName: pulumi.Input<string>;

The Hostname to use for the Management API.

property keyVaultId

keyVaultId?: pulumi.Input<string>;

The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

property negotiateClientCertificate

negotiateClientCertificate?: pulumi.Input<boolean>;

Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

interface ServiceHostnameConfigurationProxy

interface ServiceHostnameConfigurationProxy

property certificate

certificate?: pulumi.Input<string>;

The Base64 Encoded Certificate.

property certificatePassword

certificatePassword?: pulumi.Input<string>;

The password associated with the certificate provided above.

property defaultSslBinding

defaultSslBinding?: pulumi.Input<boolean>;

Is the certificate associated with this Hostname the Default SSL Certificate? This is used when an SNI header isn’t specified by a client. Defaults to false.

property hostName

hostName: pulumi.Input<string>;

The Hostname to use for the Management API.

property keyVaultId

keyVaultId?: pulumi.Input<string>;

The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

property negotiateClientCertificate

negotiateClientCertificate?: pulumi.Input<boolean>;

Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

interface ServiceHostnameConfigurationScm

interface ServiceHostnameConfigurationScm

property certificate

certificate?: pulumi.Input<string>;

One or more (up to 10) certificate blocks as defined below.

property certificatePassword

certificatePassword?: pulumi.Input<string>;

The password for the certificate.

property hostName

hostName: pulumi.Input<string>;

The Hostname to use for the Management API.

property keyVaultId

keyVaultId?: pulumi.Input<string>;

The ID of the Key Vault Secret containing the SSL Certificate, which must be should be of the type application/x-pkcs12.

property negotiateClientCertificate

negotiateClientCertificate?: pulumi.Input<boolean>;

Should Client Certificate Negotiation be enabled for this Hostname? Defaults to false.

interface ServiceIdentity

interface ServiceIdentity

property identityIds

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

A list of IDs for User Assigned Managed Identity resources to be assigned.

property principalId

principalId?: pulumi.Input<string>;

The Principal ID associated with this Managed Service Identity.

property tenantId

tenantId?: pulumi.Input<string>;

The Tenant ID associated with this Managed Service Identity.

property type

type?: pulumi.Input<string>;

Specifies the type of Managed Service Identity that should be configured on this API Management Service. Possible values are SystemAssigned, UserAssigned or SystemAssigned, UserAssigned (to enable both).

interface ServicePolicy

interface ServicePolicy

property xmlContent

xmlContent?: pulumi.Input<string>;

The XML Content for this Policy.

xmlLink?: pulumi.Input<string>;

A link to an API Management Policy XML Document, which must be publicly available.

interface ServiceProtocols

interface ServiceProtocols

property enableHttp2

enableHttp2?: pulumi.Input<boolean>;

Should HTTP/2 be supported by the API Management Service? Defaults to false.

interface ServiceSecurity

interface ServiceSecurity

property enableBackendSsl30

enableBackendSsl30?: pulumi.Input<boolean>;

Should SSL 3.0 be enabled on the backend of the gateway? Defaults to false.

property enableBackendTls10

enableBackendTls10?: pulumi.Input<boolean>;

Should TLS 1.0 be enabled on the backend of the gateway? Defaults to false.

property enableBackendTls11

enableBackendTls11?: pulumi.Input<boolean>;

Should TLS 1.1 be enabled on the backend of the gateway? Defaults to false.

property enableFrontendSsl30

enableFrontendSsl30?: pulumi.Input<boolean>;

Should SSL 3.0 be enabled on the frontend of the gateway? Defaults to false.

property enableFrontendTls10

enableFrontendTls10?: pulumi.Input<boolean>;

Should TLS 1.0 be enabled on the frontend of the gateway? Defaults to false.

property enableFrontendTls11

enableFrontendTls11?: pulumi.Input<boolean>;

Should TLS 1.1 be enabled on the frontend of the gateway? Defaults to false.

property enableTripleDesCiphers

enableTripleDesCiphers?: pulumi.Input<boolean>;

Should the TLS_RSA_WITH_3DES_EDE_CBC_SHA cipher be enabled for alL TLS versions (1.0, 1.1 and 1.2)? Defaults to false.

interface ServiceSignIn

interface ServiceSignIn

property enabled

enabled: pulumi.Input<boolean>;

Should anonymous users be redirected to the sign in page?

interface ServiceSignUp

interface ServiceSignUp

property enabled

enabled: pulumi.Input<boolean>;

Can users sign up on the development portal?

property termsOfService

termsOfService: pulumi.Input<ServiceSignUpTermsOfService>;

A termsOfService block as defined below.

interface ServiceSignUpTermsOfService

interface ServiceSignUpTermsOfService

property consentRequired

consentRequired: pulumi.Input<boolean>;

Should the user be asked for consent during sign up?

property enabled

enabled: pulumi.Input<boolean>;

Should Terms of Service be displayed during sign up?.

property text

text?: pulumi.Input<string>;

The Terms of Service which users are required to agree to in order to sign up.

interface ServiceVirtualNetworkConfiguration

interface ServiceVirtualNetworkConfiguration

property subnetId

subnetId: pulumi.Input<string>;

The id of the subnet that will be used for the API Management.

namespace appconfiguration

interface ConfigurationStorePrimaryReadKey

interface ConfigurationStorePrimaryReadKey

property connectionString

connectionString?: pulumi.Input<string>;

The Connection String for this Access Key - comprising of the Endpoint, ID and Secret.

property id

id?: pulumi.Input<string>;

The ID of the Access Key.

property secret

secret?: pulumi.Input<string>;

The Secret of the Access Key.

interface ConfigurationStorePrimaryWriteKey

interface ConfigurationStorePrimaryWriteKey

property connectionString

connectionString?: pulumi.Input<string>;

The Connection String for this Access Key - comprising of the Endpoint, ID and Secret.

property id

id?: pulumi.Input<string>;

The ID of the Access Key.

property secret

secret?: pulumi.Input<string>;

The Secret of the Access Key.

interface ConfigurationStoreSecondaryReadKey

interface ConfigurationStoreSecondaryReadKey

property connectionString

connectionString?: pulumi.Input<string>;

The Connection String for this Access Key - comprising of the Endpoint, ID and Secret.

property id

id?: pulumi.Input<string>;

The ID of the Access Key.

property secret

secret?: pulumi.Input<string>;

The Secret of the Access Key.

interface ConfigurationStoreSecondaryWriteKey

interface ConfigurationStoreSecondaryWriteKey

property connectionString

connectionString?: pulumi.Input<string>;

The Connection String for this Access Key - comprising of the Endpoint, ID and Secret.

property id

id?: pulumi.Input<string>;

The ID of the Access Key.

property secret

secret?: pulumi.Input<string>;

The Secret of the Access Key.

namespace appplatform

interface SpringCloudServiceConfigServerGitSetting

interface SpringCloudServiceConfigServerGitSetting

property httpBasicAuth

httpBasicAuth?: pulumi.Input<SpringCloudServiceConfigServerGitSettingHttpBasicAuth>;

A httpBasicAuth block as defined below.

property label

label?: pulumi.Input<string>;

The default label of the Git repository, should be the branch name, tag name, or commit-id of the repository.

property repositories

repositories?: pulumi.Input<pulumi.Input<SpringCloudServiceConfigServerGitSettingRepository>[]>;

One or more repository blocks as defined below.

property searchPaths

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

An array of strings used to search subdirectories of the Git repository.

property sshAuth

sshAuth?: pulumi.Input<SpringCloudServiceConfigServerGitSettingSshAuth>;

A sshAuth block as defined below.

property uri

uri: pulumi.Input<string>;

The URI of the default Git repository used as the Config Server back end, should be started with http://, https://, git@, or ssh://.

interface SpringCloudServiceConfigServerGitSettingHttpBasicAuth

interface SpringCloudServiceConfigServerGitSettingHttpBasicAuth

property password

password: pulumi.Input<string>;

The password used to access the Git repository server, required when the Git repository server supports Http Basic Authentication.

property username

username: pulumi.Input<string>;

The username that’s used to access the Git repository server, required when the Git repository server supports Http Basic Authentication.

interface SpringCloudServiceConfigServerGitSettingRepository

interface SpringCloudServiceConfigServerGitSettingRepository

property httpBasicAuth

httpBasicAuth?: pulumi.Input<SpringCloudServiceConfigServerGitSettingRepositoryHttpBasicAuth>;

A httpBasicAuth block as defined below.

property label

label?: pulumi.Input<string>;

The default label of the Git repository, should be the branch name, tag name, or commit-id of the repository.

property name

name: pulumi.Input<string>;

A name to identify on the Git repository, required only if repos exists.

property patterns

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

An array of strings used to match an application name. For each pattern, use the {application}/{profile} format with wildcards.

property searchPaths

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

An array of strings used to search subdirectories of the Git repository.

property sshAuth

sshAuth?: pulumi.Input<SpringCloudServiceConfigServerGitSettingRepositorySshAuth>;

A sshAuth block as defined below.

property uri

uri: pulumi.Input<string>;

The URI of the Git repository that’s used as the Config Server back end should be started with http://, https://, git@, or ssh://.

interface SpringCloudServiceConfigServerGitSettingRepositoryHttpBasicAuth

interface SpringCloudServiceConfigServerGitSettingRepositoryHttpBasicAuth

property password

password: pulumi.Input<string>;

The password used to access the Git repository server, required when the Git repository server supports Http Basic Authentication.

property username

username: pulumi.Input<string>;

The username that’s used to access the Git repository server, required when the Git repository server supports Http Basic Authentication.

interface SpringCloudServiceConfigServerGitSettingRepositorySshAuth

interface SpringCloudServiceConfigServerGitSettingRepositorySshAuth

property hostKey

hostKey?: pulumi.Input<string>;

The host key of the Git repository server, should not include the algorithm prefix as covered by host-key-algorithm.

property hostKeyAlgorithm

hostKeyAlgorithm?: pulumi.Input<string>;

The host key algorithm, should be ssh-dss, ssh-rsa, ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521. Required only if host-key exists.

property privateKey

privateKey: pulumi.Input<string>;

The SSH private key to access the Git repository, required when the URI starts with git@ or ssh://.

property strictHostKeyCheckingEnabled

strictHostKeyCheckingEnabled?: pulumi.Input<boolean>;

Indicates whether the Config Server instance will fail to start if the hostKey does not match.

interface SpringCloudServiceConfigServerGitSettingSshAuth

interface SpringCloudServiceConfigServerGitSettingSshAuth

property hostKey

hostKey?: pulumi.Input<string>;

The host key of the Git repository server, should not include the algorithm prefix as covered by host-key-algorithm.

property hostKeyAlgorithm

hostKeyAlgorithm?: pulumi.Input<string>;

The host key algorithm, should be ssh-dss, ssh-rsa, ecdsa-sha2-nistp256, ecdsa-sha2-nistp384, or ecdsa-sha2-nistp521. Required only if host-key exists.

property privateKey

privateKey: pulumi.Input<string>;

The SSH private key to access the Git repository, required when the URI starts with git@ or ssh://.

property strictHostKeyCheckingEnabled

strictHostKeyCheckingEnabled?: pulumi.Input<boolean>;

Indicates whether the Config Server instance will fail to start if the hostKey does not match.

namespace appservice

interface AppServiceAuthSettings

interface AppServiceAuthSettings

property activeDirectory

activeDirectory?: pulumi.Input<AppServiceAuthSettingsActiveDirectory>;

A activeDirectory block as defined below.

property additionalLoginParams

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

Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form “key=value”.

property allowedExternalRedirectUrls

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

External URLs that can be redirected to as part of logging in or logging out of the app.

property defaultProvider

defaultProvider?: pulumi.Input<string>;

The default provider to use when multiple providers have been set up. Possible values are AzureActiveDirectory, Facebook, Google, MicrosoftAccount and Twitter.

property enabled

enabled: pulumi.Input<boolean>;

Is Authentication enabled?

property facebook

facebook?: pulumi.Input<AppServiceAuthSettingsFacebook>;

A facebook block as defined below.

property google

google?: pulumi.Input<AppServiceAuthSettingsGoogle>;

A google block as defined below.

property issuer

issuer?: pulumi.Input<string>;

Issuer URI. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.

property microsoft

microsoft?: pulumi.Input<AppServiceAuthSettingsMicrosoft>;

A microsoft block as defined below.

property runtimeVersion

runtimeVersion?: pulumi.Input<string>;

The runtime version of the Authentication/Authorization module.

property tokenRefreshExtensionHours

tokenRefreshExtensionHours?: pulumi.Input<number>;

The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to 72.

property tokenStoreEnabled

tokenStoreEnabled?: pulumi.Input<boolean>;

If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to false.

property twitter

twitter?: pulumi.Input<AppServiceAuthSettingsTwitter>;

A twitter block as defined below.

property unauthenticatedClientAction

unauthenticatedClientAction?: pulumi.Input<string>;

The action to take when an unauthenticated client attempts to access the app. Possible values are AllowAnonymous and RedirectToLoginPage.

interface AppServiceAuthSettingsActiveDirectory

interface AppServiceAuthSettingsActiveDirectory

property allowedAudiences

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

Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

property clientId

clientId: pulumi.Input<string>;

The Client ID of this relying party application. Enables OpenIDConnection authentication with Azure Active Directory.

property clientSecret

clientSecret?: pulumi.Input<string>;

The Client Secret of this relying party application. If no secret is provided, implicit flow will be used.

interface AppServiceAuthSettingsFacebook

interface AppServiceAuthSettingsFacebook

property appId

appId: pulumi.Input<string>;

The App ID of the Facebook app used for login

property appSecret

appSecret: pulumi.Input<string>;

The App Secret of the Facebook app used for Facebook Login.

property oauthScopes

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

The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. https://developers.facebook.com/docs/facebook-login

interface AppServiceAuthSettingsGoogle

interface AppServiceAuthSettingsGoogle

property clientId

clientId: pulumi.Input<string>;

The OpenID Connect Client ID for the Google web application.

property clientSecret

clientSecret: pulumi.Input<string>;

The client secret associated with the Google web application.

property oauthScopes

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

The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. https://developers.google.com/identity/sign-in/web/

interface AppServiceAuthSettingsMicrosoft

interface AppServiceAuthSettingsMicrosoft

property clientId

clientId: pulumi.Input<string>;

The OAuth 2.0 client ID that was created for the app used for authentication.

property clientSecret

clientSecret: pulumi.Input<string>;

The OAuth 2.0 client secret that was created for the app used for authentication.

property oauthScopes

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

The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. https://msdn.microsoft.com/en-us/library/dn631845.aspx

interface AppServiceAuthSettingsTwitter

interface AppServiceAuthSettingsTwitter

property consumerKey

consumerKey: pulumi.Input<string>;

property consumerSecret

consumerSecret: pulumi.Input<string>;

interface AppServiceBackup

interface AppServiceBackup

property enabled

enabled?: pulumi.Input<boolean>;

Is this Backup enabled?

property name

name: pulumi.Input<string>;

Specifies the name for this Backup.

property schedule

schedule: pulumi.Input<AppServiceBackupSchedule>;

A schedule block as defined below.

property storageAccountUrl

storageAccountUrl: pulumi.Input<string>;

The SAS URL to a Storage Container where Backups should be saved.

interface AppServiceBackupSchedule

interface AppServiceBackupSchedule

property frequencyInterval

frequencyInterval: pulumi.Input<number>;

Sets how often the backup should be executed.

property frequencyUnit

frequencyUnit: pulumi.Input<string>;

Sets the unit of time for how often the backup should be executed. Possible values are Day or Hour.

property keepAtLeastOneBackup

keepAtLeastOneBackup?: pulumi.Input<boolean>;

Should at least one backup always be kept in the Storage Account by the Retention Policy, regardless of how old it is?

property retentionPeriodInDays

retentionPeriodInDays?: pulumi.Input<number>;

Specifies the number of days after which Backups should be deleted.

property startTime

startTime?: pulumi.Input<string>;

Sets when the schedule should start working.

interface AppServiceConnectionString

interface AppServiceConnectionString

property name

name: pulumi.Input<string>;

The name of the Connection String.

property type

type: pulumi.Input<string>;

The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer.

property value

value: pulumi.Input<string>;

The value for the Connection String.

interface AppServiceIdentity

interface AppServiceIdentity

property identityIds

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

Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned.

property principalId

principalId?: pulumi.Input<string>;

The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.

property tenantId

tenantId?: pulumi.Input<string>;

The Tenant ID for the Service Principal associated with the Managed Service Identity of this App Service.

property type

type: pulumi.Input<string>;

Specifies the identity type of the App Service. Possible values are SystemAssigned (where Azure will generate a Service Principal for you), UserAssigned where you can specify the Service Principal IDs in the identityIds field, and SystemAssigned, UserAssigned which assigns both a system managed identity as well as the specified user assigned identities.

interface AppServiceLogs

interface AppServiceLogs

property applicationLogs

applicationLogs?: pulumi.Input<AppServiceLogsApplicationLogs>;

An applicationLogs block as defined below.

property httpLogs

httpLogs?: pulumi.Input<AppServiceLogsHttpLogs>;

An httpLogs block as defined below.

interface AppServiceLogsApplicationLogs

interface AppServiceLogsApplicationLogs

property azureBlobStorage

azureBlobStorage?: pulumi.Input<AppServiceLogsApplicationLogsAzureBlobStorage>;

An azureBlobStorage block as defined below.

interface AppServiceLogsApplicationLogsAzureBlobStorage

interface AppServiceLogsApplicationLogsAzureBlobStorage

property level

level: pulumi.Input<string>;

The level at which to log. Possible values include Error, Warning, Information, Verbose and Off. NOTE: this field is not available for httpLogs

property retentionInDays

retentionInDays: pulumi.Input<number>;

The number of days to retain logs for.

property sasUrl

sasUrl: pulumi.Input<string>;

The URL to the storage container, with a Service SAS token appended. NOTE: there is currently no means of generating Service SAS tokens with the azurerm provider.

interface AppServiceLogsHttpLogs

interface AppServiceLogsHttpLogs

property azureBlobStorage

azureBlobStorage?: pulumi.Input<AppServiceLogsHttpLogsAzureBlobStorage>;

An azureBlobStorage block as defined below.

property fileSystem

fileSystem?: pulumi.Input<AppServiceLogsHttpLogsFileSystem>;

A fileSystem block as defined below.

interface AppServiceLogsHttpLogsAzureBlobStorage

interface AppServiceLogsHttpLogsAzureBlobStorage

property retentionInDays

retentionInDays: pulumi.Input<number>;

The number of days to retain logs for.

property sasUrl

sasUrl: pulumi.Input<string>;

The URL to the storage container, with a Service SAS token appended. NOTE: there is currently no means of generating Service SAS tokens with the azurerm provider.

interface AppServiceLogsHttpLogsFileSystem

interface AppServiceLogsHttpLogsFileSystem

property retentionInDays

retentionInDays: pulumi.Input<number>;

The number of days to retain logs for.

property retentionInMb

retentionInMb: pulumi.Input<number>;

The maximum size in megabytes that http log files can use before being removed.

interface AppServiceSiteConfig

interface AppServiceSiteConfig

property alwaysOn

alwaysOn?: pulumi.Input<boolean>;

Should the app be loaded at all times? Defaults to false.

property appCommandLine

appCommandLine?: pulumi.Input<string>;

App command line to launch, e.g. /sbin/myserver -b 0.0.0.0.

property autoSwapSlotName

autoSwapSlotName?: pulumi.Input<string>;

property cors

cors?: pulumi.Input<AppServiceSiteConfigCors>;

A cors block as defined below.

property defaultDocuments

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

The ordering of default documents to load, if an address isn’t specified.

property dotnetFrameworkVersion

dotnetFrameworkVersion?: pulumi.Input<string>;

The version of the .net framework’s CLR used in this App Service. Possible values are v2.0 (which will use the latest version of the .net framework for the .net CLR v2 - currently .net 3.5) and v4.0 (which corresponds to the latest version of the .net CLR v4 - which at the time of writing is .net 4.7.1). For more information on which .net CLR version to use based on the .net framework you’re targeting - please see this table. Defaults to v4.0.

property ftpsState

ftpsState?: pulumi.Input<string>;

State of FTP / FTPS service for this App Service. Possible values include: AllAllowed, FtpsOnly and Disabled.

property healthCheckPath

healthCheckPath?: pulumi.Input<string>;

The health check path to be pinged by App Service. For more information - please see the corresponding Kudu Wiki page.

property http2Enabled

http2Enabled?: pulumi.Input<boolean>;

Is HTTP2 Enabled on this App Service? Defaults to false.

property ipRestrictions

ipRestrictions?: pulumi.Input<pulumi.Input<AppServiceSiteConfigIpRestriction>[]>;

A list of objects representing ip restrictions as defined below.

property javaContainer

javaContainer?: pulumi.Input<string>;

The Java Container to use. If specified javaVersion and javaContainerVersion must also be specified. Possible values are JAVA, JETTY, and TOMCAT.

property javaContainerVersion

javaContainerVersion?: pulumi.Input<string>;

The version of the Java Container to use. If specified javaVersion and javaContainer must also be specified.

property javaVersion

javaVersion?: pulumi.Input<string>;

The version of Java to use. If specified javaContainer and javaContainerVersion must also be specified. Possible values are 1.7, 1.8 and 11 and their specific versions - except for Java 11 (e.g. 1.7.0_80, 1.8.0_181, 11)

property linuxFxVersion

linuxFxVersion?: pulumi.Input<string>;

Linux App Framework and version for the App Service. Possible options are a Docker container (DOCKER|<user/image:tag>), a base-64 encoded Docker Compose file (COMPOSE|${filebase64("compose.yml")}) or a base-64 encoded Kubernetes Manifest (KUBE|${filebase64("kubernetes.yml")}).

property localMysqlEnabled

localMysqlEnabled?: pulumi.Input<boolean>;

Is “MySQL In App” Enabled? This runs a local MySQL instance with your app and shares resources from the App Service plan.

property managedPipelineMode

managedPipelineMode?: pulumi.Input<string>;

The Managed Pipeline Mode. Possible values are Integrated and Classic. Defaults to Integrated.

property minTlsVersion

minTlsVersion?: pulumi.Input<string>;

The minimum supported TLS version for the app service. Possible values are 1.0, 1.1, and 1.2. Defaults to 1.2 for new app services.

property phpVersion

phpVersion?: pulumi.Input<string>;

The version of PHP to use in this App Service. Possible values are 5.5, 5.6, 7.0, 7.1, 7.2, and 7.3.

property pythonVersion

pythonVersion?: pulumi.Input<string>;

The version of Python to use in this App Service. Possible values are 2.7 and 3.4.

property remoteDebuggingEnabled

remoteDebuggingEnabled?: pulumi.Input<boolean>;

Is Remote Debugging Enabled? Defaults to false.

property remoteDebuggingVersion

remoteDebuggingVersion?: pulumi.Input<string>;

Which version of Visual Studio should the Remote Debugger be compatible with? Possible values are VS2012, VS2013, VS2015 and VS2017.

property scmType

scmType?: pulumi.Input<string>;

The type of Source Control enabled for this App Service. Defaults to None. Possible values are: BitbucketGit, BitbucketHg, CodePlexGit, CodePlexHg, Dropbox, ExternalGit, ExternalHg, GitHub, LocalGit, None, OneDrive, Tfs, VSO, and VSTSRM

property use32BitWorkerProcess

use32BitWorkerProcess?: pulumi.Input<boolean>;

Should the App Service run in 32 bit mode, rather than 64 bit mode?

property websocketsEnabled

websocketsEnabled?: pulumi.Input<boolean>;

Should WebSockets be enabled?

property windowsFxVersion

windowsFxVersion?: pulumi.Input<string>;

The Windows Docker container image (DOCKER|<user/image:tag>)

interface AppServiceSiteConfigCors

interface AppServiceSiteConfigCors

property allowedOrigins

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

A list of origins which should be able to make cross-origin calls. * can be used to allow all calls.

property supportCredentials

supportCredentials?: pulumi.Input<boolean>;

Are credentials supported?

interface AppServiceSiteConfigIpRestriction

interface AppServiceSiteConfigIpRestriction

property action

action?: pulumi.Input<string>;

Does this restriction Allow or Deny access for this IP range. Defaults to Allow.

property ipAddress

ipAddress?: pulumi.Input<string>;

The IP Address used for this IP Restriction in CIDR notation.

property name

name?: pulumi.Input<string>;

The name for this IP Restriction.

property priority

priority?: pulumi.Input<number>;

The priority for this IP Restriction. Restrictions are enforced in priority order. By default, priority is set to 65000 if not specified.

property virtualNetworkSubnetId

virtualNetworkSubnetId?: pulumi.Input<string>;

The Virtual Network Subnet ID used for this IP Restriction.

interface AppServiceSiteCredential

interface AppServiceSiteCredential

property password

password?: pulumi.Input<string>;

The password associated with the username, which can be used to publish to this App Service.

property username

username?: pulumi.Input<string>;

The username which can be used to publish to this App Service

interface AppServiceSourceControl

interface AppServiceSourceControl

property branch

branch?: pulumi.Input<string>;

Branch name of the Git repository for this App Service.

property repoUrl

repoUrl?: pulumi.Input<string>;

URL of the Git repository for this App Service.

interface AppServiceStorageAccount

interface AppServiceStorageAccount

property accessKey

accessKey: pulumi.Input<string>;

The access key for the storage account.

property accountName

accountName: pulumi.Input<string>;

The name of the storage account.

property mountPath

mountPath?: pulumi.Input<string>;

The path to mount the storage within the site’s runtime environment.

property name

name: pulumi.Input<string>;

The name of the storage account identifier.

property shareName

shareName: pulumi.Input<string>;

The name of the file share (container name, for Blob storage).

property type

type: pulumi.Input<string>;

The type of storage. Possible values are AzureBlob and AzureFiles.

interface CertificateOrderCertificate

interface CertificateOrderCertificate

property certificateName

certificateName?: pulumi.Input<string>;

The name of the App Service Certificate.

property keyVaultId

keyVaultId?: pulumi.Input<string>;

Key Vault resource Id.

property keyVaultSecretName

keyVaultSecretName?: pulumi.Input<string>;

Key Vault secret name.

property provisioningState

provisioningState?: pulumi.Input<string>;

Status of the Key Vault secret.

interface FunctionAppAuthSettings

interface FunctionAppAuthSettings

property activeDirectory

activeDirectory?: pulumi.Input<FunctionAppAuthSettingsActiveDirectory>;

A activeDirectory block as defined below.

property additionalLoginParams

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

Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form “key=value”.

property allowedExternalRedirectUrls

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

External URLs that can be redirected to as part of logging in or logging out of the app.

property defaultProvider

defaultProvider?: pulumi.Input<string>;

The default provider to use when multiple providers have been set up. Possible values are AzureActiveDirectory, Facebook, Google, MicrosoftAccount and Twitter.

property enabled

enabled: pulumi.Input<boolean>;

Is Authentication enabled?

property facebook

facebook?: pulumi.Input<FunctionAppAuthSettingsFacebook>;

A facebook block as defined below.

property google

google?: pulumi.Input<FunctionAppAuthSettingsGoogle>;

A google block as defined below.

property issuer

issuer?: pulumi.Input<string>;

Issuer URI. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.

property microsoft

microsoft?: pulumi.Input<FunctionAppAuthSettingsMicrosoft>;

A microsoft block as defined below.

property runtimeVersion

runtimeVersion?: pulumi.Input<string>;

The runtime version of the Authentication/Authorization module.

property tokenRefreshExtensionHours

tokenRefreshExtensionHours?: pulumi.Input<number>;

The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to 72.

property tokenStoreEnabled

tokenStoreEnabled?: pulumi.Input<boolean>;

If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to false.

property twitter

twitter?: pulumi.Input<FunctionAppAuthSettingsTwitter>;

A twitter block as defined below.

property unauthenticatedClientAction

unauthenticatedClientAction?: pulumi.Input<string>;

The action to take when an unauthenticated client attempts to access the app. Possible values are AllowAnonymous and RedirectToLoginPage.

interface FunctionAppAuthSettingsActiveDirectory

interface FunctionAppAuthSettingsActiveDirectory

property allowedAudiences

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

Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

property clientId

clientId: pulumi.Input<string>;

The Client ID of this relying party application. Enables OpenIDConnection authentication with Azure Active Directory.

property clientSecret

clientSecret?: pulumi.Input<string>;

The Client Secret of this relying party application. If no secret is provided, implicit flow will be used.

interface FunctionAppAuthSettingsFacebook

interface FunctionAppAuthSettingsFacebook

property appId

appId: pulumi.Input<string>;

The App ID of the Facebook app used for login

property appSecret

appSecret: pulumi.Input<string>;

The App Secret of the Facebook app used for Facebook Login.

property oauthScopes

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

The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. https://developers.facebook.com/docs/facebook-login

interface FunctionAppAuthSettingsGoogle

interface FunctionAppAuthSettingsGoogle

property clientId

clientId: pulumi.Input<string>;

The OpenID Connect Client ID for the Google web application.

property clientSecret

clientSecret: pulumi.Input<string>;

The client secret associated with the Google web application.

property oauthScopes

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

The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. https://developers.google.com/identity/sign-in/web/

interface FunctionAppAuthSettingsMicrosoft

interface FunctionAppAuthSettingsMicrosoft

property clientId

clientId: pulumi.Input<string>;

The OAuth 2.0 client ID that was created for the app used for authentication.

property clientSecret

clientSecret: pulumi.Input<string>;

The OAuth 2.0 client secret that was created for the app used for authentication.

property oauthScopes

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

The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. https://msdn.microsoft.com/en-us/library/dn631845.aspx

interface FunctionAppAuthSettingsTwitter

interface FunctionAppAuthSettingsTwitter

property consumerKey

consumerKey: pulumi.Input<string>;

property consumerSecret

consumerSecret: pulumi.Input<string>;

interface FunctionAppConnectionString

interface FunctionAppConnectionString

property name

name: pulumi.Input<string>;

The name of the Connection String.

property type

type: pulumi.Input<string>;

The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer.

property value

value: pulumi.Input<string>;

The value for the Connection String.

interface FunctionAppIdentity

interface FunctionAppIdentity

property identityIds

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

Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned.

property principalId

principalId?: pulumi.Input<string>;

The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.

property tenantId

tenantId?: pulumi.Input<string>;

The Tenant ID for the Service Principal associated with the Managed Service Identity of this App Service.

property type

type: pulumi.Input<string>;

Specifies the identity type of the Function App. Possible values are SystemAssigned (where Azure will generate a Service Principal for you), UserAssigned where you can specify the Service Principal IDs in the identityIds field, and SystemAssigned, UserAssigned which assigns both a system managed identity as well as the specified user assigned identities.

interface FunctionAppSiteConfig

interface FunctionAppSiteConfig

property alwaysOn

alwaysOn?: pulumi.Input<boolean>;

Should the Function App be loaded at all times? Defaults to false.

property cors

cors?: pulumi.Input<FunctionAppSiteConfigCors>;

A cors block as defined below.

property ftpsState

ftpsState?: pulumi.Input<string>;

State of FTP / FTPS service for this function app. Possible values include: AllAllowed, FtpsOnly and Disabled.

property http2Enabled

http2Enabled?: pulumi.Input<boolean>;

Specifies whether or not the http2 protocol should be enabled. Defaults to false.

property ipRestrictions

ipRestrictions?: pulumi.Input<pulumi.Input<FunctionAppSiteConfigIpRestriction>[]>;

A list of objects representing ip restrictions as defined below.

property linuxFxVersion

linuxFxVersion?: pulumi.Input<string>;

Linux App Framework and version for the AppService, e.g. DOCKER|(golang:latest).

property minTlsVersion

minTlsVersion?: pulumi.Input<string>;

The minimum supported TLS version for the function app. Possible values are 1.0, 1.1, and 1.2. Defaults to 1.2 for new function apps.

property preWarmedInstanceCount

preWarmedInstanceCount?: pulumi.Input<number>;

The number of pre-warmed instances for this function app. Only affects apps on the Premium plan.

property use32BitWorkerProcess

use32BitWorkerProcess?: pulumi.Input<boolean>;

Should the Function App run in 32 bit mode, rather than 64 bit mode? Defaults to true.

property websocketsEnabled

websocketsEnabled?: pulumi.Input<boolean>;

Should WebSockets be enabled?

interface FunctionAppSiteConfigCors

interface FunctionAppSiteConfigCors

property allowedOrigins

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

A list of origins which should be able to make cross-origin calls. * can be used to allow all calls.

property supportCredentials

supportCredentials?: pulumi.Input<boolean>;

Are credentials supported?

interface FunctionAppSiteConfigIpRestriction

interface FunctionAppSiteConfigIpRestriction

property ipAddress

ipAddress?: pulumi.Input<string>;

The IP Address CIDR notation used for this IP Restriction.

property subnetId

subnetId?: pulumi.Input<string>;

The Subnet ID used for this IP Restriction.

interface FunctionAppSiteCredential

interface FunctionAppSiteCredential

property password

password?: pulumi.Input<string>;

The password associated with the username, which can be used to publish to this App Service.

property username

username?: pulumi.Input<string>;

The username which can be used to publish to this App Service

interface FunctionAppSlotAuthSettings

interface FunctionAppSlotAuthSettings

property activeDirectory

activeDirectory?: pulumi.Input<FunctionAppSlotAuthSettingsActiveDirectory>;

An activeDirectory block as defined below.

property additionalLoginParams

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

Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form “key=value”.

property allowedExternalRedirectUrls

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

External URLs that can be redirected to as part of logging in or logging out of the app.

property defaultProvider

defaultProvider?: pulumi.Input<string>;

The default provider to use when multiple providers have been set up. Possible values are AzureActiveDirectory, Facebook, Google, MicrosoftAccount and Twitter.

property enabled

enabled: pulumi.Input<boolean>;

Is Authentication enabled?

property facebook

facebook?: pulumi.Input<FunctionAppSlotAuthSettingsFacebook>;

A facebook block as defined below.

property google

google?: pulumi.Input<FunctionAppSlotAuthSettingsGoogle>;

A google block as defined below.

property issuer

issuer?: pulumi.Input<string>;

Issuer URI. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.

property microsoft

microsoft?: pulumi.Input<FunctionAppSlotAuthSettingsMicrosoft>;

A microsoft block as defined below.

property runtimeVersion

runtimeVersion?: pulumi.Input<string>;

The runtime version of the Authentication/Authorization module.

property tokenRefreshExtensionHours

tokenRefreshExtensionHours?: pulumi.Input<number>;

The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to 72.

property tokenStoreEnabled

tokenStoreEnabled?: pulumi.Input<boolean>;

If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to false.

property twitter

twitter?: pulumi.Input<FunctionAppSlotAuthSettingsTwitter>;

A twitter block as defined below.

property unauthenticatedClientAction

unauthenticatedClientAction?: pulumi.Input<string>;

The action to take when an unauthenticated client attempts to access the app. Possible values are AllowAnonymous and RedirectToLoginPage.

interface FunctionAppSlotAuthSettingsActiveDirectory

interface FunctionAppSlotAuthSettingsActiveDirectory

property allowedAudiences

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

Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

property clientId

clientId: pulumi.Input<string>;

The Client ID of this relying party application. Enables OpenIDConnection authentication with Azure Active Directory.

property clientSecret

clientSecret?: pulumi.Input<string>;

The Client Secret of this relying party application. If no secret is provided, implicit flow will be used.

interface FunctionAppSlotAuthSettingsFacebook

interface FunctionAppSlotAuthSettingsFacebook

property appId

appId: pulumi.Input<string>;

The App ID of the Facebook app used for login

property appSecret

appSecret: pulumi.Input<string>;

The App Secret of the Facebook app used for Facebook Login.

property oauthScopes

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

The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. https://developers.facebook.com/docs/facebook-login

interface FunctionAppSlotAuthSettingsGoogle

interface FunctionAppSlotAuthSettingsGoogle

property clientId

clientId: pulumi.Input<string>;

The OpenID Connect Client ID for the Google web application.

property clientSecret

clientSecret: pulumi.Input<string>;

The client secret associated with the Google web application.

property oauthScopes

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

The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. https://developers.google.com/identity/sign-in/web/

interface FunctionAppSlotAuthSettingsMicrosoft

interface FunctionAppSlotAuthSettingsMicrosoft

property clientId

clientId: pulumi.Input<string>;

The OAuth 2.0 client ID that was created for the app used for authentication.

property clientSecret

clientSecret: pulumi.Input<string>;

The OAuth 2.0 client secret that was created for the app used for authentication.

property oauthScopes

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

The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. https://msdn.microsoft.com/en-us/library/dn631845.aspx

interface FunctionAppSlotAuthSettingsTwitter

interface FunctionAppSlotAuthSettingsTwitter

property consumerKey

consumerKey: pulumi.Input<string>;

property consumerSecret

consumerSecret: pulumi.Input<string>;

interface FunctionAppSlotConnectionString

interface FunctionAppSlotConnectionString

property name

name: pulumi.Input<string>;

The name of the Connection String.

property type

type: pulumi.Input<string>;

The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure and SQLServer.

property value

value: pulumi.Input<string>;

The value for the Connection String.

interface FunctionAppSlotIdentity

interface FunctionAppSlotIdentity

property identityIds

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

Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned.

property principalId

principalId?: pulumi.Input<string>;

The Principal ID for the Service Principal associated with the Managed Service Identity of this App Service.

property tenantId

tenantId?: pulumi.Input<string>;

The Tenant ID for the Service Principal associated with the Managed Service Identity of this App Service.

property type

type: pulumi.Input<string>;

Specifies the identity type of the Function App. Possible values are SystemAssigned (where Azure will generate a Service Principal for you), UserAssigned where you can specify the Service Principal IDs in the identityIds field, and SystemAssigned, UserAssigned which assigns both a system managed identity as well as the specified user assigned identities.

interface FunctionAppSlotSiteConfig

interface FunctionAppSlotSiteConfig

property alwaysOn

alwaysOn?: pulumi.Input<boolean>;

Should the Function App be loaded at all times? Defaults to false.

property cors

cors?: pulumi.Input<FunctionAppSlotSiteConfigCors>;

A cors block as defined below.

property ftpsState

ftpsState?: pulumi.Input<string>;

State of FTP / FTPS service for this function app. Possible values include: AllAllowed, FtpsOnly and Disabled.

property http2Enabled

http2Enabled?: pulumi.Input<boolean>;

Specifies whether or not the http2 protocol should be enabled. Defaults to false.

property ipRestrictions

ipRestrictions?: pulumi.Input<pulumi.Input<FunctionAppSlotSiteConfigIpRestriction>[]>;

A List of objects representing ip restrictions as defined below.

property linuxFxVersion

linuxFxVersion?: pulumi.Input<string>;

Linux App Framework and version for the AppService, e.g. DOCKER|(golang:latest).

property minTlsVersion

minTlsVersion?: pulumi.Input<string>;

The minimum supported TLS version for the function app. Possible values are 1.0, 1.1, and 1.2. Defaults to 1.2 for new function apps.

property preWarmedInstanceCount

preWarmedInstanceCount?: pulumi.Input<number>;

The number of pre-warmed instances for this function app. Only affects apps on the Premium plan.

property use32BitWorkerProcess

use32BitWorkerProcess?: pulumi.Input<boolean>;

Should the Function App run in 32 bit mode, rather than 64 bit mode? Defaults to true.

property websocketsEnabled

websocketsEnabled?: pulumi.Input<boolean>;

Should WebSockets be enabled?

interface FunctionAppSlotSiteConfigCors

interface FunctionAppSlotSiteConfigCors

property allowedOrigins

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

A list of origins which should be able to make cross-origin calls. * can be used to allow all calls.

property supportCredentials

supportCredentials?: pulumi.Input<boolean>;

Are credentials supported?

interface FunctionAppSlotSiteConfigIpRestriction

interface FunctionAppSlotSiteConfigIpRestriction

property ipAddress

ipAddress?: pulumi.Input<string>;

The IP Address CIDR notation used for this IP Restriction.

property subnetId

subnetId?: pulumi.Input<string>;

The Subnet ID used for this IP Restriction.

interface FunctionAppSlotSiteCredential

interface FunctionAppSlotSiteCredential

property password

password?: pulumi.Input<string>;

The password associated with the username, which can be used to publish to this App Service.

property username

username?: pulumi.Input<string>;

The username which can be used to publish to this App Service

interface PlanSku

interface PlanSku

property capacity

capacity?: pulumi.Input<number>;

Specifies the number of workers associated with this App Service Plan.

property size

size: pulumi.Input<string>;

Specifies the plan’s instance size.

property tier

tier: pulumi.Input<string>;

Specifies the plan’s pricing tier.

interface SlotAuthSettings

interface SlotAuthSettings

property activeDirectory

activeDirectory?: pulumi.Input<SlotAuthSettingsActiveDirectory>;

A activeDirectory block as defined below.

property additionalLoginParams

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

Login parameters to send to the OpenID Connect authorization endpoint when a user logs in. Each parameter must be in the form “key=value”.

property allowedExternalRedirectUrls

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

External URLs that can be redirected to as part of logging in or logging out of the app.

property defaultProvider

defaultProvider?: pulumi.Input<string>;

The default provider to use when multiple providers have been set up. Possible values are AzureActiveDirectory, Facebook, Google, MicrosoftAccount and Twitter.

property enabled

enabled: pulumi.Input<boolean>;

Is Authentication enabled?

property facebook

facebook?: pulumi.Input<SlotAuthSettingsFacebook>;

A facebook block as defined below.

property google

google?: pulumi.Input<SlotAuthSettingsGoogle>;

A google block as defined below.

property issuer

issuer?: pulumi.Input<string>;

Issuer URI. When using Azure Active Directory, this value is the URI of the directory tenant, e.g. https://sts.windows.net/{tenant-guid}/.

property microsoft

microsoft?: pulumi.Input<SlotAuthSettingsMicrosoft>;

A microsoft block as defined below.

property runtimeVersion

runtimeVersion?: pulumi.Input<string>;

The runtime version of the Authentication/Authorization module.

property tokenRefreshExtensionHours

tokenRefreshExtensionHours?: pulumi.Input<number>;

The number of hours after session token expiration that a session token can be used to call the token refresh API. Defaults to 72.

property tokenStoreEnabled

tokenStoreEnabled?: pulumi.Input<boolean>;

If enabled the module will durably store platform-specific security tokens that are obtained during login flows. Defaults to false.

property twitter

twitter?: pulumi.Input<SlotAuthSettingsTwitter>;

A twitter block as defined below.

property unauthenticatedClientAction

unauthenticatedClientAction?: pulumi.Input<string>;

The action to take when an unauthenticated client attempts to access the app. Possible values are AllowAnonymous and RedirectToLoginPage.

interface SlotAuthSettingsActiveDirectory

interface SlotAuthSettingsActiveDirectory

property allowedAudiences

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

Allowed audience values to consider when validating JWTs issued by Azure Active Directory.

property clientId

clientId: pulumi.Input<string>;

The Client ID of this relying party application. Enables OpenIDConnection authentication with Azure Active Directory.

property clientSecret

clientSecret?: pulumi.Input<string>;

The Client Secret of this relying party application. If no secret is provided, implicit flow will be used.

interface SlotAuthSettingsFacebook

interface SlotAuthSettingsFacebook

property appId

appId: pulumi.Input<string>;

The App ID of the Facebook app used for login

property appSecret

appSecret: pulumi.Input<string>;

The App Secret of the Facebook app used for Facebook Login.

property oauthScopes

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

The OAuth 2.0 scopes that will be requested as part of Facebook Login authentication. https://developers.facebook.com/docs/facebook-login

interface SlotAuthSettingsGoogle

interface SlotAuthSettingsGoogle

property clientId

clientId: pulumi.Input<string>;

The OpenID Connect Client ID for the Google web application.

property clientSecret

clientSecret: pulumi.Input<string>;

The client secret associated with the Google web application.

property oauthScopes

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

The OAuth 2.0 scopes that will be requested as part of Google Sign-In authentication. https://developers.google.com/identity/sign-in/web/

interface SlotAuthSettingsMicrosoft

interface SlotAuthSettingsMicrosoft

property clientId

clientId: pulumi.Input<string>;

The OAuth 2.0 client ID that was created for the app used for authentication.

property clientSecret

clientSecret: pulumi.Input<string>;

The OAuth 2.0 client secret that was created for the app used for authentication.

property oauthScopes

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

The OAuth 2.0 scopes that will be requested as part of Microsoft Account authentication. https://msdn.microsoft.com/en-us/library/dn631845.aspx

interface SlotAuthSettingsTwitter

interface SlotAuthSettingsTwitter

property consumerKey

consumerKey: pulumi.Input<string>;

property consumerSecret

consumerSecret: pulumi.Input<string>;

interface SlotConnectionString

interface SlotConnectionString

property name

name: pulumi.Input<string>;

The name of the Connection String.

property type

type: pulumi.Input<string>;

The type of the Connection String. Possible values are APIHub, Custom, DocDb, EventHub, MySQL, NotificationHub, PostgreSQL, RedisCache, ServiceBus, SQLAzure, and SQLServer.

property value

value: pulumi.Input<string>;

The value for the Connection String.

interface SlotIdentity

interface SlotIdentity

property identityIds

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

Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned.

property principalId

principalId?: pulumi.Input<string>;

property tenantId

tenantId?: pulumi.Input<string>;

property type

type: pulumi.Input<string>;

Specifies the identity type of the App Service. Possible values are SystemAssigned (where Azure will generate a Service Principal for you), UserAssigned where you can specify the Service Principal IDs in the identityIds field, and SystemAssigned, UserAssigned which assigns both a system managed identity as well as the specified user assigned identities.

interface SlotLogs

interface SlotLogs

property applicationLogs

applicationLogs?: pulumi.Input<SlotLogsApplicationLogs>;

An applicationLogs block as defined below.

property httpLogs

httpLogs?: pulumi.Input<SlotLogsHttpLogs>;

An httpLogs block as defined below.

interface SlotLogsApplicationLogs

interface SlotLogsApplicationLogs

property azureBlobStorage

azureBlobStorage?: pulumi.Input<SlotLogsApplicationLogsAzureBlobStorage>;

An azureBlobStorage block as defined below.

interface SlotLogsApplicationLogsAzureBlobStorage

interface SlotLogsApplicationLogsAzureBlobStorage

property level

level: pulumi.Input<string>;

The level at which to log. Possible values include Error, Warning, Information, Verbose and Off. NOTE: this field is not available for httpLogs

property retentionInDays

retentionInDays: pulumi.Input<number>;

The number of days to retain logs for.

property sasUrl

sasUrl: pulumi.Input<string>;

The URL to the storage container, with a Service SAS token appended. NOTE: there is currently no means of generating Service SAS tokens with the azurerm provider.

interface SlotLogsHttpLogs

interface SlotLogsHttpLogs

property azureBlobStorage

azureBlobStorage?: pulumi.Input<SlotLogsHttpLogsAzureBlobStorage>;

An azureBlobStorage block as defined below.

property fileSystem

fileSystem?: pulumi.Input<SlotLogsHttpLogsFileSystem>;

A fileSystem block as defined below.

interface SlotLogsHttpLogsAzureBlobStorage

interface SlotLogsHttpLogsAzureBlobStorage

property retentionInDays

retentionInDays: pulumi.Input<number>;

The number of days to retain logs for.

property sasUrl

sasUrl: pulumi.Input<string>;

The URL to the storage container, with a Service SAS token appended. NOTE: there is currently no means of generating Service SAS tokens with the azurerm provider.

interface SlotLogsHttpLogsFileSystem

interface SlotLogsHttpLogsFileSystem

property retentionInDays

retentionInDays: pulumi.Input<number>;

The number of days to retain logs for.

property retentionInMb

retentionInMb: pulumi.Input<number>;

The maximum size in megabytes that http log files can use before being removed.

interface SlotSiteConfig

interface SlotSiteConfig

property alwaysOn

alwaysOn?: pulumi.Input<boolean>;

Should the app be loaded at all times? Defaults to false.

property appCommandLine

appCommandLine?: pulumi.Input<string>;

App command line to launch, e.g. /sbin/myserver -b 0.0.0.0.

property autoSwapSlotName

autoSwapSlotName?: pulumi.Input<string>;

The name of the swap to automatically swap to during deployment

property cors

cors?: pulumi.Input<SlotSiteConfigCors>;

A cors block as defined below.

property defaultDocuments

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

The ordering of default documents to load, if an address isn’t specified.

property dotnetFrameworkVersion

dotnetFrameworkVersion?: pulumi.Input<string>;

The version of the .net framework’s CLR used in this App Service Slot. Possible values are v2.0 (which will use the latest version of the .net framework for the .net CLR v2 - currently .net 3.5) and v4.0 (which corresponds to the latest version of the .net CLR v4 - which at the time of writing is .net 4.7.1). For more information on which .net CLR version to use based on the .net framework you’re targeting - please see this table. Defaults to v4.0.

property ftpsState

ftpsState?: pulumi.Input<string>;

property healthCheckPath

healthCheckPath?: pulumi.Input<string>;

property http2Enabled

http2Enabled?: pulumi.Input<boolean>;

Is HTTP2 Enabled on this App Service? Defaults to false.

property ipRestrictions

ipRestrictions?: pulumi.Input<pulumi.Input<SlotSiteConfigIpRestriction>[]>;

A list of objects representing ip restrictions as defined below.

property javaContainer

javaContainer?: pulumi.Input<string>;

The Java Container to use. If specified javaVersion and javaContainerVersion must also be specified. Possible values are JETTY and TOMCAT.

property javaContainerVersion

javaContainerVersion?: pulumi.Input<string>;

The version of the Java Container to use. If specified javaVersion and javaContainer must also be specified.

property javaVersion

javaVersion?: pulumi.Input<string>;

The version of Java to use. If specified javaContainer and javaContainerVersion must also be specified. Possible values are 1.7, 1.8, and 11 and their specific versions - except for Java 11 (e.g. 1.7.0_80, 1.8.0_181, 11)

property linuxFxVersion

linuxFxVersion?: pulumi.Input<string>;

property localMysqlEnabled

localMysqlEnabled?: pulumi.Input<boolean>;

Is “MySQL In App” Enabled? This runs a local MySQL instance with your app and shares resources from the App Service plan.

property managedPipelineMode

managedPipelineMode?: pulumi.Input<string>;

The Managed Pipeline Mode. Possible values are Integrated and Classic. Defaults to Integrated.

property minTlsVersion

minTlsVersion?: pulumi.Input<string>;

The minimum supported TLS version for the app service. Possible values are 1.0, 1.1, and 1.2. Defaults to 1.2 for new app services.

property phpVersion

phpVersion?: pulumi.Input<string>;

The version of PHP to use in this App Service Slot. Possible values are 5.5, 5.6, 7.0, 7.1, 7.2, and 7.3.

property pythonVersion

pythonVersion?: pulumi.Input<string>;

The version of Python to use in this App Service Slot. Possible values are 2.7 and 3.4.

property remoteDebuggingEnabled

remoteDebuggingEnabled?: pulumi.Input<boolean>;

Is Remote Debugging Enabled? Defaults to false.

property remoteDebuggingVersion

remoteDebuggingVersion?: pulumi.Input<string>;

Which version of Visual Studio should the Remote Debugger be compatible with? Possible values are VS2012, VS2013, VS2015, and VS2017.

property scmType

scmType?: pulumi.Input<string>;

The type of Source Control enabled for this App Service Slot. Defaults to None. Possible values are: BitbucketGit, BitbucketHg, CodePlexGit, CodePlexHg, Dropbox, ExternalGit, ExternalHg, GitHub, LocalGit, None, OneDrive, Tfs, VSO, and VSTSRM

property use32BitWorkerProcess

use32BitWorkerProcess?: pulumi.Input<boolean>;

Should the App Service Slot run in 32 bit mode, rather than 64 bit mode?

property websocketsEnabled

websocketsEnabled?: pulumi.Input<boolean>;

Should WebSockets be enabled?

property windowsFxVersion

windowsFxVersion?: pulumi.Input<string>;

interface SlotSiteConfigCors

interface SlotSiteConfigCors

property allowedOrigins

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

A list of origins which should be able to make cross-origin calls. * can be used to allow all calls.

property supportCredentials

supportCredentials?: pulumi.Input<boolean>;

Are credentials supported?

interface SlotSiteConfigIpRestriction

interface SlotSiteConfigIpRestriction

property action

action?: pulumi.Input<string>;

property ipAddress

ipAddress?: pulumi.Input<string>;

The IP Address used for this IP Restriction.

property name

name?: pulumi.Input<string>;

Specifies the name of the App Service Slot component. Changing this forces a new resource to be created.

property priority

priority?: pulumi.Input<number>;

property virtualNetworkSubnetId

virtualNetworkSubnetId?: pulumi.Input<string>;

(Optional.The Virtual Network Subnet ID used for this IP Restriction.

interface SlotSiteCredential

interface SlotSiteCredential

property password

password?: pulumi.Input<string>;

The password associated with the username, which can be used to publish to this App Service.

property username

username?: pulumi.Input<string>;

The username which can be used to publish to this App Service

namespace authorization

interface RoleDefinitionPermission

interface RoleDefinitionPermission

property actions

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

One or more Allowed Actions, such as *, Microsoft.Resources/subscriptions/resourceGroups/read. See ‘Azure Resource Manager resource provider operations’ for details.

property dataActions

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

One or more Allowed Data Actions, such as *, Microsoft.Storage/storageAccounts/blobServices/containers/blobs/read. See ‘Azure Resource Manager resource provider operations’ for details.

property notActions

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

One or more Disallowed Actions, such as *, Microsoft.Resources/subscriptions/resourceGroups/read. See ‘Azure Resource Manager resource provider operations’ for details.

property notDataActions

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

One or more Disallowed Data Actions, such as *, Microsoft.Resources/subscriptions/resourceGroups/read. See ‘Azure Resource Manager resource provider operations’ for details.

namespace automation

interface ModuleModuleLink
hash?: pulumi.Input<ModuleModuleLinkHash>;
uri: pulumi.Input<string>;

The uri of the module content (zip or nupkg).

interface ModuleModuleLinkHash

interface ModuleModuleLinkHash

property algorithm

algorithm: pulumi.Input<string>;

property value

value: pulumi.Input<string>;
interface RunBookPublishContentLink
hash?: pulumi.Input<RunBookPublishContentLinkHash>;
uri: pulumi.Input<string>;

The uri of the runbook content.

version?: pulumi.Input<string>;

interface RunBookPublishContentLinkHash

interface RunBookPublishContentLinkHash

property algorithm

algorithm: pulumi.Input<string>;

property value

value: pulumi.Input<string>;

interface ScheduleMonthlyOccurrence

interface ScheduleMonthlyOccurrence

property day

day: pulumi.Input<string>;

Day of the occurrence. Must be one of Monday, Tuesday, Wednesday, Thursday, Friday, Saturday, Sunday.

property occurrence

occurrence: pulumi.Input<number>;

Occurrence of the week within the month. Must be between 1 and 5. -1 for last week within the month.

namespace backup

interface PolicyFileShareBackup

interface PolicyFileShareBackup

property frequency

frequency: pulumi.Input<string>;

Sets the backup frequency. Currently, only Daily is supported

property time

time: pulumi.Input<string>;

interface PolicyFileShareRetentionDaily

interface PolicyFileShareRetentionDaily

property count

count: pulumi.Input<number>;

The number of daily backups to keep. Must be between 1 and 180 (inclusive)

interface PolicyVMBackup

interface PolicyVMBackup

property frequency

frequency: pulumi.Input<string>;

Sets the backup frequency. Must be either Daily orWeekly.

property time

time: pulumi.Input<string>;

The time of day to perform the backup in 24hour format.

property weekdays

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

The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.

interface PolicyVMRetentionDaily

interface PolicyVMRetentionDaily

property count

count: pulumi.Input<number>;

The number of yearly backups to keep. Must be between 1 and 9999

interface PolicyVMRetentionMonthly

interface PolicyVMRetentionMonthly

property count

count: pulumi.Input<number>;

The number of yearly backups to keep. Must be between 1 and 9999

property weekdays

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

The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.

property weeks

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

The weeks of the month to retain backups of. Must be one of First, Second, Third, Fourth, Last.

interface PolicyVMRetentionWeekly

interface PolicyVMRetentionWeekly

property count

count: pulumi.Input<number>;

The number of yearly backups to keep. Must be between 1 and 9999

property weekdays

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

The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.

interface PolicyVMRetentionYearly

interface PolicyVMRetentionYearly

property count

count: pulumi.Input<number>;

The number of yearly backups to keep. Must be between 1 and 9999

property months

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

The months of the year to retain backups of. Must be one of January, February, March, April, May, June, July, Augest, September, October, November and December.

property weekdays

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

The weekday backups to retain . Must be one of Sunday, Monday, Tuesday, Wednesday, Thursday, Friday or Saturday.

property weeks

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

The weeks of the month to retain backups of. Must be one of First, Second, Third, Fourth, Last.

namespace batch

interface AccountKeyVaultReference

interface AccountKeyVaultReference

property id

id: pulumi.Input<string>;

The Azure identifier of the Azure KeyVault to use.

property url

url: pulumi.Input<string>;

The HTTPS URL of the Azure KeyVault to use.

interface GetPoolCertificate

interface GetPoolCertificate

property id

id: string;

The fully qualified ID of the certificate installed on the pool.

property storeLocation

storeLocation: string;

The location of the certificate store on the compute node into which the certificate is installed, either CurrentUser or LocalMachine.

property storeName

storeName?: undefined | string;

The name of the certificate store on the compute node into which the certificate is installed.

property visibilities

visibilities?: string[];

Which user accounts on the compute node have access to the private data of the certificate.

interface GetPoolNetworkConfiguration

interface GetPoolNetworkConfiguration

property endpointConfiguration

endpointConfiguration?: inputs.batch.GetPoolNetworkConfigurationEndpointConfiguration;

The inbound NAT pools that are used to address specific ports on the individual compute node externally.

property subnetId

subnetId?: undefined | string;

The ARM resource identifier of the virtual network subnet which the compute nodes of the pool are joined too.

interface GetPoolNetworkConfigurationEndpointConfiguration

interface GetPoolNetworkConfigurationEndpointConfiguration

property backendPort

backendPort?: undefined | number;

The port number on the compute node.

property frontendPortRange

frontendPortRange?: undefined | string;

The range of external ports that are used to provide inbound access to the backendPort on the individual compute nodes in the format of 1000-1100.

property name

name?: undefined | string;

The name of the endpoint.

property networkSecurityGroupRules

networkSecurityGroupRules?: GetPoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule[];

The list of network security group rules that are applied to the endpoint.

property protocol

protocol?: undefined | string;

The protocol of the endpoint.

interface GetPoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule

interface GetPoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule

property access

access?: undefined | string;

The action that should be taken for a specified IP address, subnet range or tag.

property priority

priority?: undefined | number;

The priority for this rule.

property sourceAddressPrefix

sourceAddressPrefix?: undefined | string;

The source address prefix or tag to match for the rule.

interface GetPoolStartTask

interface GetPoolStartTask

property commandLine

commandLine: string;

The command line executed by the start task.

property environment

environment?: undefined | {[key: string]: string};

A map of strings (key,value) that represents the environment variables to set in the start task.

property maxTaskRetryCount

maxTaskRetryCount?: undefined | number;

The number of retry count.

property resourceFiles

resourceFiles?: GetPoolStartTaskResourceFile[];

One or more resourceFile blocks that describe the files to be downloaded to a compute node.

property userIdentities

userIdentities?: GetPoolStartTaskUserIdentity[];

A userIdentity block that describes the user identity under which the start task runs.

property waitForSuccess

waitForSuccess?: undefined | false | true;

A flag that indicates if the Batch pool should wait for the start task to be completed.

interface GetPoolStartTaskResourceFile

interface GetPoolStartTaskResourceFile

property autoStorageContainerName

autoStorageContainerName?: undefined | string;

The storage container name in the auto storage account.

property blobPrefix

blobPrefix?: undefined | string;

The blob prefix used when downloading blobs from an Azure Storage container.

property fileMode

fileMode?: undefined | string;

The file permission mode attribute represented as a string in octal format (e.g. "0644").

property filePath

filePath?: undefined | string;

The location on the compute node to which to download the file, relative to the task’s working directory. If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified.

property httpUrl

httpUrl?: undefined | string;

The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access.

property storageContainerUrl

storageContainerUrl?: undefined | string;

The URL of the blob container within Azure Blob Storage.

interface GetPoolStartTaskUserIdentity

interface GetPoolStartTaskUserIdentity

property autoUsers

autoUsers?: GetPoolStartTaskUserIdentityAutoUser[];

A autoUser block that describes the user identity under which the start task runs.

property userName

userName?: undefined | string;

The user name to log into the registry server.

interface GetPoolStartTaskUserIdentityAutoUser

interface GetPoolStartTaskUserIdentityAutoUser

property elevationLevel

elevationLevel?: undefined | string;

The elevation level of the user identity under which the start task runs.

property scope

scope?: undefined | string;

The scope of the user identity under which the start task runs.

interface PoolAutoScale

interface PoolAutoScale

property evaluationInterval

evaluationInterval?: pulumi.Input<string>;

The interval to wait before evaluating if the pool needs to be scaled. Defaults to PT15M.

property formula

formula: pulumi.Input<string>;

The autoscale formula that needs to be used for scaling the Batch pool.

interface PoolCertificate

interface PoolCertificate

property id

id: pulumi.Input<string>;

The ID of the Batch Certificate to install on the Batch Pool, which must be inside the same Batch Account.

property storeLocation

storeLocation: pulumi.Input<string>;

The location of the certificate store on the compute node into which to install the certificate. Possible values are CurrentUser or LocalMachine.

property storeName

storeName?: pulumi.Input<string>;

The name of the certificate store on the compute node into which to install the certificate. This property is applicable only for pools configured with Windows nodes (that is, created with cloudServiceConfiguration, or with virtualMachineConfiguration using a Windows image reference). Common store names include: My, Root, CA, Trust, Disallowed, TrustedPeople, TrustedPublisher, AuthRoot, AddressBook, but any custom store name can also be used. The default value is My.

property visibilities

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

Which user accounts on the compute node should have access to the private data of the certificate.

interface PoolContainerConfiguration

interface PoolContainerConfiguration

property containerImageNames

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

A list of container image names to use, as would be specified by docker pull.

property containerRegistries

containerRegistries?: pulumi.Input<pulumi.Input<PoolContainerConfigurationContainerRegistry>[]>;

Additional container registries from which container images can be pulled by the pool’s VMs.

property type

type?: pulumi.Input<string>;

The type of container configuration. Possible value is DockerCompatible.

interface PoolContainerConfigurationContainerRegistry

interface PoolContainerConfigurationContainerRegistry

property password

password: pulumi.Input<string>;

The password to log into the registry server. Changing this forces a new resource to be created.

property registryServer

registryServer: pulumi.Input<string>;

The container registry URL. The default is “docker.io”. Changing this forces a new resource to be created.

property userName

userName: pulumi.Input<string>;

The user name to log into the registry server. Changing this forces a new resource to be created.

interface PoolFixedScale

interface PoolFixedScale

property resizeTimeout

resizeTimeout?: pulumi.Input<string>;

The timeout for resize operations. Defaults to PT15M.

property targetDedicatedNodes

targetDedicatedNodes?: pulumi.Input<number>;

The number of nodes in the Batch pool. Defaults to 1.

property targetLowPriorityNodes

targetLowPriorityNodes?: pulumi.Input<number>;

The number of low priority nodes in the Batch pool. Defaults to 0.

interface PoolNetworkConfiguration

interface PoolNetworkConfiguration

property endpointConfigurations

endpointConfigurations?: pulumi.Input<pulumi.Input<PoolNetworkConfigurationEndpointConfiguration>[]>;

A list of inbound NAT pools that can be used to address specific ports on an individual compute node externally. Set as documented in the inboundNatPools block below. Changing this forces a new resource to be created.

property publicIps

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

A list of public ip ids that will be allocated to nodes. Changing this forces a new resource to be created.

property subnetId

subnetId: pulumi.Input<string>;

The ARM resource identifier of the virtual network subnet which the compute nodes of the pool will join. Changing this forces a new resource to be created.

interface PoolNetworkConfigurationEndpointConfiguration

interface PoolNetworkConfigurationEndpointConfiguration

property backendPort

backendPort: pulumi.Input<number>;

The port number on the compute node. Acceptable values are between 1 and 65535 except for 29876, 29877 as these are reserved. Changing this forces a new resource to be created.

property frontendPortRange

frontendPortRange: pulumi.Input<string>;

The range of external ports that will be used to provide inbound access to the backendPort on individual compute nodes in the format of 1000-1100. Acceptable values range between 1 and 65534 except ports from 50000 to 55000 which are reserved by the Batch service. All ranges within a pool must be distinct and cannot overlap. Values must be a range of at least 100 nodes. Changing this forces a new resource to be created.

property name

name: pulumi.Input<string>;

The name of the endpoint. The name must be unique within a Batch pool, can contain letters, numbers, underscores, periods, and hyphens. Names must start with a letter or number, must end with a letter, number, or underscore, and cannot exceed 77 characters. Changing this forces a new resource to be created.

property networkSecurityGroupRules

networkSecurityGroupRules?: pulumi.Input<pulumi.Input<PoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule>[]>;

A list of network security group rules that will be applied to the endpoint. The maximum number of rules that can be specified across all the endpoints on a Batch pool is 25. If no network security group rules are specified, a default rule will be created to allow inbound access to the specified backendPort. Set as documented in the networkSecurityGroupRules block below. Changing this forces a new resource to be created.

property protocol

protocol: pulumi.Input<string>;

The protocol of the endpoint. Acceptable values are TCP and UDP. Changing this forces a new resource to be created.

interface PoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule

interface PoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule

property access

access: pulumi.Input<string>;

The action that should be taken for a specified IP address, subnet range or tag. Acceptable values are Allow and Deny. Changing this forces a new resource to be created.

property priority

priority: pulumi.Input<number>;

The priority for this rule. The value must be at least 150. Changing this forces a new resource to be created.

property sourceAddressPrefix

sourceAddressPrefix: pulumi.Input<string>;

The source address prefix or tag to match for the rule. Changing this forces a new resource to be created.

interface PoolStartTask

interface PoolStartTask

property commandLine

commandLine: pulumi.Input<string>;

The command line executed by the start task.

property environment

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

A map of strings (key,value) that represents the environment variables to set in the start task.

property maxTaskRetryCount

maxTaskRetryCount?: pulumi.Input<number>;

The number of retry count. Defaults to 1.

property resourceFiles

resourceFiles?: pulumi.Input<pulumi.Input<PoolStartTaskResourceFile>[]>;

One or more resourceFile blocks that describe the files to be downloaded to a compute node.

property userIdentity

userIdentity: pulumi.Input<PoolStartTaskUserIdentity>;

A userIdentity block that describes the user identity under which the start task runs.

property waitForSuccess

waitForSuccess?: pulumi.Input<boolean>;

A flag that indicates if the Batch pool should wait for the start task to be completed. Default to false.

interface PoolStartTaskResourceFile

interface PoolStartTaskResourceFile

property autoStorageContainerName

autoStorageContainerName?: pulumi.Input<string>;

The storage container name in the auto storage account.

property blobPrefix

blobPrefix?: pulumi.Input<string>;

The blob prefix to use when downloading blobs from an Azure Storage container. Only the blobs whose names begin with the specified prefix will be downloaded. The property is valid only when autoStorageContainerName or storageContainerUrl is used. This prefix can be a partial filename or a subdirectory. If a prefix is not specified, all the files in the container will be downloaded.

property fileMode

fileMode?: pulumi.Input<string>;

The file permission mode represented as a string in octal format (e.g. "0644"). This property applies only to files being downloaded to Linux compute nodes. It will be ignored if it is specified for a resourceFile which will be downloaded to a Windows node. If this property is not specified for a Linux node, then a default value of 0770 is applied to the file.

property filePath

filePath?: pulumi.Input<string>;

The location on the compute node to which to download the file, relative to the task’s working directory. If the httpUrl property is specified, the filePath is required and describes the path which the file will be downloaded to, including the filename. Otherwise, if the autoStorageContainerName or storageContainerUrl property is specified, filePath is optional and is the directory to download the files to. In the case where filePath is used as a directory, any directory structure already associated with the input data will be retained in full and appended to the specified filePath directory. The specified relative path cannot break out of the task’s working directory (for example by using ‘..’).

property httpUrl

httpUrl?: pulumi.Input<string>;

The URL of the file to download. If the URL is Azure Blob Storage, it must be readable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read permissions on the blob, or set the ACL for the blob or its container to allow public access.

property storageContainerUrl

storageContainerUrl?: pulumi.Input<string>;

The URL of the blob container within Azure Blob Storage. This URL must be readable and listable using anonymous access; that is, the Batch service does not present any credentials when downloading the blob. There are two ways to get such a URL for a blob in Azure storage: include a Shared Access Signature (SAS) granting read and list permissions on the blob, or set the ACL for the blob or its container to allow public access.

interface PoolStartTaskUserIdentity

interface PoolStartTaskUserIdentity

property autoUser

autoUser?: pulumi.Input<PoolStartTaskUserIdentityAutoUser>;

A autoUser block that describes the user identity under which the start task runs.

property userName

userName?: pulumi.Input<string>;

The username to be used by the Batch pool start task.

interface PoolStartTaskUserIdentityAutoUser

interface PoolStartTaskUserIdentityAutoUser

property elevationLevel

elevationLevel?: pulumi.Input<string>;

The elevation level of the user identity under which the start task runs. Possible values are Admin or NonAdmin. Defaults to NonAdmin.

property scope

scope?: pulumi.Input<string>;

The scope of the user identity under which the start task runs. Possible values are Task or Pool. Defaults to Task.

interface PoolStorageImageReference

interface PoolStorageImageReference

property id

id?: pulumi.Input<string>;

Specifies the ID of the Custom Image which the virtual machines should be created from. Changing this forces a new resource to be created. See official documentation for more details.

property offer

offer?: pulumi.Input<string>;

Specifies the offer of the image used to create the virtual machines. Changing this forces a new resource to be created.

property publisher

publisher?: pulumi.Input<string>;

Specifies the publisher of the image used to create the virtual machines. Changing this forces a new resource to be created.

property sku

sku?: pulumi.Input<string>;

Specifies the SKU of the image used to create the virtual machines. Changing this forces a new resource to be created.

property version

version?: pulumi.Input<string>;

Specifies the version of the image used to create the virtual machines. Changing this forces a new resource to be created.

namespace blueprint

interface AssignmentIdentity

interface AssignmentIdentity

property identityIds

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

property principalId

principalId?: pulumi.Input<string>;

property tenantId

tenantId?: pulumi.Input<string>;

property type

type: pulumi.Input<string>;

The Identity type for the Managed Service Identity. Currently only UserAssigned is supported.

namespace bot

interface ChannelDirectLineSite

interface ChannelDirectLineSite

property enabled

enabled?: pulumi.Input<boolean>;

property enhancedAuthenticationEnabled

enhancedAuthenticationEnabled?: pulumi.Input<boolean>;

property id

id?: pulumi.Input<string>;

property key

key?: pulumi.Input<string>;

property key2

key2?: pulumi.Input<string>;

property name

name: pulumi.Input<string>;

property trustedOrigins

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

property v1Allowed

v1Allowed?: pulumi.Input<boolean>;

property v3Allowed

v3Allowed?: pulumi.Input<boolean>;

namespace cdn

interface EndpointDeliveryRule

interface EndpointDeliveryRule

property cacheExpirationAction

cacheExpirationAction?: pulumi.Input<EndpointDeliveryRuleCacheExpirationAction>;

A cacheExpirationAction block as defined above.

property cacheKeyQueryStringAction

cacheKeyQueryStringAction?: pulumi.Input<EndpointDeliveryRuleCacheKeyQueryStringAction>;

A cacheKeyQueryStringAction block as defined above.

property cookiesConditions

cookiesConditions?: pulumi.Input<pulumi.Input<EndpointDeliveryRuleCookiesCondition>[]>;

A cookiesCondition block as defined above.

property deviceCondition

deviceCondition?: pulumi.Input<EndpointDeliveryRuleDeviceCondition>;

A deviceCondition block as defined below.

property httpVersionConditions

httpVersionConditions?: pulumi.Input<pulumi.Input<EndpointDeliveryRuleHttpVersionCondition>[]>;

A httpVersionCondition block as defined below.

property modifyRequestHeaderActions

modifyRequestHeaderActions?: pulumi.Input<pulumi.Input<EndpointDeliveryRuleModifyRequestHeaderAction>[]>;

A modifyRequestHeaderAction block as defined below.

property modifyResponseHeaderActions

modifyResponseHeaderActions?: pulumi.Input<pulumi.Input<EndpointDeliveryRuleModifyResponseHeaderAction>[]>;

A modifyResponseHeaderAction block as defined below.

property name

name: pulumi.Input<string>;

The Name which should be used for this Delivery Rule.

property order

order: pulumi.Input<number>;

The order used for this rule, which must be larger than 1.

property postArgConditions

postArgConditions?: pulumi.Input<pulumi.Input<EndpointDeliveryRulePostArgCondition>[]>;

A postArgCondition block as defined below.

property queryStringConditions

queryStringConditions?: pulumi.Input<pulumi.Input<EndpointDeliveryRuleQueryStringCondition>[]>;

A queryStringCondition block as defined below.

property remoteAddressConditions

remoteAddressConditions?: pulumi.Input<pulumi.Input<EndpointDeliveryRuleRemoteAddressCondition>[]>;

A remoteAddressCondition block as defined below.

property requestBodyConditions

requestBodyConditions?: pulumi.Input<pulumi.Input<EndpointDeliveryRuleRequestBodyCondition>[]>;

A requestBodyCondition block as defined below.

property requestHeaderConditions

requestHeaderConditions?: pulumi.Input<pulumi.Input<EndpointDeliveryRuleRequestHeaderCondition>[]>;

A requestHeaderCondition block as defined below.

property requestMethodCondition

requestMethodCondition?: pulumi.Input<EndpointDeliveryRuleRequestMethodCondition>;

A requestMethodCondition block as defined below.

property requestSchemeCondition

requestSchemeCondition?: pulumi.Input<EndpointDeliveryRuleRequestSchemeCondition>;

A requestSchemeCondition block as defined below.

property requestUriConditions

requestUriConditions?: pulumi.Input<pulumi.Input<EndpointDeliveryRuleRequestUriCondition>[]>;

A requestUriCondition block as defined below.

property urlFileExtensionConditions

urlFileExtensionConditions?: pulumi.Input<pulumi.Input<EndpointDeliveryRuleUrlFileExtensionCondition>[]>;

A urlFileExtensionCondition block as defined below.

property urlFileNameConditions

urlFileNameConditions?: pulumi.Input<pulumi.Input<EndpointDeliveryRuleUrlFileNameCondition>[]>;

A urlFileNameCondition block as defined below.

property urlPathConditions

urlPathConditions?: pulumi.Input<pulumi.Input<EndpointDeliveryRuleUrlPathCondition>[]>;

A urlPathCondition block as defined below.

property urlRedirectAction

urlRedirectAction?: pulumi.Input<EndpointDeliveryRuleUrlRedirectAction>;

A urlRedirectAction block as defined below.

property urlRewriteAction

urlRewriteAction?: pulumi.Input<EndpointDeliveryRuleUrlRewriteAction>;

A urlRewriteAction block as defined below.

interface EndpointDeliveryRuleCacheExpirationAction

interface EndpointDeliveryRuleCacheExpirationAction

property behavior

behavior: pulumi.Input<string>;

The behavior of the cache. Valid values are BypassCache, Override and SetIfMissing.

property duration

duration?: pulumi.Input<string>;

Duration of the cache. Only allowed when behavior is set to Override or SetIfMissing. Format: [d.]hh:mm:ss

interface EndpointDeliveryRuleCacheKeyQueryStringAction

interface EndpointDeliveryRuleCacheKeyQueryStringAction

property behavior

behavior: pulumi.Input<string>;

The behavior of the cache key for query strings. Valid values are Exclude, ExcludeAll, Include and IncludeAll.

property parameters

parameters?: pulumi.Input<string>;

Comma separated list of parameter values.

interface EndpointDeliveryRuleCookiesCondition

interface EndpointDeliveryRuleCookiesCondition

property matchValues

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

List of values for the cookie.

property negateCondition

negateCondition?: pulumi.Input<boolean>;

Defaults to false.

property operator

operator: pulumi.Input<string>;

Valid values are Any, BeginsWith, Contains, EndsWith, Equal, GreaterThan, GreaterThanOrEqual, LessThan and LessThanOrEqual.

property selector

selector: pulumi.Input<string>;

Name of the cookie.

property transforms

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

Valid values are Lowercase and Uppercase.

interface EndpointDeliveryRuleDeviceCondition

interface EndpointDeliveryRuleDeviceCondition

property matchValues

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

Valid values are Desktop and Mobile.

property negateCondition

negateCondition?: pulumi.Input<boolean>;

Defaults to false.

property operator

operator?: pulumi.Input<string>;

Valid values are Equal.

interface EndpointDeliveryRuleHttpVersionCondition

interface EndpointDeliveryRuleHttpVersionCondition

property matchValues

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

Valid values are 0.9, 1.0, 1.1 and 2.0.

property negateCondition

negateCondition?: pulumi.Input<boolean>;

Defaults to false.

property operator

operator?: pulumi.Input<string>;

Valid values are Equal.

interface EndpointDeliveryRuleModifyRequestHeaderAction

interface EndpointDeliveryRuleModifyRequestHeaderAction

property action

action: pulumi.Input<string>;

Action to be executed on a header value. Valid values are Append, Delete and Overwrite.

property name

name: pulumi.Input<string>;

The header name.

property value

value?: pulumi.Input<string>;

The value of the header. Only needed when action is set to Append or overwrite.

interface EndpointDeliveryRuleModifyResponseHeaderAction

interface EndpointDeliveryRuleModifyResponseHeaderAction

property action

action: pulumi.Input<string>;

Action to be executed on a header value. Valid values are Append, Delete and Overwrite.

property name

name: pulumi.Input<string>;

The header name.

property value

value?: pulumi.Input<string>;

The value of the header. Only needed when action is set to Append or overwrite.

interface EndpointDeliveryRulePostArgCondition

interface EndpointDeliveryRulePostArgCondition

property matchValues

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

List of string values.

property negateCondition

negateCondition?: pulumi.Input<boolean>;

Defaults to false.

property operator

operator: pulumi.Input<string>;

Valid values are Any, BeginsWith, Contains, EndsWith, Equal, GreaterThan, GreaterThanOrEqual, LessThan and LessThanOrEqual.

property selector

selector: pulumi.Input<string>;

Name of the post arg.

property transforms

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

Valid values are Lowercase and Uppercase.

interface EndpointDeliveryRuleQueryStringCondition

interface EndpointDeliveryRuleQueryStringCondition

property matchValues

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

List of string values.

property negateCondition

negateCondition?: pulumi.Input<boolean>;

Defaults to false.

property operator

operator: pulumi.Input<string>;

Valid values are Any, BeginsWith, Contains, EndsWith, Equal, GreaterThan, GreaterThanOrEqual, LessThan and LessThanOrEqual.

property transforms

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

Valid values are Lowercase and Uppercase.

interface EndpointDeliveryRuleRemoteAddressCondition

interface EndpointDeliveryRuleRemoteAddressCondition

property matchValues

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

List of string values. For GeoMatch operator this should be a list of country codes (e.g. US or DE). List of IP address if operator equals to IPMatch.

property negateCondition

negateCondition?: pulumi.Input<boolean>;

Defaults to false.

property operator

operator: pulumi.Input<string>;

Valid values are Any, GeoMatch and IPMatch.

interface EndpointDeliveryRuleRequestBodyCondition

interface EndpointDeliveryRuleRequestBodyCondition

property matchValues

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

List of string values.

property negateCondition

negateCondition?: pulumi.Input<boolean>;

Defaults to false.

property operator

operator: pulumi.Input<string>;

Valid values are Any, BeginsWith, Contains, EndsWith, Equal, GreaterThan, GreaterThanOrEqual, LessThan and LessThanOrEqual.

property transforms

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

Valid values are Lowercase and Uppercase.

interface EndpointDeliveryRuleRequestHeaderCondition

interface EndpointDeliveryRuleRequestHeaderCondition

property matchValues

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

List of header values.

property negateCondition

negateCondition?: pulumi.Input<boolean>;

Defaults to false.

property operator

operator: pulumi.Input<string>;

Valid values are Any, BeginsWith, Contains, EndsWith, Equal, GreaterThan, GreaterThanOrEqual, LessThan and LessThanOrEqual.

property selector

selector: pulumi.Input<string>;

Header name.

property transforms

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

Valid values are Lowercase and Uppercase.

interface EndpointDeliveryRuleRequestMethodCondition

interface EndpointDeliveryRuleRequestMethodCondition

property matchValues

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

Valid values are DELETE, GET, HEAD, OPTIONS, POST and PUT.

property negateCondition

negateCondition?: pulumi.Input<boolean>;

Defaults to false.

property operator

operator?: pulumi.Input<string>;

Valid values are Equal.

interface EndpointDeliveryRuleRequestSchemeCondition

interface EndpointDeliveryRuleRequestSchemeCondition

property matchValues

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

Valid values are HTTP and HTTPS.

property negateCondition

negateCondition?: pulumi.Input<boolean>;

Defaults to false.

property operator

operator?: pulumi.Input<string>;

Valid values are Equal.

interface EndpointDeliveryRuleRequestUriCondition

interface EndpointDeliveryRuleRequestUriCondition

property matchValues

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

List of string values.

property negateCondition

negateCondition?: pulumi.Input<boolean>;

Defaults to false.

property operator

operator: pulumi.Input<string>;

Valid values are Any, BeginsWith, Contains, EndsWith, Equal, GreaterThan, GreaterThanOrEqual, LessThan and LessThanOrEqual.

property transforms

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

Valid values are Lowercase and Uppercase.

interface EndpointDeliveryRuleUrlFileExtensionCondition

interface EndpointDeliveryRuleUrlFileExtensionCondition

property matchValues

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

List of string values.

property negateCondition

negateCondition?: pulumi.Input<boolean>;

Defaults to false.

property operator

operator: pulumi.Input<string>;

Valid values are Any, BeginsWith, Contains, EndsWith, Equal, GreaterThan, GreaterThanOrEqual, LessThan and LessThanOrEqual.

property transforms

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

Valid values are Lowercase and Uppercase.

interface EndpointDeliveryRuleUrlFileNameCondition

interface EndpointDeliveryRuleUrlFileNameCondition

property matchValues

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

List of string values.

property negateCondition

negateCondition?: pulumi.Input<boolean>;

Defaults to false.

property operator

operator: pulumi.Input<string>;

Valid values are Any, BeginsWith, Contains, EndsWith, Equal, GreaterThan, GreaterThanOrEqual, LessThan and LessThanOrEqual.

property transforms

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

Valid values are Lowercase and Uppercase.

interface EndpointDeliveryRuleUrlPathCondition

interface EndpointDeliveryRuleUrlPathCondition

property matchValues

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

List of string values.

property negateCondition

negateCondition?: pulumi.Input<boolean>;

Defaults to false.

property operator

operator: pulumi.Input<string>;

Valid values are Any, BeginsWith, Contains, EndsWith, Equal, GreaterThan, GreaterThanOrEqual, LessThan and LessThanOrEqual.

property transforms

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

Valid values are Lowercase and Uppercase.

interface EndpointDeliveryRuleUrlRedirectAction

interface EndpointDeliveryRuleUrlRedirectAction

property fragment

fragment?: pulumi.Input<string>;

Specifies the fragment part of the URL. This value must not start with a #.

property hostname

hostname?: pulumi.Input<string>;

Specifies the hostname part of the URL.

property path

path?: pulumi.Input<string>;

Specifies the path part of the URL. This value must begin with a /.

property protocol

protocol?: pulumi.Input<string>;

Specifies the protocol part of the URL. Valid values are Http and Https.

property queryString

queryString?: pulumi.Input<string>;

Specifies the query string part of the URL. This value must not start with a ? or & and must be in <key>=<value> format separated by &.

property redirectType

redirectType: pulumi.Input<string>;

Type of the redirect. Valid values are Found, Moved, PermanentRedirect and TemporaryRedirect.

interface EndpointDeliveryRuleUrlRewriteAction

interface EndpointDeliveryRuleUrlRewriteAction

property destination

destination: pulumi.Input<string>;

This value must start with a / and can’t be longer than 260 characters.

property preserveUnmatchedPath

preserveUnmatchedPath?: pulumi.Input<boolean>;

Defaults to true.

property sourcePattern

sourcePattern: pulumi.Input<string>;

This value must start with a / and can’t be longer than 260 characters.

interface EndpointGeoFilter

interface EndpointGeoFilter

property action

action: pulumi.Input<string>;

The Action of the Geo Filter. Possible values include Allow and Block.

property countryCodes

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

A List of two letter country codes (e.g. US, GB) to be associated with this Geo Filter.

property relativePath

relativePath: pulumi.Input<string>;

The relative path applicable to geo filter.

interface EndpointGlobalDeliveryRule

interface EndpointGlobalDeliveryRule

property cacheExpirationAction

cacheExpirationAction?: pulumi.Input<EndpointGlobalDeliveryRuleCacheExpirationAction>;

A cacheExpirationAction block as defined above.

property cacheKeyQueryStringAction

cacheKeyQueryStringAction?: pulumi.Input<EndpointGlobalDeliveryRuleCacheKeyQueryStringAction>;

A cacheKeyQueryStringAction block as defined above.

property modifyRequestHeaderActions

modifyRequestHeaderActions?: pulumi.Input<pulumi.Input<EndpointGlobalDeliveryRuleModifyRequestHeaderAction>[]>;

A modifyRequestHeaderAction block as defined below.

property modifyResponseHeaderActions

modifyResponseHeaderActions?: pulumi.Input<pulumi.Input<EndpointGlobalDeliveryRuleModifyResponseHeaderAction>[]>;

A modifyResponseHeaderAction block as defined below.

property urlRedirectAction

urlRedirectAction?: pulumi.Input<EndpointGlobalDeliveryRuleUrlRedirectAction>;

A urlRedirectAction block as defined below.

property urlRewriteAction

urlRewriteAction?: pulumi.Input<EndpointGlobalDeliveryRuleUrlRewriteAction>;

A urlRewriteAction block as defined below.

interface EndpointGlobalDeliveryRuleCacheExpirationAction

interface EndpointGlobalDeliveryRuleCacheExpirationAction

property behavior

behavior: pulumi.Input<string>;

The behavior of the cache. Valid values are BypassCache, Override and SetIfMissing.

property duration

duration?: pulumi.Input<string>;

Duration of the cache. Only allowed when behavior is set to Override or SetIfMissing. Format: [d.]hh:mm:ss

interface EndpointGlobalDeliveryRuleCacheKeyQueryStringAction

interface EndpointGlobalDeliveryRuleCacheKeyQueryStringAction

property behavior

behavior: pulumi.Input<string>;

The behavior of the cache key for query strings. Valid values are Exclude, ExcludeAll, Include and IncludeAll.

property parameters

parameters?: pulumi.Input<string>;

Comma separated list of parameter values.

interface EndpointGlobalDeliveryRuleModifyRequestHeaderAction

interface EndpointGlobalDeliveryRuleModifyRequestHeaderAction

property action

action: pulumi.Input<string>;

Action to be executed on a header value. Valid values are Append, Delete and Overwrite.

property name

name: pulumi.Input<string>;

The header name.

property value

value?: pulumi.Input<string>;

The value of the header. Only needed when action is set to Append or overwrite.

interface EndpointGlobalDeliveryRuleModifyResponseHeaderAction

interface EndpointGlobalDeliveryRuleModifyResponseHeaderAction

property action

action: pulumi.Input<string>;

Action to be executed on a header value. Valid values are Append, Delete and Overwrite.

property name

name: pulumi.Input<string>;

The header name.

property value

value?: pulumi.Input<string>;

The value of the header. Only needed when action is set to Append or overwrite.

interface EndpointGlobalDeliveryRuleUrlRedirectAction

interface EndpointGlobalDeliveryRuleUrlRedirectAction

property fragment

fragment?: pulumi.Input<string>;

Specifies the fragment part of the URL. This value must not start with a #.

property hostname

hostname?: pulumi.Input<string>;

Specifies the hostname part of the URL.

property path

path?: pulumi.Input<string>;

Specifies the path part of the URL. This value must begin with a /.

property protocol

protocol?: pulumi.Input<string>;

Specifies the protocol part of the URL. Valid values are Http and Https.

property queryString

queryString?: pulumi.Input<string>;

Specifies the query string part of the URL. This value must not start with a ? or & and must be in <key>=<value> format separated by &.

property redirectType

redirectType: pulumi.Input<string>;

Type of the redirect. Valid values are Found, Moved, PermanentRedirect and TemporaryRedirect.

interface EndpointGlobalDeliveryRuleUrlRewriteAction

interface EndpointGlobalDeliveryRuleUrlRewriteAction

property destination

destination: pulumi.Input<string>;

This value must start with a / and can’t be longer than 260 characters.

property preserveUnmatchedPath

preserveUnmatchedPath?: pulumi.Input<boolean>;

Defaults to true.

property sourcePattern

sourcePattern: pulumi.Input<string>;

This value must start with a / and can’t be longer than 260 characters.

interface EndpointOrigin

interface EndpointOrigin

property hostName

hostName: pulumi.Input<string>;

A string that determines the hostname/IP address of the origin server. This string can be a domain name, Storage Account endpoint, Web App endpoint, IPv4 address or IPv6 address. Changing this forces a new resource to be created.

property httpPort

httpPort?: pulumi.Input<number>;

The HTTP port of the origin. Defaults to 80. Changing this forces a new resource to be created.

property httpsPort

httpsPort?: pulumi.Input<number>;

The HTTPS port of the origin. Defaults to 443. Changing this forces a new resource to be created.

property name

name: pulumi.Input<string>;

The name of the origin. This is an arbitrary value. However, this value needs to be unique under the endpoint. Changing this forces a new resource to be created.

namespace compute

interface BastionHostIpConfiguration

interface BastionHostIpConfiguration

property name

name: pulumi.Input<string>;

The name of the IP configuration.

property publicIpAddressId

publicIpAddressId: pulumi.Input<string>;

Reference to a Public IP Address to associate with this Bastion Host.

property subnetId

subnetId: pulumi.Input<string>;

Reference to a subnet in which this Bastion Host has been created.

interface DiskEncryptionSetIdentity

interface DiskEncryptionSetIdentity

property principalId

principalId?: pulumi.Input<string>;

The (Client) ID of the Service Principal.

property tenantId

tenantId?: pulumi.Input<string>;

The ID of the Tenant the Service Principal is assigned in.

property type

type: pulumi.Input<string>;

The Type of Identity which should be used for this Disk Encryption Set. At this time the only possible value is SystemAssigned.

interface ImageDataDisk

interface ImageDataDisk

property blobUri

blobUri?: pulumi.Input<string>;

Specifies the URI in Azure storage of the blob that you want to use to create the image.

property caching

caching?: pulumi.Input<string>;

Specifies the caching mode as ReadWrite, ReadOnly, or None. The default is None.

property lun

lun?: pulumi.Input<number>;

Specifies the logical unit number of the data disk.

property managedDiskId

managedDiskId?: pulumi.Input<string>;

Specifies the ID of the managed disk resource that you want to use to create the image.

property sizeGb

sizeGb?: pulumi.Input<number>;

Specifies the size of the image to be created. The target size can’t be smaller than the source size.

interface ImageOsDisk

interface ImageOsDisk

property blobUri

blobUri?: pulumi.Input<string>;

Specifies the URI in Azure storage of the blob that you want to use to create the image.

property caching

caching?: pulumi.Input<string>;

Specifies the caching mode as ReadWrite, ReadOnly, or None. The default is None.

property managedDiskId

managedDiskId?: pulumi.Input<string>;

Specifies the ID of the managed disk resource that you want to use to create the image.

property osState

osState?: pulumi.Input<string>;

Specifies the state of the operating system contained in the blob. Currently, the only value is Generalized.

property osType

osType?: pulumi.Input<string>;

Specifies the type of operating system contained in the virtual machine image. Possible values are: Windows or Linux.

property sizeGb

sizeGb?: pulumi.Input<number>;

Specifies the size of the image to be created. The target size can’t be smaller than the source size.

interface LinuxVirtualMachineAdditionalCapabilities

interface LinuxVirtualMachineAdditionalCapabilities

property ultraSsdEnabled

ultraSsdEnabled?: pulumi.Input<boolean>;

Should the capacity to enable Data Disks of the UltraSSD_LRS storage account type be supported on this Virtual Machine? Defaults to false. Changing this forces a new resource to be created.

interface LinuxVirtualMachineAdminSshKey

interface LinuxVirtualMachineAdminSshKey

property publicKey

publicKey: pulumi.Input<string>;

The Public Key which should be used for authentication, which needs to be at least 2048-bit and in ssh-rsa format. Changing this forces a new resource to be created.

property username

username: pulumi.Input<string>;

The Username for which this Public SSH Key should be configured. Changing this forces a new resource to be created.

interface LinuxVirtualMachineBootDiagnostics

interface LinuxVirtualMachineBootDiagnostics

property storageAccountUri

storageAccountUri: pulumi.Input<string>;

The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor.

interface LinuxVirtualMachineIdentity

interface LinuxVirtualMachineIdentity

property identityIds

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

A list of User Managed Identity ID’s which should be assigned to the Linux Virtual Machine.

property principalId

principalId?: pulumi.Input<string>;

The ID of the System Managed Service Principal.

property tenantId

tenantId?: pulumi.Input<string>;

The ID of the Tenant the System Managed Service Principal is assigned in.

property type

type: pulumi.Input<string>;

The type of Managed Identity which should be assigned to the Linux Virtual Machine. Possible values are SystemAssigned, UserAssigned and SystemAssigned, UserAssigned.

interface LinuxVirtualMachineOsDisk

interface LinuxVirtualMachineOsDisk

property caching

caching: pulumi.Input<string>;

The Type of Caching which should be used for the Internal OS Disk. Possible values are None, ReadOnly and ReadWrite.

property diffDiskSettings

diffDiskSettings?: pulumi.Input<LinuxVirtualMachineOsDiskDiffDiskSettings>;

A diffDiskSettings block as defined above.

property diskEncryptionSetId

diskEncryptionSetId?: pulumi.Input<string>;

The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk.

property diskSizeGb

diskSizeGb?: pulumi.Input<number>;

The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine is sourced from.

property name

name?: pulumi.Input<string>;

The name which should be used for the Internal OS Disk. Changing this forces a new resource to be created.

property storageAccountType

storageAccountType: pulumi.Input<string>;

The Type of Storage Account which should back this the Internal OS Disk. Possible values are Standard_LRS, StandardSSD_LRS and Premium_LRS. Changing this forces a new resource to be created.

property writeAcceleratorEnabled

writeAcceleratorEnabled?: pulumi.Input<boolean>;

Should Write Accelerator be Enabled for this OS Disk? Defaults to false.

interface LinuxVirtualMachineOsDiskDiffDiskSettings

interface LinuxVirtualMachineOsDiskDiffDiskSettings

property option

option: pulumi.Input<string>;

Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is Local. Changing this forces a new resource to be created.

interface LinuxVirtualMachinePlan

interface LinuxVirtualMachinePlan

property name

name: pulumi.Input<string>;

Specifies the Name of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.

property product

product: pulumi.Input<string>;

Specifies the Product of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.

property publisher

publisher: pulumi.Input<string>;

Specifies the Publisher of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.

interface LinuxVirtualMachineScaleSetAdditionalCapabilities

interface LinuxVirtualMachineScaleSetAdditionalCapabilities

property ultraSsdEnabled

ultraSsdEnabled?: pulumi.Input<boolean>;

Should the capacity to enable Data Disks of the UltraSSD_LRS storage account type be supported on this Virtual Machine Scale Set? Defaults to false. Changing this forces a new resource to be created.

interface LinuxVirtualMachineScaleSetAdminSshKey

interface LinuxVirtualMachineScaleSetAdminSshKey

property publicKey

publicKey: pulumi.Input<string>;

The Public Key which should be used for authentication, which needs to be at least 2048-bit and in ssh-rsa format.

property username

username: pulumi.Input<string>;

The Username for which this Public SSH Key should be configured.

interface LinuxVirtualMachineScaleSetAutomaticInstanceRepair

interface LinuxVirtualMachineScaleSetAutomaticInstanceRepair

property enabled

enabled: pulumi.Input<boolean>;

Should the automatic instance repair be enabled on this Virtual Machine Scale Set?

property gracePeriod

gracePeriod?: pulumi.Input<string>;

Amount of time (in minutes, between 30 and 90, defaults to 30 minutes) for which automatic repairs will be delayed. The grace period starts right after the VM is found unhealthy. The time duration should be specified in ISO 8601 format.

interface LinuxVirtualMachineScaleSetAutomaticOsUpgradePolicy

interface LinuxVirtualMachineScaleSetAutomaticOsUpgradePolicy

property disableAutomaticRollback

disableAutomaticRollback: pulumi.Input<boolean>;

Should automatic rollbacks be disabled? Changing this forces a new resource to be created.

property enableAutomaticOsUpgrade

enableAutomaticOsUpgrade: pulumi.Input<boolean>;

Should OS Upgrades automatically be applied to Scale Set instances in a rolling fashion when a newer version of the OS Image becomes available? Changing this forces a new resource to be created.

interface LinuxVirtualMachineScaleSetBootDiagnostics

interface LinuxVirtualMachineScaleSetBootDiagnostics

property storageAccountUri

storageAccountUri: pulumi.Input<string>;

The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor.

interface LinuxVirtualMachineScaleSetDataDisk

interface LinuxVirtualMachineScaleSetDataDisk

property caching

caching: pulumi.Input<string>;

The type of Caching which should be used for this Data Disk. Possible values are None, ReadOnly and ReadWrite.

property createOption

createOption?: pulumi.Input<string>;

The create option which should be used for this Data Disk. Possible values are Empty and FromImage. Defaults to Empty. (FromImage should only be used if the source image includes data disks).

property diskEncryptionSetId

diskEncryptionSetId?: pulumi.Input<string>;

The ID of the Disk Encryption Set which should be used to encrypt this Data Disk.

property diskSizeGb

diskSizeGb: pulumi.Input<number>;

The size of the Data Disk which should be created.

property lun

lun: pulumi.Input<number>;

The Logical Unit Number of the Data Disk, which must be unique within the Virtual Machine.

property storageAccountType

storageAccountType: pulumi.Input<string>;

The Type of Storage Account which should back this Data Disk. Possible values include Standard_LRS, StandardSSD_LRS, Premium_LRS and UltraSSD_LRS.

property writeAcceleratorEnabled

writeAcceleratorEnabled?: pulumi.Input<boolean>;

Should Write Accelerator be enabled for this Data Disk? Defaults to false.

interface LinuxVirtualMachineScaleSetIdentity

interface LinuxVirtualMachineScaleSetIdentity

property identityIds

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

A list of User Managed Identity ID’s which should be assigned to the Linux Virtual Machine Scale Set.

property principalId

principalId?: pulumi.Input<string>;

The ID of the System Managed Service Principal.

property type

type: pulumi.Input<string>;

The type of Managed Identity which should be assigned to the Linux Virtual Machine Scale Set. Possible values are SystemAssigned, UserAssigned and SystemAssigned, UserAssigned.

interface LinuxVirtualMachineScaleSetNetworkInterface

interface LinuxVirtualMachineScaleSetNetworkInterface

property dnsServers

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

A list of IP Addresses of DNS Servers which should be assigned to the Network Interface.

property enableAcceleratedNetworking

enableAcceleratedNetworking?: pulumi.Input<boolean>;

Does this Network Interface support Accelerated Networking? Defaults to false.

property enableIpForwarding

enableIpForwarding?: pulumi.Input<boolean>;

Does this Network Interface support IP Forwarding? Defaults to false.

property ipConfigurations

ipConfigurations: pulumi.Input<pulumi.Input<LinuxVirtualMachineScaleSetNetworkInterfaceIpConfiguration>[]>;

One or more ipConfiguration blocks as defined above.

property name

name: pulumi.Input<string>;

The Name which should be used for this Network Interface. Changing this forces a new resource to be created.

property networkSecurityGroupId

networkSecurityGroupId?: pulumi.Input<string>;

The ID of a Network Security Group which should be assigned to this Network Interface.

property primary

primary?: pulumi.Input<boolean>;

Is this the Primary IP Configuration?

interface LinuxVirtualMachineScaleSetNetworkInterfaceIpConfiguration

interface LinuxVirtualMachineScaleSetNetworkInterfaceIpConfiguration

property applicationGatewayBackendAddressPoolIds

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

A list of Backend Address Pools ID’s from a Application Gateway which this Virtual Machine Scale Set should be connected to.

property applicationSecurityGroupIds

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

A list of Application Security Group ID’s which this Virtual Machine Scale Set should be connected to.

property loadBalancerBackendAddressPoolIds

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

A list of Backend Address Pools ID’s from a Load Balancer which this Virtual Machine Scale Set should be connected to.

property loadBalancerInboundNatRulesIds

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

A list of NAT Rule ID’s from a Load Balancer which this Virtual Machine Scale Set should be connected to.

property name

name: pulumi.Input<string>;

The Name which should be used for this IP Configuration.

property primary

primary?: pulumi.Input<boolean>;

Is this the Primary IP Configuration for this Network Interface? Defaults to false.

property publicIpAddresses

publicIpAddresses?: pulumi.Input<pulumi.Input<LinuxVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress>[]>;

A publicIpAddress block as defined below.

property subnetId

subnetId?: pulumi.Input<string>;

The ID of the Subnet which this IP Configuration should be connected to.

property version

version?: pulumi.Input<string>;

The Internet Protocol Version which should be used for this IP Configuration. Possible values are IPv4 and IPv6. Defaults to IPv4.

interface LinuxVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress

interface LinuxVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress

property domainNameLabel

domainNameLabel?: pulumi.Input<string>;

The Prefix which should be used for the Domain Name Label for each Virtual Machine Instance. Azure concatenates the Domain Name Label and Virtual Machine Index to create a unique Domain Name Label for each Virtual Machine.

property idleTimeoutInMinutes

idleTimeoutInMinutes?: pulumi.Input<number>;

The Idle Timeout in Minutes for the Public IP Address. Possible values are in the range 4 to 32.

property ipTags

ipTags?: pulumi.Input<pulumi.Input<LinuxVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag>[]>;

One or more ipTag blocks as defined above.

property name

name: pulumi.Input<string>;

The Name of the Public IP Address Configuration.

property publicIpPrefixId

publicIpPrefixId?: pulumi.Input<string>;

The ID of the Public IP Address Prefix from where Public IP Addresses should be allocated. Changing this forces a new resource to be created.

interface LinuxVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag

interface LinuxVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag

property tag

tag: pulumi.Input<string>;

The IP Tag associated with the Public IP, such as SQL or Storage.

property type

type: pulumi.Input<string>;

The Type of IP Tag, such as FirstPartyUsage.

interface LinuxVirtualMachineScaleSetOsDisk

interface LinuxVirtualMachineScaleSetOsDisk

property caching

caching: pulumi.Input<string>;

The Type of Caching which should be used for the Internal OS Disk. Possible values are None, ReadOnly and ReadWrite.

property diffDiskSettings

diffDiskSettings?: pulumi.Input<LinuxVirtualMachineScaleSetOsDiskDiffDiskSettings>;

A diffDiskSettings block as defined above. Changing this forces a new resource to be created.

property diskEncryptionSetId

diskEncryptionSetId?: pulumi.Input<string>;

The ID of the Disk Encryption Set which should be used to encrypt this OS Disk.

property diskSizeGb

diskSizeGb?: pulumi.Input<number>;

The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine Scale Set is sourced from.

property storageAccountType

storageAccountType: pulumi.Input<string>;

The Type of Storage Account which should back this the Internal OS Disk. Possible values include Standard_LRS, StandardSSD_LRS and Premium_LRS.

property writeAcceleratorEnabled

writeAcceleratorEnabled?: pulumi.Input<boolean>;

Should Write Accelerator be Enabled for this OS Disk? Defaults to false.

interface LinuxVirtualMachineScaleSetOsDiskDiffDiskSettings

interface LinuxVirtualMachineScaleSetOsDiskDiffDiskSettings

property option

option: pulumi.Input<string>;

interface LinuxVirtualMachineScaleSetPlan

interface LinuxVirtualMachineScaleSetPlan

property name

name: pulumi.Input<string>;

The name of the Linux Virtual Machine Scale Set. Changing this forces a new resource to be created.

property product

product: pulumi.Input<string>;

property publisher

publisher: pulumi.Input<string>;

Specifies the publisher of the image used to create the virtual machines.

interface LinuxVirtualMachineScaleSetRollingUpgradePolicy

interface LinuxVirtualMachineScaleSetRollingUpgradePolicy

property maxBatchInstancePercent

maxBatchInstancePercent: pulumi.Input<number>;

The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. Changing this forces a new resource to be created.

property maxUnhealthyInstancePercent

maxUnhealthyInstancePercent: pulumi.Input<number>;

The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. Changing this forces a new resource to be created.

property maxUnhealthyUpgradedInstancePercent

maxUnhealthyUpgradedInstancePercent: pulumi.Input<number>;

The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. Changing this forces a new resource to be created.

property pauseTimeBetweenBatches

pauseTimeBetweenBatches: pulumi.Input<string>;

The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. Changing this forces a new resource to be created.

interface LinuxVirtualMachineScaleSetSecret

interface LinuxVirtualMachineScaleSetSecret

property certificates

certificates: pulumi.Input<pulumi.Input<LinuxVirtualMachineScaleSetSecretCertificate>[]>;

One or more certificate blocks as defined above.

property keyVaultId

keyVaultId: pulumi.Input<string>;

The ID of the Key Vault from which all Secrets should be sourced.

interface LinuxVirtualMachineScaleSetSecretCertificate

interface LinuxVirtualMachineScaleSetSecretCertificate

property url

url: pulumi.Input<string>;

The Secret URL of a Key Vault Certificate.

interface LinuxVirtualMachineScaleSetSourceImageReference

interface LinuxVirtualMachineScaleSetSourceImageReference

property offer

offer: pulumi.Input<string>;

Specifies the offer of the image used to create the virtual machines.

property publisher

publisher: pulumi.Input<string>;

Specifies the publisher of the image used to create the virtual machines.

property sku

sku: pulumi.Input<string>;

Specifies the SKU of the image used to create the virtual machines.

property version

version: pulumi.Input<string>;

Specifies the version of the image used to create the virtual machines.

interface LinuxVirtualMachineScaleSetTerminateNotification

interface LinuxVirtualMachineScaleSetTerminateNotification

property enabled

enabled: pulumi.Input<boolean>;

Should the terminate notification be enabled on this Virtual Machine Scale Set? Defaults to false.

property timeout

timeout?: pulumi.Input<string>;

Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format.

interface LinuxVirtualMachineSecret

interface LinuxVirtualMachineSecret

property certificates

certificates: pulumi.Input<pulumi.Input<LinuxVirtualMachineSecretCertificate>[]>;

One or more certificate blocks as defined above.

property keyVaultId

keyVaultId: pulumi.Input<string>;

The ID of the Key Vault from which all Secrets should be sourced.

interface LinuxVirtualMachineSecretCertificate

interface LinuxVirtualMachineSecretCertificate

property url

url: pulumi.Input<string>;

The Secret URL of a Key Vault Certificate.

interface LinuxVirtualMachineSourceImageReference

interface LinuxVirtualMachineSourceImageReference

property offer

offer: pulumi.Input<string>;

Specifies the offer of the image used to create the virtual machines.

property publisher

publisher: pulumi.Input<string>;

Specifies the publisher of the image used to create the virtual machines.

property sku

sku: pulumi.Input<string>;

Specifies the SKU of the image used to create the virtual machines.

property version

version: pulumi.Input<string>;

Specifies the version of the image used to create the virtual machines.

interface ManagedDiskEncryptionSettings

interface ManagedDiskEncryptionSettings

property diskEncryptionKey

diskEncryptionKey?: pulumi.Input<ManagedDiskEncryptionSettingsDiskEncryptionKey>;

A diskEncryptionKey block as defined above.

property enabled

enabled: pulumi.Input<boolean>;

Is Encryption enabled on this Managed Disk? Changing this forces a new resource to be created.

property keyEncryptionKey

keyEncryptionKey?: pulumi.Input<ManagedDiskEncryptionSettingsKeyEncryptionKey>;

A keyEncryptionKey block as defined below.

interface ManagedDiskEncryptionSettingsDiskEncryptionKey

interface ManagedDiskEncryptionSettingsDiskEncryptionKey

property secretUrl

secretUrl: pulumi.Input<string>;

The URL to the Key Vault Secret used as the Disk Encryption Key. This can be found as id on the azure.keyvault.Secret resource.

property sourceVaultId

sourceVaultId: pulumi.Input<string>;

The ID of the source Key Vault.

interface ManagedDiskEncryptionSettingsKeyEncryptionKey

interface ManagedDiskEncryptionSettingsKeyEncryptionKey

property keyUrl

keyUrl: pulumi.Input<string>;

The URL to the Key Vault Key used as the Key Encryption Key. This can be found as id on the azure.keyvault.Key resource.

property sourceVaultId

sourceVaultId: pulumi.Input<string>;

The ID of the source Key Vault.

interface ScaleSetBootDiagnostics

interface ScaleSetBootDiagnostics

property enabled

enabled?: pulumi.Input<boolean>;

property storageUri

storageUri: pulumi.Input<string>;

interface ScaleSetExtension

interface ScaleSetExtension

property autoUpgradeMinorVersion

autoUpgradeMinorVersion?: pulumi.Input<boolean>;

Specifies whether or not to use the latest minor version available.

property name

name: pulumi.Input<string>;

Specifies the name of the extension.

property protectedSettings

protectedSettings?: pulumi.Input<string>;

The protectedSettings passed to the extension, like settings, these are specified as a JSON object in a string.

property provisionAfterExtensions

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

Specifies a dependency array of extensions required to be executed before, the array stores the name of each extension.

property publisher

publisher: pulumi.Input<string>;

The publisher of the extension, available publishers can be found by using the Azure CLI.

property settings

settings?: pulumi.Input<string>;

The settings passed to the extension, these are specified as a JSON object in a string.

property type

type: pulumi.Input<string>;

The type of extension, available types for a publisher can be found using the Azure CLI.

property typeHandlerVersion

typeHandlerVersion: pulumi.Input<string>;

Specifies the version of the extension to use, available versions can be found using the Azure CLI.

interface ScaleSetIdentity

interface ScaleSetIdentity

property identityIds

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

Specifies a list of user managed identity ids to be assigned to the VMSS. Required if type is UserAssigned.

property principalId

principalId?: pulumi.Input<string>;

property type

type: pulumi.Input<string>;

Specifies the identity type to be assigned to the scale set. Allowable values are SystemAssigned and UserAssigned. For the SystemAssigned identity the scale set’s Service Principal ID (SPN) can be retrieved after the scale set has been created. See documentation for more information.

interface ScaleSetNetworkProfile

interface ScaleSetNetworkProfile

property acceleratedNetworking

acceleratedNetworking?: pulumi.Input<boolean>;

Specifies whether to enable accelerated networking or not. Defaults to false.

property dnsSettings

dnsSettings?: pulumi.Input<ScaleSetNetworkProfileDnsSettings>;

A dnsSettings block as documented below.

property ipConfigurations

ipConfigurations: pulumi.Input<pulumi.Input<ScaleSetNetworkProfileIpConfiguration>[]>;

An ipConfiguration block as documented below.

property ipForwarding

ipForwarding?: pulumi.Input<boolean>;

Whether IP forwarding is enabled on this NIC. Defaults to false.

property name

name: pulumi.Input<string>;

Specifies the name of the network interface configuration.

property networkSecurityGroupId

networkSecurityGroupId?: pulumi.Input<string>;

Specifies the identifier for the network security group.

property primary

primary: pulumi.Input<boolean>;

Indicates whether network interfaces created from the network interface configuration will be the primary NIC of the VM.

interface ScaleSetNetworkProfileDnsSettings

interface ScaleSetNetworkProfileDnsSettings

property dnsServers

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

Specifies an array of dns servers.

interface ScaleSetNetworkProfileIpConfiguration

interface ScaleSetNetworkProfileIpConfiguration

property applicationGatewayBackendAddressPoolIds

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

Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets can use the same application gateway.

property applicationSecurityGroupIds

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

Specifies up to 20 application security group IDs.

property loadBalancerBackendAddressPoolIds

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

Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer.

property loadBalancerInboundNatRulesIds

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

Specifies an array of references to inbound NAT pools for load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer.

property name

name: pulumi.Input<string>;

Specifies name of the IP configuration.

property primary

primary: pulumi.Input<boolean>;

Specifies if this ipConfiguration is the primary one.

property publicIpAddressConfiguration

publicIpAddressConfiguration?: pulumi.Input<ScaleSetNetworkProfileIpConfigurationPublicIpAddressConfiguration>;

Describes a virtual machines scale set IP Configuration’s PublicIPAddress configuration. The publicIpAddressConfiguration is documented below.

property subnetId

subnetId: pulumi.Input<string>;

Specifies the identifier of the subnet.

interface ScaleSetNetworkProfileIpConfigurationPublicIpAddressConfiguration

interface ScaleSetNetworkProfileIpConfigurationPublicIpAddressConfiguration

property domainNameLabel

domainNameLabel: pulumi.Input<string>;

The domain name label for the dns settings.

property idleTimeout

idleTimeout: pulumi.Input<number>;

The idle timeout in minutes. This value must be between 4 and 30.

property name

name: pulumi.Input<string>;

The name of the public ip address configuration

interface ScaleSetOsProfile

interface ScaleSetOsProfile

property adminPassword

adminPassword?: pulumi.Input<string>;

Specifies the administrator password to use for all the instances of virtual machines in a scale set.

property adminUsername

adminUsername: pulumi.Input<string>;

Specifies the administrator account name to use for all the instances of virtual machines in the scale set.

property computerNamePrefix

computerNamePrefix: pulumi.Input<string>;

Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 9 characters long for windows images and 1 - 58 for linux. Changing this forces a new resource to be created.

property customData

customData?: pulumi.Input<string>;

Specifies custom data to supply to the machine. On linux-based systems, this can be used as a cloud-init script. On other systems, this will be copied as a file on disk. Internally, this provider will base64 encode this value before sending it to the API. The maximum length of the binary array is 65535 bytes.

interface ScaleSetOsProfileLinuxConfig

interface ScaleSetOsProfileLinuxConfig

property disablePasswordAuthentication

disablePasswordAuthentication?: pulumi.Input<boolean>;

Specifies whether password authentication should be disabled. Defaults to false. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: pulumi.Input<pulumi.Input<ScaleSetOsProfileLinuxConfigSshKey>[]>;

Specifies a collection of path and keyData to be placed on the virtual machine.

interface ScaleSetOsProfileLinuxConfigSshKey

interface ScaleSetOsProfileLinuxConfigSshKey

property keyData

keyData?: pulumi.Input<string>;

property path

path: pulumi.Input<string>;

interface ScaleSetOsProfileSecret

interface ScaleSetOsProfileSecret

property sourceVaultId

sourceVaultId: pulumi.Input<string>;

Specifies the key vault to use.

property vaultCertificates

vaultCertificates?: pulumi.Input<pulumi.Input<ScaleSetOsProfileSecretVaultCertificate>[]>;

A collection of Vault Certificates as documented below

interface ScaleSetOsProfileSecretVaultCertificate

interface ScaleSetOsProfileSecretVaultCertificate

property certificateStore

certificateStore?: pulumi.Input<string>;

Specifies the certificate store on the Virtual Machine where the certificate should be added to.

property certificateUrl

certificateUrl: pulumi.Input<string>;

It is the Base64 encoding of a JSON Object that which is encoded in UTF-8 of which the contents need to be data, dataType and password.

interface ScaleSetOsProfileWindowsConfig

interface ScaleSetOsProfileWindowsConfig

property additionalUnattendConfigs

additionalUnattendConfigs?: pulumi.Input<pulumi.Input<ScaleSetOsProfileWindowsConfigAdditionalUnattendConfig>[]>;

An Additional Unattended Config block as documented below.

property enableAutomaticUpgrades

enableAutomaticUpgrades?: pulumi.Input<boolean>;

Indicates whether virtual machines in the scale set are enabled for automatic updates.

property provisionVmAgent

provisionVmAgent?: pulumi.Input<boolean>;

Indicates whether virtual machine agent should be provisioned on the virtual machines in the scale set.

property winrms

winrms?: pulumi.Input<pulumi.Input<ScaleSetOsProfileWindowsConfigWinrm>[]>;

A collection of WinRM configuration blocks as documented below.

interface ScaleSetOsProfileWindowsConfigAdditionalUnattendConfig

interface ScaleSetOsProfileWindowsConfigAdditionalUnattendConfig

property component

component: pulumi.Input<string>;

Specifies the name of the component to configure with the added content. The only allowable value is Microsoft-Windows-Shell-Setup.

property content

content: pulumi.Input<string>;

Specifies the base-64 encoded XML formatted content that is added to the unattend.xml file for the specified path and component.

property pass

pass: pulumi.Input<string>;

Specifies the name of the pass that the content applies to. The only allowable value is oobeSystem.

property settingName

settingName: pulumi.Input<string>;

Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

interface ScaleSetOsProfileWindowsConfigWinrm

interface ScaleSetOsProfileWindowsConfigWinrm

property certificateUrl

certificateUrl?: pulumi.Input<string>;

Specifies URL of the certificate with which new Virtual Machines is provisioned.

property protocol

protocol: pulumi.Input<string>;

Specifies the protocol of listener

interface ScaleSetPlan

interface ScaleSetPlan

property name

name: pulumi.Input<string>;

Specifies the name of the image from the marketplace.

property product

product: pulumi.Input<string>;

Specifies the product of the image from the marketplace.

property publisher

publisher: pulumi.Input<string>;

Specifies the publisher of the image.

interface ScaleSetRollingUpgradePolicy

interface ScaleSetRollingUpgradePolicy

property maxBatchInstancePercent

maxBatchInstancePercent?: pulumi.Input<number>;

The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. Defaults to 20.

property maxUnhealthyInstancePercent

maxUnhealthyInstancePercent?: pulumi.Input<number>;

The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. Defaults to 20.

property maxUnhealthyUpgradedInstancePercent

maxUnhealthyUpgradedInstancePercent?: pulumi.Input<number>;

The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. Defaults to 20.

property pauseTimeBetweenBatches

pauseTimeBetweenBatches?: pulumi.Input<string>;

The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format for duration (https://en.wikipedia.org/wiki/ISO_8601#Durations). Defaults to 0 seconds represented as PT0S.

interface ScaleSetSku

interface ScaleSetSku

property capacity

capacity: pulumi.Input<number>;

Specifies the number of virtual machines in the scale set.

property name

name: pulumi.Input<string>;

Specifies the size of virtual machines in a scale set.

property tier

tier?: pulumi.Input<string>;

Specifies the tier of virtual machines in a scale set. Possible values, standard or basic.

interface ScaleSetStorageProfileDataDisk

interface ScaleSetStorageProfileDataDisk

property caching

caching?: pulumi.Input<string>;

Specifies the caching requirements. Possible values include: None (default), ReadOnly, ReadWrite.

property createOption

createOption: pulumi.Input<string>;

Specifies how the data disk should be created. The only possible options are FromImage and Empty.

property diskSizeGb

diskSizeGb?: pulumi.Input<number>;

Specifies the size of the disk in GB. This element is required when creating an empty disk.

property lun

lun: pulumi.Input<number>;

Specifies the Logical Unit Number of the disk in each virtual machine in the scale set.

property managedDiskType

managedDiskType?: pulumi.Input<string>;

Specifies the type of managed disk to create. Value must be either Standard_LRS, StandardSSD_LRS or Premium_LRS.

interface ScaleSetStorageProfileImageReference

interface ScaleSetStorageProfileImageReference

property id

id?: pulumi.Input<string>;

Specifies the ID of the (custom) image to use to create the virtual machine scale set, as in the example below.

property offer

offer?: pulumi.Input<string>;

Specifies the offer of the image used to create the virtual machines.

property publisher

publisher?: pulumi.Input<string>;

Specifies the publisher of the image used to create the virtual machines.

property sku

sku?: pulumi.Input<string>;

Specifies the SKU of the image used to create the virtual machines.

property version

version?: pulumi.Input<string>;

Specifies the version of the image used to create the virtual machines.

interface ScaleSetStorageProfileOsDisk

interface ScaleSetStorageProfileOsDisk

property caching

caching?: pulumi.Input<string>;

Specifies the caching requirements. Possible values include: None (default), ReadOnly, ReadWrite.

property createOption

createOption: pulumi.Input<string>;

Specifies how the virtual machine should be created. The only possible option is FromImage.

property image

image?: pulumi.Input<string>;

Specifies the blob uri for user image. A virtual machine scale set creates an os disk in the same container as the user image. Updating the osDisk image causes the existing disk to be deleted and a new one created with the new image. If the VM scale set is in Manual upgrade mode then the virtual machines are not updated until they have manualUpgrade applied to them. When setting this field osType needs to be specified. Cannot be used when vhdContainers, managedDiskType or storageProfileImageReference are specified.

property managedDiskType

managedDiskType?: pulumi.Input<string>;

Specifies the type of managed disk to create. Value you must be either Standard_LRS, StandardSSD_LRS or Premium_LRS. Cannot be used when vhdContainers or image is specified.

property name

name?: pulumi.Input<string>;

Specifies the disk name. Must be specified when using unmanaged disk (‘managed_disk_type’ property not set).

property osType

osType?: pulumi.Input<string>;

Specifies the operating system Type, valid values are windows, linux.

property vhdContainers

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

Specifies the vhd uri. Cannot be used when image or managedDiskType is specified.

interface SharedImageIdentifier

interface SharedImageIdentifier

property offer

offer: pulumi.Input<string>;

The Offer Name for this Shared Image.

property publisher

publisher: pulumi.Input<string>;

The Publisher Name for this Gallery Image.

property sku

sku: pulumi.Input<string>;

The Name of the SKU for this Gallery Image.

interface SharedImageVersionTargetRegion

interface SharedImageVersionTargetRegion

property name

name: pulumi.Input<string>;

The Azure Region in which this Image Version should exist.

property regionalReplicaCount

regionalReplicaCount: pulumi.Input<number>;

The number of replicas of the Image Version to be created per region.

property storageAccountType

storageAccountType?: pulumi.Input<string>;

The storage account type for the image version. Possible values are Standard_LRS and Standard_ZRS. Defaults to Standard_LRS. You can store all of your image version replicas in Zone Redundant Storage by specifying Standard_ZRS.

interface SnapshotEncryptionSettings

interface SnapshotEncryptionSettings

property diskEncryptionKey

diskEncryptionKey?: pulumi.Input<SnapshotEncryptionSettingsDiskEncryptionKey>;

property enabled

enabled: pulumi.Input<boolean>;

property keyEncryptionKey

keyEncryptionKey?: pulumi.Input<SnapshotEncryptionSettingsKeyEncryptionKey>;

interface SnapshotEncryptionSettingsDiskEncryptionKey

interface SnapshotEncryptionSettingsDiskEncryptionKey

property secretUrl

secretUrl: pulumi.Input<string>;

property sourceVaultId

sourceVaultId: pulumi.Input<string>;

interface SnapshotEncryptionSettingsKeyEncryptionKey

interface SnapshotEncryptionSettingsKeyEncryptionKey

property keyUrl

keyUrl: pulumi.Input<string>;

property sourceVaultId

sourceVaultId: pulumi.Input<string>;

interface VirtualMachineAdditionalCapabilities

interface VirtualMachineAdditionalCapabilities

property ultraSsdEnabled

ultraSsdEnabled: pulumi.Input<boolean>;

Should Ultra SSD disk be enabled for this Virtual Machine?

interface VirtualMachineBootDiagnostics

interface VirtualMachineBootDiagnostics

property enabled

enabled: pulumi.Input<boolean>;

Should Boot Diagnostics be enabled for this Virtual Machine?

property storageUri

storageUri: pulumi.Input<string>;

The Storage Account’s Blob Endpoint which should hold the virtual machine’s diagnostic files.

interface VirtualMachineIdentity

interface VirtualMachineIdentity

property identityIds

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

Specifies a list of user managed identity ids to be assigned to the VM. Required if type is UserAssigned.

property principalId

principalId?: pulumi.Input<string>;

The Principal ID for the Service Principal associated with the Managed Service Identity of this Virtual Machine.

property type

type: pulumi.Input<string>;

The Managed Service Identity Type of this Virtual Machine. Possible values are SystemAssigned (where Azure will generate a Service Principal for you), UserAssigned (where you can specify the Service Principal ID’s) to be used by this Virtual Machine using the identityIds field, and SystemAssigned, UserAssigned which assigns both a system managed identity as well as the specified user assigned identities.

interface VirtualMachineOsProfile

interface VirtualMachineOsProfile

property adminPassword

adminPassword?: pulumi.Input<string>;

The password associated with the local administrator account.

property adminUsername

adminUsername: pulumi.Input<string>;

Specifies the name of the local administrator account.

property computerName

computerName: pulumi.Input<string>;

Specifies the name of the Virtual Machine.

property customData

customData?: pulumi.Input<string>;

Specifies custom data to supply to the machine. On Linux-based systems, this can be used as a cloud-init script. On other systems, this will be copied as a file on disk. Internally, this provider will base64 encode this value before sending it to the API. The maximum length of the binary array is 65535 bytes.

interface VirtualMachineOsProfileLinuxConfig

interface VirtualMachineOsProfileLinuxConfig

property disablePasswordAuthentication

disablePasswordAuthentication: pulumi.Input<boolean>;

Specifies whether password authentication should be disabled. If set to false, an adminPassword must be specified.

property sshKeys

sshKeys?: pulumi.Input<pulumi.Input<VirtualMachineOsProfileLinuxConfigSshKey>[]>;

One or more sshKeys blocks. This field is required if disablePasswordAuthentication is set to true.

interface VirtualMachineOsProfileLinuxConfigSshKey

interface VirtualMachineOsProfileLinuxConfigSshKey

property keyData

keyData: pulumi.Input<string>;

The Public SSH Key which should be written to the path defined above.

property path

path: pulumi.Input<string>;

The path of the destination file on the virtual machine

interface VirtualMachineOsProfileSecret

interface VirtualMachineOsProfileSecret

property sourceVaultId

sourceVaultId: pulumi.Input<string>;

Specifies the ID of the Key Vault to use.

property vaultCertificates

vaultCertificates?: pulumi.Input<pulumi.Input<VirtualMachineOsProfileSecretVaultCertificate>[]>;

One or more vaultCertificates blocks.

interface VirtualMachineOsProfileSecretVaultCertificate

interface VirtualMachineOsProfileSecretVaultCertificate

property certificateStore

certificateStore?: pulumi.Input<string>;

Specifies the certificate store on the Virtual Machine where the certificate should be added to, such as My.

property certificateUrl

certificateUrl: pulumi.Input<string>;

The ID of the Key Vault Secret. Stored secret is the Base64 encoding of a JSON Object that which is encoded in UTF-8 of which the contents need to be:

interface VirtualMachineOsProfileWindowsConfig

interface VirtualMachineOsProfileWindowsConfig

property additionalUnattendConfigs

additionalUnattendConfigs?: pulumi.Input<pulumi.Input<VirtualMachineOsProfileWindowsConfigAdditionalUnattendConfig>[]>;

A additionalUnattendConfig block.

property enableAutomaticUpgrades

enableAutomaticUpgrades?: pulumi.Input<boolean>;

Are automatic updates enabled on this Virtual Machine? Defaults to false.

property provisionVmAgent

provisionVmAgent?: pulumi.Input<boolean>;

Should the Azure Virtual Machine Guest Agent be installed on this Virtual Machine? Defaults to false.

property timezone

timezone?: pulumi.Input<string>;

Specifies the time zone of the virtual machine, the possible values are defined here.

property winrms

winrms?: pulumi.Input<pulumi.Input<VirtualMachineOsProfileWindowsConfigWinrm>[]>;

One or more winrm block.

interface VirtualMachineOsProfileWindowsConfigAdditionalUnattendConfig

interface VirtualMachineOsProfileWindowsConfigAdditionalUnattendConfig

property component

component: pulumi.Input<string>;

Specifies the name of the component to configure with the added content. The only allowable value is Microsoft-Windows-Shell-Setup.

property content

content: pulumi.Input<string>;

Specifies the base-64 encoded XML formatted content that is added to the unattend.xml file for the specified path and component.

property pass

pass: pulumi.Input<string>;

Specifies the name of the pass that the content applies to. The only allowable value is oobeSystem.

property settingName

settingName: pulumi.Input<string>;

Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.

interface VirtualMachineOsProfileWindowsConfigWinrm

interface VirtualMachineOsProfileWindowsConfigWinrm

property certificateUrl

certificateUrl?: pulumi.Input<string>;

The ID of the Key Vault Secret which contains the encrypted Certificate which should be installed on the Virtual Machine. This certificate must also be specified in the vaultCertificates block within the osProfileSecrets block.

property protocol

protocol: pulumi.Input<string>;

Specifies the protocol of listener. Possible values are HTTP or HTTPS.

interface VirtualMachinePlan

interface VirtualMachinePlan

property name

name: pulumi.Input<string>;

Specifies the name of the image from the marketplace.

property product

product: pulumi.Input<string>;

Specifies the product of the image from the marketplace.

property publisher

publisher: pulumi.Input<string>;

Specifies the publisher of the image.

interface VirtualMachineStorageDataDisk

interface VirtualMachineStorageDataDisk

property caching

caching?: pulumi.Input<string>;

Specifies the caching requirements for the Data Disk. Possible values include None, ReadOnly and ReadWrite.

property createOption

createOption: pulumi.Input<string>;

Specifies how the data disk should be created. Possible values are Attach, FromImage and Empty.

property diskSizeGb

diskSizeGb?: pulumi.Input<number>;

Specifies the size of the data disk in gigabytes.

property lun

lun: pulumi.Input<number>;

Specifies the logical unit number of the data disk. This needs to be unique within all the Data Disks on the Virtual Machine.

property managedDiskId

managedDiskId?: pulumi.Input<string>;

Specifies the ID of an Existing Managed Disk which should be attached to this Virtual Machine. When this field is set createOption must be set to Attach.

property managedDiskType

managedDiskType?: pulumi.Input<string>;

Specifies the type of managed disk to create. Possible values are either Standard_LRS, StandardSSD_LRS, Premium_LRS or UltraSSD_LRS.

property name

name: pulumi.Input<string>;

The name of the Data Disk.

property vhdUri

vhdUri?: pulumi.Input<string>;

Specifies the URI of the VHD file backing this Unmanaged Data Disk. Changing this forces a new resource to be created.

property writeAcceleratorEnabled

writeAcceleratorEnabled?: pulumi.Input<boolean>;

Specifies if Write Accelerator is enabled on the disk. This can only be enabled on Premium_LRS managed disks with no caching and M-Series VMs. Defaults to false.

interface VirtualMachineStorageImageReference

interface VirtualMachineStorageImageReference

property id

id?: pulumi.Input<string>;

Specifies the ID of the Custom Image which the Virtual Machine should be created from. Changing this forces a new resource to be created.

property offer

offer?: pulumi.Input<string>;

Specifies the offer of the image used to create the virtual machine. Changing this forces a new resource to be created.

property publisher

publisher?: pulumi.Input<string>;

Specifies the publisher of the image used to create the virtual machine. Changing this forces a new resource to be created.

property sku

sku?: pulumi.Input<string>;

Specifies the SKU of the image used to create the virtual machine. Changing this forces a new resource to be created.

property version

version?: pulumi.Input<string>;

Specifies the version of the image used to create the virtual machine. Changing this forces a new resource to be created.

interface VirtualMachineStorageOsDisk

interface VirtualMachineStorageOsDisk

property caching

caching?: pulumi.Input<string>;

Specifies the caching requirements for the OS Disk. Possible values include None, ReadOnly and ReadWrite.

property createOption

createOption: pulumi.Input<string>;

Specifies how the OS Disk should be created. Possible values are Attach (managed disks only) and FromImage.

property diskSizeGb

diskSizeGb?: pulumi.Input<number>;

Specifies the size of the OS Disk in gigabytes.

property imageUri

imageUri?: pulumi.Input<string>;

Specifies the Image URI in the format publisherName:offer:skus:version. This field can also specify the VHD uri of a custom VM image to clone. When cloning a Custom (Unmanaged) Disk Image the osType field must be set.

property managedDiskId

managedDiskId?: pulumi.Input<string>;

Specifies the ID of an existing Managed Disk which should be attached as the OS Disk of this Virtual Machine. If this is set then the createOption must be set to Attach.

property managedDiskType

managedDiskType?: pulumi.Input<string>;

Specifies the type of Managed Disk which should be created. Possible values are Standard_LRS, StandardSSD_LRS or Premium_LRS.

property name

name: pulumi.Input<string>;

Specifies the name of the OS Disk.

property osType

osType?: pulumi.Input<string>;

Specifies the Operating System on the OS Disk. Possible values are Linux and Windows.

property vhdUri

vhdUri?: pulumi.Input<string>;

Specifies the URI of the VHD file backing this Unmanaged OS Disk. Changing this forces a new resource to be created.

property writeAcceleratorEnabled

writeAcceleratorEnabled?: pulumi.Input<boolean>;

Specifies if Write Accelerator is enabled on the disk. This can only be enabled on Premium_LRS managed disks with no caching and M-Series VMs. Defaults to false.

interface WindowsVirtualMachineAdditionalCapabilities

interface WindowsVirtualMachineAdditionalCapabilities

property ultraSsdEnabled

ultraSsdEnabled?: pulumi.Input<boolean>;

Should the capacity to enable Data Disks of the UltraSSD_LRS storage account type be supported on this Virtual Machine? Defaults to false. Changing this forces a new resource to be created.

interface WindowsVirtualMachineAdditionalUnattendContent

interface WindowsVirtualMachineAdditionalUnattendContent

property content

content: pulumi.Input<string>;

The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.

property setting

setting: pulumi.Input<string>;

The name of the setting to which the content applies. Possible values are AutoLogon and FirstLogonCommands. Changing this forces a new resource to be created.

interface WindowsVirtualMachineBootDiagnostics

interface WindowsVirtualMachineBootDiagnostics

property storageAccountUri

storageAccountUri: pulumi.Input<string>;

The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor.

interface WindowsVirtualMachineIdentity

interface WindowsVirtualMachineIdentity

property identityIds

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

A list of User Managed Identity ID’s which should be assigned to the Windows Virtual Machine.

property principalId

principalId?: pulumi.Input<string>;

The ID of the System Managed Service Principal.

property tenantId

tenantId?: pulumi.Input<string>;

The ID of the Tenant the System Managed Service Principal is assigned in.

property type

type: pulumi.Input<string>;

The type of Managed Identity which should be assigned to the Windows Virtual Machine. Possible values are SystemAssigned, UserAssigned and SystemAssigned, UserAssigned.

interface WindowsVirtualMachineOsDisk

interface WindowsVirtualMachineOsDisk

property caching

caching: pulumi.Input<string>;

The Type of Caching which should be used for the Internal OS Disk. Possible values are None, ReadOnly and ReadWrite.

property diffDiskSettings

diffDiskSettings?: pulumi.Input<WindowsVirtualMachineOsDiskDiffDiskSettings>;

A diffDiskSettings block as defined above.

property diskEncryptionSetId

diskEncryptionSetId?: pulumi.Input<string>;

The ID of the Disk Encryption Set which should be used to Encrypt this OS Disk.

property diskSizeGb

diskSizeGb?: pulumi.Input<number>;

The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine is sourced from.

property name

name?: pulumi.Input<string>;

The name which should be used for the Internal OS Disk. Changing this forces a new resource to be created.

property storageAccountType

storageAccountType: pulumi.Input<string>;

The Type of Storage Account which should back this the Internal OS Disk. Possible values are Standard_LRS, StandardSSD_LRS and Premium_LRS. Changing this forces a new resource to be created.

property writeAcceleratorEnabled

writeAcceleratorEnabled?: pulumi.Input<boolean>;

Should Write Accelerator be Enabled for this OS Disk? Defaults to false.

interface WindowsVirtualMachineOsDiskDiffDiskSettings

interface WindowsVirtualMachineOsDiskDiffDiskSettings

property option

option: pulumi.Input<string>;

Specifies the Ephemeral Disk Settings for the OS Disk. At this time the only possible value is Local. Changing this forces a new resource to be created.

interface WindowsVirtualMachinePlan

interface WindowsVirtualMachinePlan

property name

name: pulumi.Input<string>;

Specifies the Name of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.

property product

product: pulumi.Input<string>;

Specifies the Product of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.

property publisher

publisher: pulumi.Input<string>;

Specifies the Publisher of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.

interface WindowsVirtualMachineScaleSetAdditionalCapabilities

interface WindowsVirtualMachineScaleSetAdditionalCapabilities

property ultraSsdEnabled

ultraSsdEnabled?: pulumi.Input<boolean>;

Should the capacity to enable Data Disks of the UltraSSD_LRS storage account type be supported on this Virtual Machine Scale Set? Defaults to false. Changing this forces a new resource to be created.

interface WindowsVirtualMachineScaleSetAdditionalUnattendContent

interface WindowsVirtualMachineScaleSetAdditionalUnattendContent

property content

content: pulumi.Input<string>;

The XML formatted content that is added to the unattend.xml file for the specified path and component. Changing this forces a new resource to be created.

property setting

setting: pulumi.Input<string>;

The name of the setting to which the content applies. Possible values are AutoLogon and FirstLogonCommands. Changing this forces a new resource to be created.

interface WindowsVirtualMachineScaleSetAutomaticInstanceRepair

interface WindowsVirtualMachineScaleSetAutomaticInstanceRepair

property enabled

enabled: pulumi.Input<boolean>;

Should the automatic instance repair be enabled on this Virtual Machine Scale Set?

property gracePeriod

gracePeriod?: pulumi.Input<string>;

Amount of time (in minutes, between 30 and 90, defaults to 30 minutes) for which automatic repairs will be delayed. The grace period starts right after the VM is found unhealthy. The time duration should be specified in ISO 8601 format.

interface WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicy

interface WindowsVirtualMachineScaleSetAutomaticOsUpgradePolicy

property disableAutomaticRollback

disableAutomaticRollback: pulumi.Input<boolean>;

Should automatic rollbacks be disabled? Changing this forces a new resource to be created.

property enableAutomaticOsUpgrade

enableAutomaticOsUpgrade: pulumi.Input<boolean>;

Should OS Upgrades automatically be applied to Scale Set instances in a rolling fashion when a newer version of the OS Image becomes available? Changing this forces a new resource to be created.

interface WindowsVirtualMachineScaleSetBootDiagnostics

interface WindowsVirtualMachineScaleSetBootDiagnostics

property storageAccountUri

storageAccountUri: pulumi.Input<string>;

The Primary/Secondary Endpoint for the Azure Storage Account which should be used to store Boot Diagnostics, including Console Output and Screenshots from the Hypervisor.

interface WindowsVirtualMachineScaleSetDataDisk

interface WindowsVirtualMachineScaleSetDataDisk

property caching

caching: pulumi.Input<string>;

The type of Caching which should be used for this Data Disk. Possible values are None, ReadOnly and ReadWrite.

property createOption

createOption?: pulumi.Input<string>;

The create option which should be used for this Data Disk. Possible values are Empty and FromImage. Defaults to Empty. (FromImage should only be used if the source image includes data disks).

property diskEncryptionSetId

diskEncryptionSetId?: pulumi.Input<string>;

The ID of the Disk Encryption Set which should be used to encrypt this Data Disk.

property diskSizeGb

diskSizeGb: pulumi.Input<number>;

The size of the Data Disk which should be created.

property lun

lun: pulumi.Input<number>;

The Logical Unit Number of the Data Disk, which must be unique within the Virtual Machine.

property storageAccountType

storageAccountType: pulumi.Input<string>;

The Type of Storage Account which should back this Data Disk. Possible values include Standard_LRS, StandardSSD_LRS, Premium_LRS and UltraSSD_LRS.

property writeAcceleratorEnabled

writeAcceleratorEnabled?: pulumi.Input<boolean>;

Should Write Accelerator be enabled for this Data Disk? Defaults to false.

interface WindowsVirtualMachineScaleSetIdentity

interface WindowsVirtualMachineScaleSetIdentity

property identityIds

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

A list of User Managed Identity ID’s which should be assigned to the Windows Virtual Machine Scale Set.

property principalId

principalId?: pulumi.Input<string>;

The ID of the System Managed Service Principal.

property type

type: pulumi.Input<string>;

The type of Managed Identity which should be assigned to the Windows Virtual Machine Scale Set. Possible values are SystemAssigned, UserAssigned and SystemAssigned, UserAssigned.

interface WindowsVirtualMachineScaleSetNetworkInterface

interface WindowsVirtualMachineScaleSetNetworkInterface

property dnsServers

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

A list of IP Addresses of DNS Servers which should be assigned to the Network Interface.

property enableAcceleratedNetworking

enableAcceleratedNetworking?: pulumi.Input<boolean>;

Does this Network Interface support Accelerated Networking? Defaults to false.

property enableIpForwarding

enableIpForwarding?: pulumi.Input<boolean>;

Does this Network Interface support IP Forwarding? Defaults to false.

property ipConfigurations

ipConfigurations: pulumi.Input<pulumi.Input<WindowsVirtualMachineScaleSetNetworkInterfaceIpConfiguration>[]>;

One or more ipConfiguration blocks as defined above.

property name

name: pulumi.Input<string>;

The Name which should be used for this Network Interface. Changing this forces a new resource to be created.

property networkSecurityGroupId

networkSecurityGroupId?: pulumi.Input<string>;

The ID of a Network Security Group which should be assigned to this Network Interface.

property primary

primary?: pulumi.Input<boolean>;

Is this the Primary IP Configuration?

interface WindowsVirtualMachineScaleSetNetworkInterfaceIpConfiguration

interface WindowsVirtualMachineScaleSetNetworkInterfaceIpConfiguration

property applicationGatewayBackendAddressPoolIds

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

A list of Backend Address Pools ID’s from a Application Gateway which this Virtual Machine Scale Set should be connected to.

property applicationSecurityGroupIds

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

A list of Application Security Group ID’s which this Virtual Machine Scale Set should be connected to.

property loadBalancerBackendAddressPoolIds

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

A list of Backend Address Pools ID’s from a Load Balancer which this Virtual Machine Scale Set should be connected to.

property loadBalancerInboundNatRulesIds

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

A list of NAT Rule ID’s from a Load Balancer which this Virtual Machine Scale Set should be connected to.

property name

name: pulumi.Input<string>;

The Name which should be used for this IP Configuration.

property primary

primary?: pulumi.Input<boolean>;

Is this the Primary IP Configuration for this Network Interface? Defaults to false.

property publicIpAddresses

publicIpAddresses?: pulumi.Input<pulumi.Input<WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress>[]>;

A publicIpAddress block as defined below.

property subnetId

subnetId?: pulumi.Input<string>;

The ID of the Subnet which this IP Configuration should be connected to.

property version

version?: pulumi.Input<string>;

The Internet Protocol Version which should be used for this IP Configuration. Possible values are IPv4 and IPv6. Defaults to IPv4.

interface WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress

interface WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress

property domainNameLabel

domainNameLabel?: pulumi.Input<string>;

The Prefix which should be used for the Domain Name Label for each Virtual Machine Instance. Azure concatenates the Domain Name Label and Virtual Machine Index to create a unique Domain Name Label for each Virtual Machine.

property idleTimeoutInMinutes

idleTimeoutInMinutes?: pulumi.Input<number>;

The Idle Timeout in Minutes for the Public IP Address. Possible values are in the range 4 to 32.

property ipTags

ipTags?: pulumi.Input<pulumi.Input<WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag>[]>;

One or more ipTag blocks as defined above.

property name

name: pulumi.Input<string>;

The Name of the Public IP Address Configuration.

property publicIpPrefixId

publicIpPrefixId?: pulumi.Input<string>;

The ID of the Public IP Address Prefix from where Public IP Addresses should be allocated. Changing this forces a new resource to be created.

interface WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag

interface WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag

property tag

tag: pulumi.Input<string>;

The IP Tag associated with the Public IP, such as SQL or Storage.

property type

type: pulumi.Input<string>;

The Type of IP Tag, such as FirstPartyUsage.

interface WindowsVirtualMachineScaleSetOsDisk

interface WindowsVirtualMachineScaleSetOsDisk

property caching

caching: pulumi.Input<string>;

The Type of Caching which should be used for the Internal OS Disk. Possible values are None, ReadOnly and ReadWrite.

property diffDiskSettings

diffDiskSettings?: pulumi.Input<WindowsVirtualMachineScaleSetOsDiskDiffDiskSettings>;

A diffDiskSettings block as defined above. Changing this forces a new resource to be created.

property diskEncryptionSetId

diskEncryptionSetId?: pulumi.Input<string>;

The ID of the Disk Encryption Set which should be used to encrypt this OS Disk.

property diskSizeGb

diskSizeGb?: pulumi.Input<number>;

The Size of the Internal OS Disk in GB, if you wish to vary from the size used in the image this Virtual Machine Scale Set is sourced from.

property storageAccountType

storageAccountType: pulumi.Input<string>;

The Type of Storage Account which should back this the Internal OS Disk. Possible values include Standard_LRS, StandardSSD_LRS and Premium_LRS.

property writeAcceleratorEnabled

writeAcceleratorEnabled?: pulumi.Input<boolean>;

Should Write Accelerator be Enabled for this OS Disk? Defaults to false.

interface WindowsVirtualMachineScaleSetOsDiskDiffDiskSettings

interface WindowsVirtualMachineScaleSetOsDiskDiffDiskSettings

property option

option: pulumi.Input<string>;

interface WindowsVirtualMachineScaleSetPlan

interface WindowsVirtualMachineScaleSetPlan

property name

name: pulumi.Input<string>;

The name of the Windows Virtual Machine Scale Set. Changing this forces a new resource to be created.

property product

product: pulumi.Input<string>;

property publisher

publisher: pulumi.Input<string>;

Specifies the publisher of the image used to create the virtual machines.

interface WindowsVirtualMachineScaleSetRollingUpgradePolicy

interface WindowsVirtualMachineScaleSetRollingUpgradePolicy

property maxBatchInstancePercent

maxBatchInstancePercent: pulumi.Input<number>;

The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. Changing this forces a new resource to be created.

property maxUnhealthyInstancePercent

maxUnhealthyInstancePercent: pulumi.Input<number>;

The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. Changing this forces a new resource to be created.

property maxUnhealthyUpgradedInstancePercent

maxUnhealthyUpgradedInstancePercent: pulumi.Input<number>;

The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. Changing this forces a new resource to be created.

property pauseTimeBetweenBatches

pauseTimeBetweenBatches: pulumi.Input<string>;

The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. Changing this forces a new resource to be created.

interface WindowsVirtualMachineScaleSetSecret

interface WindowsVirtualMachineScaleSetSecret

property certificates

certificates: pulumi.Input<pulumi.Input<WindowsVirtualMachineScaleSetSecretCertificate>[]>;

One or more certificate blocks as defined above.

property keyVaultId

keyVaultId: pulumi.Input<string>;

The ID of the Key Vault from which all Secrets should be sourced.

interface WindowsVirtualMachineScaleSetSecretCertificate

interface WindowsVirtualMachineScaleSetSecretCertificate

property store

store: pulumi.Input<string>;

The certificate store on the Virtual Machine where the certificate should be added.

property url

url: pulumi.Input<string>;

The Secret URL of a Key Vault Certificate.

interface WindowsVirtualMachineScaleSetSourceImageReference

interface WindowsVirtualMachineScaleSetSourceImageReference

property offer

offer: pulumi.Input<string>;

Specifies the offer of the image used to create the virtual machines.

property publisher

publisher: pulumi.Input<string>;

Specifies the publisher of the image used to create the virtual machines.

property sku

sku: pulumi.Input<string>;

Specifies the SKU of the image used to create the virtual machines.

property version

version: pulumi.Input<string>;

Specifies the version of the image used to create the virtual machines.

interface WindowsVirtualMachineScaleSetTerminateNotification

interface WindowsVirtualMachineScaleSetTerminateNotification

property enabled

enabled: pulumi.Input<boolean>;

Should the terminate notification be enabled on this Virtual Machine Scale Set? Defaults to false.

property timeout

timeout?: pulumi.Input<string>;

Length of time (in minutes, between 5 and 15) a notification to be sent to the VM on the instance metadata server till the VM gets deleted. The time duration should be specified in ISO 8601 format.

interface WindowsVirtualMachineScaleSetWinrmListener

interface WindowsVirtualMachineScaleSetWinrmListener

property certificateUrl

certificateUrl?: pulumi.Input<string>;

The Secret URL of a Key Vault Certificate, which must be specified when protocol is set to Https.

property protocol

protocol: pulumi.Input<string>;

The Protocol of the WinRM Listener. Possible values are Http and Https.

interface WindowsVirtualMachineSecret

interface WindowsVirtualMachineSecret

property certificates

certificates: pulumi.Input<pulumi.Input<WindowsVirtualMachineSecretCertificate>[]>;

One or more certificate blocks as defined above.

property keyVaultId

keyVaultId: pulumi.Input<string>;

The ID of the Key Vault from which all Secrets should be sourced.

interface WindowsVirtualMachineSecretCertificate

interface WindowsVirtualMachineSecretCertificate

property store

store: pulumi.Input<string>;

The certificate store on the Virtual Machine where the certificate should be added.

property url

url: pulumi.Input<string>;

The Secret URL of a Key Vault Certificate.

interface WindowsVirtualMachineSourceImageReference

interface WindowsVirtualMachineSourceImageReference

property offer

offer: pulumi.Input<string>;

(Optional) Specifies the offer of the image used to create the virtual machines.

property publisher

publisher: pulumi.Input<string>;

Specifies the Publisher of the Marketplace Image this Virtual Machine should be created from. Changing this forces a new resource to be created.

property sku

sku: pulumi.Input<string>;

(Optional) Specifies the SKU of the image used to create the virtual machines.

property version

version: pulumi.Input<string>;

(Optional) Specifies the version of the image used to create the virtual machines.

interface WindowsVirtualMachineWinrmListener

interface WindowsVirtualMachineWinrmListener

property certificateUrl

certificateUrl?: pulumi.Input<string>;

The Secret URL of a Key Vault Certificate, which must be specified when protocol is set to Https.

property protocol

protocol: pulumi.Input<string>;

namespace containerservice

interface GroupContainer

interface GroupContainer

property commands

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

A list of commands which should be run on the container. Changing this forces a new resource to be created.

property cpu

cpu: pulumi.Input<number>;

The required number of CPU cores of the containers. Changing this forces a new resource to be created.

property environmentVariables

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

A list of environment variables to be set on the container. Specified as a map of name/value pairs. Changing this forces a new resource to be created.

property gpu

gpu?: pulumi.Input<GroupContainerGpu>;

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

property image

image: pulumi.Input<string>;

The container image name. Changing this forces a new resource to be created.

property livenessProbe

livenessProbe?: pulumi.Input<GroupContainerLivenessProbe>;

The definition of a readiness probe for this container as documented in the livenessProbe block below. Changing this forces a new resource to be created.

property memory

memory: pulumi.Input<number>;

The required memory of the containers in GB. 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 ports

ports?: pulumi.Input<pulumi.Input<GroupContainerPort>[]>;

A set of public ports for the container. Changing this forces a new resource to be created. Set as documented in the ports block below.

property readinessProbe

readinessProbe?: pulumi.Input<GroupContainerReadinessProbe>;

The definition of a readiness probe for this container as documented in the readinessProbe block below. Changing this forces a new resource to be created.

property secureEnvironmentVariables

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

A list of sensitive environment variables to be set on the container. Specified as a map of name/value pairs. Changing this forces a new resource to be created.

property volumes

volumes?: pulumi.Input<pulumi.Input<GroupContainerVolume>[]>;

The definition of a volume mount for this container as documented in the volume block below. Changing this forces a new resource to be created.

interface GroupContainerGpu

interface GroupContainerGpu

property count

count?: pulumi.Input<number>;

The number of GPUs which should be assigned to this container. Allowed values are 1, 2, or 4. Changing this forces a new resource to be created.

property sku

sku?: pulumi.Input<string>;

The Sku which should be used for the GPU. Possible values are K80, P100, or V100. Changing this forces a new resource to be created.

interface GroupContainerLivenessProbe

interface GroupContainerLivenessProbe

property execs

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

Commands to be run to validate container readiness. Changing this forces a new resource to be created.

property failureThreshold

failureThreshold?: pulumi.Input<number>;

How many times to try the probe before restarting the container (liveness probe) or marking the container as unhealthy (readiness probe). The default value is 3 and the minimum value is 1. Changing this forces a new resource to be created.

property httpGets

httpGets?: pulumi.Input<pulumi.Input<GroupContainerLivenessProbeHttpGet>[]>;

The definition of the httpget for this container as documented in the httpget block below. Changing this forces a new resource to be created.

property initialDelaySeconds

initialDelaySeconds?: pulumi.Input<number>;

Number of seconds after the container has started before liveness or readiness probes are initiated. Changing this forces a new resource to be created.

property periodSeconds

periodSeconds?: pulumi.Input<number>;

How often (in seconds) to perform the probe. The default value is 10 and the minimum value is 1. Changing this forces a new resource to be created.

property successThreshold

successThreshold?: pulumi.Input<number>;

Minimum consecutive successes for the probe to be considered successful after having failed. The default value is 1 and the minimum value is 1. Changing this forces a new resource to be created.

property timeoutSeconds

timeoutSeconds?: pulumi.Input<number>;

Number of seconds after which the probe times out. The default value is 1 and the minimum value is 1. Changing this forces a new resource to be created.

interface GroupContainerLivenessProbeHttpGet

interface GroupContainerLivenessProbeHttpGet

property path

path?: pulumi.Input<string>;

Path to access on the HTTP server. Changing this forces a new resource to be created.

property port

port?: pulumi.Input<number>;

The port number the container will expose. Changing this forces a new resource to be created.

property scheme

scheme?: pulumi.Input<string>;

Scheme to use for connecting to the host. Possible values are Http and Https. Changing this forces a new resource to be created.

interface GroupContainerPort

interface GroupContainerPort

property port

port?: pulumi.Input<number>;

The port number the container will expose. Changing this forces a new resource to be created.

property protocol

protocol?: pulumi.Input<string>;

The network protocol associated with port. Possible values are TCP & UDP. Changing this forces a new resource to be created.

interface GroupContainerReadinessProbe

interface GroupContainerReadinessProbe

property execs

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

Commands to be run to validate container readiness. Changing this forces a new resource to be created.

property failureThreshold

failureThreshold?: pulumi.Input<number>;

How many times to try the probe before restarting the container (liveness probe) or marking the container as unhealthy (readiness probe). The default value is 3 and the minimum value is 1. Changing this forces a new resource to be created.

property httpGets

httpGets?: pulumi.Input<pulumi.Input<GroupContainerReadinessProbeHttpGet>[]>;

The definition of the httpget for this container as documented in the httpget block below. Changing this forces a new resource to be created.

property initialDelaySeconds

initialDelaySeconds?: pulumi.Input<number>;

Number of seconds after the container has started before liveness or readiness probes are initiated. Changing this forces a new resource to be created.

property periodSeconds

periodSeconds?: pulumi.Input<number>;

How often (in seconds) to perform the probe. The default value is 10 and the minimum value is 1. Changing this forces a new resource to be created.

property successThreshold

successThreshold?: pulumi.Input<number>;

Minimum consecutive successes for the probe to be considered successful after having failed. The default value is 1 and the minimum value is 1. Changing this forces a new resource to be created.

property timeoutSeconds

timeoutSeconds?: pulumi.Input<number>;

Number of seconds after which the probe times out. The default value is 1 and the minimum value is 1. Changing this forces a new resource to be created.

interface GroupContainerReadinessProbeHttpGet

interface GroupContainerReadinessProbeHttpGet

property path

path?: pulumi.Input<string>;

Path to access on the HTTP server. Changing this forces a new resource to be created.

property port

port?: pulumi.Input<number>;

The port number the container will expose. Changing this forces a new resource to be created.

property scheme

scheme?: pulumi.Input<string>;

Scheme to use for connecting to the host. Possible values are Http and Https. Changing this forces a new resource to be created.

interface GroupContainerVolume

interface GroupContainerVolume

property mountPath

mountPath: pulumi.Input<string>;

The path on which this volume is to be mounted. 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 readOnly

readOnly?: pulumi.Input<boolean>;

Specify if the volume is to be mounted as read only or not. The default value is false. Changing this forces a new resource to be created.

property shareName

shareName: pulumi.Input<string>;

The Azure storage share that is to be mounted as a volume. This must be created on the storage account specified as above. Changing this forces a new resource to be created.

property storageAccountKey

storageAccountKey: pulumi.Input<string>;

The access key for the Azure Storage account specified as above. Changing this forces a new resource to be created.

property storageAccountName

storageAccountName: pulumi.Input<string>;

The Azure storage account from which the volume is to be mounted. Changing this forces a new resource to be created.

interface GroupDiagnostics

interface GroupDiagnostics

property logAnalytics

logAnalytics: pulumi.Input<GroupDiagnosticsLogAnalytics>;

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

interface GroupDiagnosticsLogAnalytics

interface GroupDiagnosticsLogAnalytics

property logType

logType?: pulumi.Input<string>;

The log type which should be used. Possible values are ContainerInsights and ContainerInstanceLogs. Changing this forces a new resource to be created.

property metadata

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

Any metadata required for Log Analytics. Changing this forces a new resource to be created.

property workspaceId

workspaceId: pulumi.Input<string>;

The Workspace ID of the Log Analytics Workspace. Changing this forces a new resource to be created.

property workspaceKey

workspaceKey: pulumi.Input<string>;

The Workspace Key of the Log Analytics Workspace. Changing this forces a new resource to be created.

interface GroupIdentity

interface GroupIdentity

property identityIds

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

Specifies a list of user managed identity ids to be assigned. Required if type is UserAssigned. Changing this forces a new resource to be created.

property principalId

principalId?: pulumi.Input<string>;

property type

type: pulumi.Input<string>;

The Managed Service Identity Type of this container group. Possible values are SystemAssigned (where Azure will generate a Service Principal for you), UserAssigned where you can specify the Service Principal IDs in the identityIds field, and SystemAssigned, UserAssigned which assigns both a system managed identity as well as the specified user assigned identities. Changing this forces a new resource to be created.

interface GroupImageRegistryCredential

interface GroupImageRegistryCredential

property password

password: pulumi.Input<string>;

The password with which to connect to the registry. Changing this forces a new resource to be created.

property server

server: pulumi.Input<string>;

The address to use to connect to the registry without protocol (“https”/“http”). For example: “myacr.acr.io”. Changing this forces a new resource to be created.

property username

username: pulumi.Input<string>;

The username with which to connect to the registry. Changing this forces a new resource to be created.

interface KubernetesClusterAddonProfile

interface KubernetesClusterAddonProfile

property aciConnectorLinux

aciConnectorLinux?: pulumi.Input<KubernetesClusterAddonProfileAciConnectorLinux>;

A aciConnectorLinux block. For more details, please visit Create and configure an AKS cluster to use virtual nodes.

property azurePolicy

azurePolicy?: pulumi.Input<KubernetesClusterAddonProfileAzurePolicy>;

A azurePolicy block as defined below. For more details please visit Understand Azure Policy for Azure Kubernetes Service

property httpApplicationRouting

httpApplicationRouting?: pulumi.Input<KubernetesClusterAddonProfileHttpApplicationRouting>;

A httpApplicationRouting block as defined below.

property kubeDashboard

kubeDashboard?: pulumi.Input<KubernetesClusterAddonProfileKubeDashboard>;

A kubeDashboard block as defined below.

property omsAgent

omsAgent?: pulumi.Input<KubernetesClusterAddonProfileOmsAgent>;

A omsAgent block as defined below. For more details, please visit How to onboard Azure Monitor for containers.

interface KubernetesClusterAddonProfileAciConnectorLinux

interface KubernetesClusterAddonProfileAciConnectorLinux

property enabled

enabled: pulumi.Input<boolean>;

Is the virtual node addon enabled?

property subnetName

subnetName?: pulumi.Input<string>;

The subnet name for the virtual nodes to run. This is required when aciConnectorLinux enabled argument is set to true.

interface KubernetesClusterAddonProfileAzurePolicy

interface KubernetesClusterAddonProfileAzurePolicy

property enabled

enabled: pulumi.Input<boolean>;

Is the Azure Policy for Kubernetes Add On enabled?

interface KubernetesClusterAddonProfileHttpApplicationRouting

interface KubernetesClusterAddonProfileHttpApplicationRouting

property enabled

enabled: pulumi.Input<boolean>;

Is HTTP Application Routing Enabled? Changing this forces a new resource to be created.

property httpApplicationRoutingZoneName

httpApplicationRoutingZoneName?: pulumi.Input<string>;

The Zone Name of the HTTP Application Routing.

interface KubernetesClusterAddonProfileKubeDashboard

interface KubernetesClusterAddonProfileKubeDashboard

property enabled

enabled: pulumi.Input<boolean>;

Is the Kubernetes Dashboard enabled?

interface KubernetesClusterAddonProfileOmsAgent

interface KubernetesClusterAddonProfileOmsAgent

property enabled

enabled: pulumi.Input<boolean>;

Is the OMS Agent Enabled?

property logAnalyticsWorkspaceId

logAnalyticsWorkspaceId?: pulumi.Input<string>;

The ID of the Log Analytics Workspace which the OMS Agent should send data to. Must be present if enabled is true.

property omsAgentIdentities

omsAgentIdentities?: pulumi.Input<pulumi.Input<KubernetesClusterAddonProfileOmsAgentOmsAgentIdentity>[]>;

An omsAgentIdentity block as defined below.

interface KubernetesClusterAddonProfileOmsAgentOmsAgentIdentity

interface KubernetesClusterAddonProfileOmsAgentOmsAgentIdentity

property clientId

clientId?: pulumi.Input<string>;

The Client ID for the Service Principal.

property objectId

objectId?: pulumi.Input<string>;

The Object ID of the user-defined Managed Identity used by the OMS Agents.

property userAssignedIdentityId

userAssignedIdentityId?: pulumi.Input<string>;

The ID of the User Assigned Identity used by the OMS Agents.

interface KubernetesClusterAutoScalerProfile

interface KubernetesClusterAutoScalerProfile

property balanceSimilarNodeGroups

balanceSimilarNodeGroups?: pulumi.Input<boolean>;

Detect similar node groups and balance the number of nodes between them. Defaults to false.

property maxGracefulTerminationSec

maxGracefulTerminationSec?: pulumi.Input<string>;

Maximum number of seconds the cluster autoscaler waits for pod termination when trying to scale down a node. Defaults to 600.

property scaleDownDelayAfterAdd

scaleDownDelayAfterAdd?: pulumi.Input<string>;

How long after the scale up of AKS nodes the scale down evaluation resumes. Defaults to 10m.

property scaleDownDelayAfterDelete

scaleDownDelayAfterDelete?: pulumi.Input<string>;

How long after node deletion that scale down evaluation resumes. Defaults to the value used for scanInterval.

property scaleDownDelayAfterFailure

scaleDownDelayAfterFailure?: pulumi.Input<string>;

How long after scale down failure that scale down evaluation resumes. Defaults to 3m.

property scaleDownUnneeded

scaleDownUnneeded?: pulumi.Input<string>;

How long a node should be unneeded before it is eligible for scale down. Defaults to 10m.

property scaleDownUnready

scaleDownUnready?: pulumi.Input<string>;

How long an unready node should be unneeded before it is eligible for scale down. Defaults to 20m.

property scaleDownUtilizationThreshold

scaleDownUtilizationThreshold?: pulumi.Input<string>;

Node utilization level, defined as sum of requested resources divided by capacity, below which a node can be considered for scale down. Defaults to 0.5.

property scanInterval

scanInterval?: pulumi.Input<string>;

How often the AKS Cluster should be re-evaluated for scale up/down. Defaults to 10s.

interface KubernetesClusterDefaultNodePool

interface KubernetesClusterDefaultNodePool

property availabilityZones

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

A list of Availability Zones across which the Node Pool should be spread.

property enableAutoScaling

enableAutoScaling?: pulumi.Input<boolean>;

Should the Kubernetes Auto Scaler be enabled for this Node Pool? Defaults to false.

property enableNodePublicIp

enableNodePublicIp?: pulumi.Input<boolean>;

Should nodes in this Node Pool have a Public IP Address? Defaults to false.

property maxCount

maxCount?: pulumi.Input<number>;

The maximum number of nodes which should exist in this Node Pool. If specified this must be between 1 and 100.

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 in this Node Pool. If specified this must be between 1 and 100.

property name

name: pulumi.Input<string>;

The name which should be used for the default Kubernetes Node Pool. Changing this forces a new resource to be created.

property nodeCount

nodeCount?: pulumi.Input<number>;

The initial number of nodes which should exist in this Node Pool. If specified this must be between 1 and 100 and between minCount and maxCount.

property nodeLabels

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

A map of Kubernetes labels which should be applied to nodes in the Default 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 size of the OS Disk which should be used for each agent in the Node Pool. 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 Node Pool.

property type

type?: pulumi.Input<string>;

The type of Node Pool which should be created. Possible values are AvailabilitySet and VirtualMachineScaleSets. Defaults to VirtualMachineScaleSets.

property vmSize

vmSize: pulumi.Input<string>;

The size of the Virtual Machine, such as Standard_DS2_v2.

property vnetSubnetId

vnetSubnetId?: pulumi.Input<string>;

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

interface KubernetesClusterIdentity

interface KubernetesClusterIdentity

property principalId

principalId?: pulumi.Input<string>;

The principal id of the system assigned identity which is used by master components.

property tenantId

tenantId?: pulumi.Input<string>;

The Tenant ID used for Azure Active Directory Application. If this isn’t specified the Tenant ID of the current Subscription is used.

property type

type: pulumi.Input<string>;

The type of identity used for the managed cluster. At this time the only supported value is SystemAssigned.

interface KubernetesClusterKubeAdminConfig

interface KubernetesClusterKubeAdminConfig

property clientCertificate

clientCertificate?: pulumi.Input<string>;

Base64 encoded public certificate used by clients to authenticate to the Kubernetes cluster.

property clientKey

clientKey?: pulumi.Input<string>;

Base64 encoded private key used by clients to authenticate to the Kubernetes cluster.

property clusterCaCertificate

clusterCaCertificate?: pulumi.Input<string>;

Base64 encoded public CA certificate used as the root of trust for the Kubernetes cluster.

property host

host?: pulumi.Input<string>;

The Kubernetes cluster server host.

property password

password?: pulumi.Input<string>;

A password or token used to authenticate to the Kubernetes cluster.

property username

username?: pulumi.Input<string>;

A username used to authenticate to the Kubernetes cluster.

interface KubernetesClusterKubeConfig

interface KubernetesClusterKubeConfig

property clientCertificate

clientCertificate?: pulumi.Input<string>;

Base64 encoded public certificate used by clients to authenticate to the Kubernetes cluster.

property clientKey

clientKey?: pulumi.Input<string>;

Base64 encoded private key used by clients to authenticate to the Kubernetes cluster.

property clusterCaCertificate

clusterCaCertificate?: pulumi.Input<string>;

Base64 encoded public CA certificate used as the root of trust for the Kubernetes cluster.

property host

host?: pulumi.Input<string>;

The Kubernetes cluster server host.

property password

password?: pulumi.Input<string>;

A password or token used to authenticate to the Kubernetes cluster.

property username

username?: pulumi.Input<string>;

A username used to authenticate to the Kubernetes cluster.

interface KubernetesClusterKubeletIdentity

interface KubernetesClusterKubeletIdentity

property clientId

clientId?: pulumi.Input<string>;

The Client ID for the Service Principal.

property objectId

objectId?: pulumi.Input<string>;

The Object ID of the user-defined Managed Identity used by the OMS Agents.

property userAssignedIdentityId

userAssignedIdentityId?: pulumi.Input<string>;

The ID of the User Assigned Identity used by the OMS Agents.

interface KubernetesClusterLinuxProfile

interface KubernetesClusterLinuxProfile

property adminUsername

adminUsername: pulumi.Input<string>;

The Admin Username for the Cluster. Changing this forces a new resource to be created.

property sshKey

sshKey: pulumi.Input<KubernetesClusterLinuxProfileSshKey>;

An sshKey block. Only one is currently allowed. Changing this forces a new resource to be created.

interface KubernetesClusterLinuxProfileSshKey

interface KubernetesClusterLinuxProfileSshKey

property keyData

keyData: pulumi.Input<string>;

The Public SSH Key used to access the cluster. Changing this forces a new resource to be created.

interface KubernetesClusterNetworkProfile

interface KubernetesClusterNetworkProfile

property dnsServiceIp

dnsServiceIp?: pulumi.Input<string>;

IP address within the Kubernetes service address range that will be used by cluster service discovery (kube-dns). Changing this forces a new resource to be created.

property dockerBridgeCidr

dockerBridgeCidr?: pulumi.Input<string>;

IP address (in CIDR notation) used as the Docker bridge IP address on nodes. Changing this forces a new resource to be created.

property loadBalancerProfile

loadBalancerProfile?: pulumi.Input<KubernetesClusterNetworkProfileLoadBalancerProfile>;

A loadBalancerProfile block. This can only be specified when loadBalancerSku is set to Standard.

property loadBalancerSku

loadBalancerSku?: pulumi.Input<string>;

Specifies the SKU of the Load Balancer used for this Kubernetes Cluster. Possible values are Basic and Standard. Defaults to Standard.

property networkPlugin

networkPlugin: pulumi.Input<