1. Docs
  2. Reference
  3. API
  4. @pulumi/azure
  5. types
  6. output

Module types/output

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 advisor

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 config

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 advisor

interface GetRecommendationsRecommendation

interface GetRecommendationsRecommendation

property category

category: string;

The category of the recommendation.

property description

description: string;

The description of the issue or the opportunity identified by the recommendation.

property impact

impact: string;

The business impact of the recommendation.

property recommendationName

recommendationName: string;

The name of the Advisor Recommendation.

property recommendationTypeId

recommendationTypeId: string;

The recommendation type id of the Advisor Recommendation.

property resourceName

resourceName: string;

The name of the identified resource of the Advisor Recommendation.

property resourceType

resourceType: string;

The type of the identified resource of the Advisor Recommendation.

property suppressionNames

suppressionNames: string[];

A list of Advisor Suppression names of the Advisor Recommendation.

property updatedTime

updatedTime: string;

The most recent time that Advisor checked the validity of the recommendation..

namespace analysisservices

interface ServerIpv4FirewallRule

interface ServerIpv4FirewallRule

property name

name: string;

Specifies the name of the firewall rule.

property rangeEnd

rangeEnd: string;

End of the firewall rule range as IPv4 address.

property rangeStart

rangeStart: string;

Start of the firewall rule range as IPv4 address.

namespace apimanagement

interface ApiImport

interface ApiImport

property contentFormat

contentFormat: 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: 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?: outputs.apimanagement.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: string;

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

property serviceName

serviceName: string;

The name of service to import from WSDL.

interface ApiOperationRequest

interface ApiOperationRequest

property description

description?: undefined | string;

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

property headers

headers?: ApiOperationRequestHeader[];

One or more header blocks as defined above.

property queryParameters

queryParameters?: ApiOperationRequestQueryParameter[];

One or more queryParameter blocks as defined above.

property representations

representations?: ApiOperationRequestRepresentation[];

One or more representation blocks as defined below.

interface ApiOperationRequestHeader

interface ApiOperationRequestHeader

property defaultValue

defaultValue?: undefined | string;

The default value for this Header.

property description

description?: undefined | string;

A description of this Header.

property name

name: string;

The Name of this Header.

property required

required: boolean;

Is this Header Required?

property type

type: string;

The Type of this Header, such as a string.

property values

values?: string[];

One or more acceptable values for this Header.

interface ApiOperationRequestQueryParameter

interface ApiOperationRequestQueryParameter

property defaultValue

defaultValue?: undefined | string;

The default value for this Query Parameter.

property description

description?: undefined | string;

A description of this Query Parameter.

property name

name: string;

The Name of this Query Parameter.

property required

required: boolean;

Is this Query Parameter Required?

property type

type: string;

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

property values

values?: string[];

One or more acceptable values for this Query Parameter.

interface ApiOperationRequestRepresentation

interface ApiOperationRequestRepresentation

property contentType

contentType: string;

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

property formParameters

formParameters?: ApiOperationRequestRepresentationFormParameter[];

One or more formParameter block as defined above.

property sample

sample?: undefined | string;

An example of this representation.

property schemaId

schemaId?: undefined | string;

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

property typeName

typeName?: undefined | string;

The Type Name defined by the Schema.

interface ApiOperationRequestRepresentationFormParameter

interface ApiOperationRequestRepresentationFormParameter

property defaultValue

defaultValue?: undefined | string;

The default value for this Form Parameter.

property description

description?: undefined | string;

A description of this Form Parameter.

property name

name: string;

The Name of this Form Parameter.

property required

required: boolean;

Is this Form Parameter Required?

property type

type: string;

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

property values

values?: string[];

One or more acceptable values for this Form Parameter.

interface ApiOperationResponse

interface ApiOperationResponse

property description

description?: undefined | string;

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

property headers

headers?: ApiOperationResponseHeader[];

One or more header blocks as defined above.

property representations

representations?: ApiOperationResponseRepresentation[];

One or more representation blocks as defined below.

property statusCode

statusCode: number;

The HTTP Status Code.

interface ApiOperationResponseHeader

interface ApiOperationResponseHeader

property defaultValue

defaultValue?: undefined | string;

The default value for this Header.

property description

description?: undefined | string;

A description of this Header.

property name

name: string;

The Name of this Header.

property required

required: boolean;

Is this Header Required?

property type

type: string;

The Type of this Header, such as a string.

property values

values?: string[];

One or more acceptable values for this Header.

interface ApiOperationResponseRepresentation

interface ApiOperationResponseRepresentation

property contentType

contentType: string;

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

property formParameters

formParameters?: ApiOperationResponseRepresentationFormParameter[];

One or more formParameter block as defined above.

property sample

sample?: undefined | string;

An example of this representation.

property schemaId

schemaId?: undefined | string;

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

property typeName

typeName?: undefined | string;

The Type Name defined by the Schema.

interface ApiOperationResponseRepresentationFormParameter

interface ApiOperationResponseRepresentationFormParameter

property defaultValue

defaultValue?: undefined | string;

The default value for this Form Parameter.

property description

description?: undefined | string;

A description of this Form Parameter.

property name

name: string;

The Name of this Form Parameter.

property required

required: boolean;

Is this Form Parameter Required?

property type

type: string;

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

property values

values?: string[];

One or more acceptable values for this Form Parameter.

interface ApiOperationTemplateParameter

interface ApiOperationTemplateParameter

property defaultValue

defaultValue?: undefined | string;

The default value for this Template Parameter.

property description

description?: undefined | string;

A description of this Template Parameter.

property name

name: string;

The Name of this Template Parameter.

property required

required: boolean;

Is this Template Parameter Required?

property type

type: string;

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

property values

values?: string[];

One or more acceptable values for this Template Parameter.

interface ApiSubscriptionKeyParameterNames

interface ApiSubscriptionKeyParameterNames

property header

header: string;

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

property query

query: string;

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

interface AuthorizationServerTokenBodyParameter

interface AuthorizationServerTokenBodyParameter

property name

name: string;

The Name of the Parameter.

property value

value: string;

The Value of the Parameter.

interface BackendCredentials

interface BackendCredentials

property authorization

authorization?: outputs.apimanagement.BackendCredentialsAuthorization;

An authorization block as defined below.

property certificates

certificates?: 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?: undefined | {[key: string]: 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?: undefined | {[key: string]: 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?: undefined | string;

The authentication Parameter value.

property scheme

scheme?: undefined | string;

The authentication Scheme name.

interface BackendProxy

interface BackendProxy

property password

password?: undefined | string;

The password to connect to the proxy server.

property url

url: string;

The URL of the proxy server.

property username

username: string;

The username to connect to the proxy server.

interface BackendServiceFabricCluster

interface BackendServiceFabricCluster

property clientCertificateThumbprint

clientCertificateThumbprint: string;

The client certificate thumbprint for the management endpoint.

property managementEndpoints

managementEndpoints: string[];

A list of cluster management endpoints.

property maxPartitionResolutionRetries

maxPartitionResolutionRetries: number;

The maximum number of retries when attempting resolve the partition.

property serverCertificateThumbprints

serverCertificateThumbprints?: string[];

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

property serverX509Names

serverX509Names?: BackendServiceFabricClusterServerX509Name[];

One or more serverX509Name blocks as documented below.

interface BackendServiceFabricClusterServerX509Name

interface BackendServiceFabricClusterServerX509Name

property issuerCertificateThumbprint

issuerCertificateThumbprint: string;

The thumbprint for the issuer of the certificate.

property name

name: string;

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

interface BackendTls

interface BackendTls

property validateCertificateChain

validateCertificateChain?: undefined | false | true;

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

property validateCertificateName

validateCertificateName?: undefined | false | true;

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

interface GetApiSubscriptionKeyParameterName

interface GetApiSubscriptionKeyParameterName

property header

header: string;

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

property query

query: string;

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

interface GetServiceAdditionalLocation

interface GetServiceAdditionalLocation

property gatewayRegionalUrl

gatewayRegionalUrl: string;

Gateway URL of the API Management service in the Region.

property location

location: string;

The location name of the additional region among Azure Data center regions.

property publicIpAddresses

publicIpAddresses: 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 GetServiceHostnameConfiguration

interface GetServiceHostnameConfiguration

property developerPortals

developerPortals: GetServiceHostnameConfigurationDeveloperPortal[];

One or more developerPortal blocks as documented below.

property managements

managements: GetServiceHostnameConfigurationManagement[];

One or more management blocks as documented below.

property portals

portals: GetServiceHostnameConfigurationPortal[];

One or more portal blocks as documented below.

property proxies

proxies: GetServiceHostnameConfigurationProxy[];

One or more proxy blocks as documented below.

property scms

scms: GetServiceHostnameConfigurationScm[];

One or more scm blocks as documented below.

interface GetServiceHostnameConfigurationDeveloperPortal

interface GetServiceHostnameConfigurationDeveloperPortal

property hostName

hostName: string;

The Hostname used for the SCM URL.

property keyVaultId

keyVaultId: string;

The ID of the Key Vault Secret which contains the SSL Certificate.

property negotiateClientCertificate

negotiateClientCertificate: boolean;

Is Client Certificate Negotiation enabled?

interface GetServiceHostnameConfigurationManagement

interface GetServiceHostnameConfigurationManagement

property hostName

hostName: string;

The Hostname used for the SCM URL.

property keyVaultId

keyVaultId: string;

The ID of the Key Vault Secret which contains the SSL Certificate.

property negotiateClientCertificate

negotiateClientCertificate: boolean;

Is Client Certificate Negotiation enabled?

interface GetServiceHostnameConfigurationPortal

interface GetServiceHostnameConfigurationPortal

property hostName

hostName: string;

The Hostname used for the SCM URL.

property keyVaultId

keyVaultId: string;

The ID of the Key Vault Secret which contains the SSL Certificate.

property negotiateClientCertificate

negotiateClientCertificate: boolean;

Is Client Certificate Negotiation enabled?

interface GetServiceHostnameConfigurationProxy

interface GetServiceHostnameConfigurationProxy

property defaultSslBinding

defaultSslBinding: boolean;

Is this the default SSL Binding?

property hostName

hostName: string;

The Hostname used for the SCM URL.

property keyVaultId

keyVaultId: string;

The ID of the Key Vault Secret which contains the SSL Certificate.

property negotiateClientCertificate

negotiateClientCertificate: boolean;

Is Client Certificate Negotiation enabled?

interface GetServiceHostnameConfigurationScm

interface GetServiceHostnameConfigurationScm

property hostName

hostName: string;

The Hostname used for the SCM URL.

property keyVaultId

keyVaultId: string;

The ID of the Key Vault Secret which contains the SSL Certificate.

property negotiateClientCertificate

negotiateClientCertificate: boolean;

Is Client Certificate Negotiation enabled?

interface GetServiceIdentity

interface GetServiceIdentity

property identityIds

identityIds: string[];

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

property principalId

principalId: string;

Specifies the Principal ID of the System Assigned Managed Service Identity that is configured on this API Management Service.

property tenantId

tenantId: string;

Specifies the Tenant ID of the System Assigned Managed Service Identity that is configured on this API Management Service.

property type

type: string;

Specifies the type of Managed Service Identity that is configured on this API Management Service.

interface LoggerApplicationInsights

interface LoggerApplicationInsights

property instrumentationKey

instrumentationKey: string;

The instrumentation key used to push data to Application Insights.

interface LoggerEventhub

interface LoggerEventhub

property connectionString

connectionString: string;

The connection string of an EventHub Namespace.

property name

name: string;

The name of an EventHub.

interface ServiceAdditionalLocation

interface ServiceAdditionalLocation

property gatewayRegionalUrl

gatewayRegionalUrl: string;

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

property location

location: string;

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

property publicIpAddresses

publicIpAddresses: 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: string;

The password for the certificate.

property encodedCertificate

encodedCertificate: string;

The Base64 Encoded PFX Certificate.

property storeName

storeName: 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?: ServiceHostnameConfigurationDeveloperPortal[];

One or more developerPortal blocks as documented below.

property managements

managements?: ServiceHostnameConfigurationManagement[];

One or more management blocks as documented below.

property portals

portals?: ServiceHostnameConfigurationPortal[];

One or more portal blocks as documented below.

property proxies

proxies?: ServiceHostnameConfigurationProxy[];

One or more proxy blocks as documented below.

property scms

scms?: ServiceHostnameConfigurationScm[];

One or more scm blocks as documented below.

interface ServiceHostnameConfigurationDeveloperPortal

interface ServiceHostnameConfigurationDeveloperPortal

property certificate

certificate?: undefined | string;

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

property certificatePassword

certificatePassword?: undefined | string;

The password for the certificate.

property hostName

hostName: string;

The Hostname to use for the Management API.

property keyVaultId

keyVaultId?: undefined | 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?: undefined | false | true;

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

interface ServiceHostnameConfigurationManagement

interface ServiceHostnameConfigurationManagement

property certificate

certificate?: undefined | string;

The Base64 Encoded Certificate.

property certificatePassword

certificatePassword?: undefined | string;

The password associated with the certificate provided above.

property hostName

hostName: string;

The Hostname to use for the Management API.

property keyVaultId

keyVaultId?: undefined | 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?: undefined | false | true;

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

interface ServiceHostnameConfigurationPortal

interface ServiceHostnameConfigurationPortal

property certificate

certificate?: undefined | string;

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

property certificatePassword

certificatePassword?: undefined | string;

The password for the certificate.

property hostName

hostName: string;

The Hostname to use for the Management API.

property keyVaultId

keyVaultId?: undefined | 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?: undefined | false | true;

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

interface ServiceHostnameConfigurationProxy

interface ServiceHostnameConfigurationProxy

property certificate

certificate?: undefined | string;

The Base64 Encoded Certificate.

property certificatePassword

certificatePassword?: undefined | string;

The password associated with the certificate provided above.

property defaultSslBinding

defaultSslBinding: 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: string;

The Hostname to use for the Management API.

property keyVaultId

keyVaultId?: undefined | 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?: undefined | false | true;

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

interface ServiceHostnameConfigurationScm

interface ServiceHostnameConfigurationScm

property certificate

certificate?: undefined | string;

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

property certificatePassword

certificatePassword?: undefined | string;

The password for the certificate.

property hostName

hostName: string;

The Hostname to use for the Management API.

property keyVaultId

keyVaultId?: undefined | 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?: undefined | false | true;

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

interface ServiceIdentity

interface ServiceIdentity

property identityIds

identityIds?: string[];

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

property principalId

principalId: string;

The Principal ID associated with this Managed Service Identity.

property tenantId

tenantId: string;

The Tenant ID associated with this Managed Service Identity.

property type

type?: undefined | 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: string;

The XML Content for this Policy.

xmlLink?: undefined | string;

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

interface ServiceProtocols

interface ServiceProtocols

property enableHttp2

enableHttp2?: undefined | false | true;

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

interface ServiceSecurity

interface ServiceSecurity

property enableBackendSsl30

enableBackendSsl30?: undefined | false | true;

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

property enableBackendTls10

enableBackendTls10?: undefined | false | true;

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

property enableBackendTls11

enableBackendTls11?: undefined | false | true;

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

property enableFrontendSsl30

enableFrontendSsl30?: undefined | false | true;

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

property enableFrontendTls10

enableFrontendTls10?: undefined | false | true;

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

property enableFrontendTls11

enableFrontendTls11?: undefined | false | true;

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

property enableTripleDesCiphers

enableTripleDesCiphers?: undefined | false | true;

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

Should anonymous users be redirected to the sign in page?

interface ServiceSignUp

interface ServiceSignUp

property enabled

enabled: boolean;

Can users sign up on the development portal?

property termsOfService

termsOfService: ServiceSignUpTermsOfService;

A termsOfService block as defined below.

interface ServiceSignUpTermsOfService

interface ServiceSignUpTermsOfService

property consentRequired

consentRequired: boolean;

Should the user be asked for consent during sign up?

property enabled

enabled: boolean;

Should Terms of Service be displayed during sign up?.

property text

text?: undefined | string;

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

interface ServiceVirtualNetworkConfiguration

interface ServiceVirtualNetworkConfiguration

property subnetId

subnetId: string;

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

namespace appconfiguration

interface ConfigurationStorePrimaryReadKey

interface ConfigurationStorePrimaryReadKey

property connectionString

connectionString: string;

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

property id

id: string;

The ID of the Access Key.

property secret

secret: string;

The Secret of the Access Key.

interface ConfigurationStorePrimaryWriteKey

interface ConfigurationStorePrimaryWriteKey

property connectionString

connectionString: string;

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

property id

id: string;

The ID of the Access Key.

property secret

secret: string;

The Secret of the Access Key.

interface ConfigurationStoreSecondaryReadKey

interface ConfigurationStoreSecondaryReadKey

property connectionString

connectionString: string;

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

property id

id: string;

The ID of the Access Key.

property secret

secret: string;

The Secret of the Access Key.

interface ConfigurationStoreSecondaryWriteKey

interface ConfigurationStoreSecondaryWriteKey

property connectionString

connectionString: string;

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

property id

id: string;

The ID of the Access Key.

property secret

secret: string;

The Secret of the Access Key.

interface GetConfigurationStorePrimaryReadKey

interface GetConfigurationStorePrimaryReadKey

property connectionString

connectionString: string;

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

property id

id: string;

The ID of the Access Key.

property secret

secret: string;

The Secret of the Access Key.

interface GetConfigurationStorePrimaryWriteKey

interface GetConfigurationStorePrimaryWriteKey

property connectionString

connectionString: string;

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

property id

id: string;

The ID of the Access Key.

property secret

secret: string;

The Secret of the Access Key.

interface GetConfigurationStoreSecondaryReadKey

interface GetConfigurationStoreSecondaryReadKey

property connectionString

connectionString: string;

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

property id

id: string;

The ID of the Access Key.

property secret

secret: string;

The Secret of the Access Key.

interface GetConfigurationStoreSecondaryWriteKey

interface GetConfigurationStoreSecondaryWriteKey

property connectionString

connectionString: string;

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

property id

id: string;

The ID of the Access Key.

property secret

secret: string;

The Secret of the Access Key.

namespace appplatform

interface GetSpringCloudServiceConfigServerGitSetting

interface GetSpringCloudServiceConfigServerGitSetting

property httpBasicAuths

httpBasicAuths: GetSpringCloudServiceConfigServerGitSettingHttpBasicAuth[];

A httpBasicAuth block as defined below.

property label

label: string;

The default label of the Git repository, which is a branch name, tag name, or commit-id of the repository

property repositories

repositories: GetSpringCloudServiceConfigServerGitSettingRepository[];

One or more repository blocks as defined below.

property searchPaths

searchPaths: string[];

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

property sshAuths

sshAuths: GetSpringCloudServiceConfigServerGitSettingSshAuth[];

A sshAuth block as defined below.

property uri

uri: string;

The URI of the Git repository

interface GetSpringCloudServiceConfigServerGitSettingHttpBasicAuth

interface GetSpringCloudServiceConfigServerGitSettingHttpBasicAuth

property password

password: string;

The password used to access the Http Basic Authentication Git repository server.

property username

username: string;

The username used to access the Http Basic Authentication Git repository server.

interface GetSpringCloudServiceConfigServerGitSettingRepository

interface GetSpringCloudServiceConfigServerGitSettingRepository

property httpBasicAuths

httpBasicAuths: GetSpringCloudServiceConfigServerGitSettingRepositoryHttpBasicAuth[];

A httpBasicAuth block as defined below.

property label

label: string;

The default label of the Git repository, which is a branch name, tag name, or commit-id of the repository

property name

name: string;

Specifies The name of the Spring Cloud Service resource.

property patterns

patterns: string[];

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

property searchPaths

searchPaths: string[];

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

property sshAuths

sshAuths: GetSpringCloudServiceConfigServerGitSettingRepositorySshAuth[];

A sshAuth block as defined below.

property uri

uri: string;

The URI of the Git repository

interface GetSpringCloudServiceConfigServerGitSettingRepositoryHttpBasicAuth

interface GetSpringCloudServiceConfigServerGitSettingRepositoryHttpBasicAuth

property password

password: string;

The password used to access the Http Basic Authentication Git repository server.

property username

username: string;

The username used to access the Http Basic Authentication Git repository server.

interface GetSpringCloudServiceConfigServerGitSettingRepositorySshAuth

interface GetSpringCloudServiceConfigServerGitSettingRepositorySshAuth

property hostKey

hostKey: string;

The host key of the Git repository server.

property hostKeyAlgorithm

hostKeyAlgorithm: string;

The host key algorithm.

property privateKey

privateKey: string;

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

property strictHostKeyCheckingEnabled

strictHostKeyCheckingEnabled: boolean;

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

interface GetSpringCloudServiceConfigServerGitSettingSshAuth

interface GetSpringCloudServiceConfigServerGitSettingSshAuth

property hostKey

hostKey: string;

The host key of the Git repository server.

property hostKeyAlgorithm

hostKeyAlgorithm: string;

The host key algorithm.

property privateKey

privateKey: string;

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

property strictHostKeyCheckingEnabled

strictHostKeyCheckingEnabled: boolean;

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

interface SpringCloudServiceConfigServerGitSetting

interface SpringCloudServiceConfigServerGitSetting

property httpBasicAuth

httpBasicAuth?: outputs.appplatform.SpringCloudServiceConfigServerGitSettingHttpBasicAuth;

A httpBasicAuth block as defined below.

property label

label?: undefined | string;

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

property repositories

repositories?: SpringCloudServiceConfigServerGitSettingRepository[];

One or more repository blocks as defined below.

property searchPaths

searchPaths?: string[];

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

property sshAuth

sshAuth?: outputs.appplatform.SpringCloudServiceConfigServerGitSettingSshAuth;

A sshAuth block as defined below.

property uri

uri: 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: string;

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

property username

username: 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?: outputs.appplatform.SpringCloudServiceConfigServerGitSettingRepositoryHttpBasicAuth;

A httpBasicAuth block as defined below.

property label

label?: undefined | string;

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

property name

name: string;

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

property patterns

patterns?: string[];

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

property searchPaths

searchPaths?: string[];

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

property sshAuth

sshAuth?: outputs.appplatform.SpringCloudServiceConfigServerGitSettingRepositorySshAuth;

A sshAuth block as defined below.

property uri

uri: 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: string;

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

property username

username: 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?: undefined | string;

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

property hostKeyAlgorithm

hostKeyAlgorithm?: undefined | 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: string;

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

property strictHostKeyCheckingEnabled

strictHostKeyCheckingEnabled?: undefined | false | true;

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

interface SpringCloudServiceConfigServerGitSettingSshAuth

interface SpringCloudServiceConfigServerGitSettingSshAuth

property hostKey

hostKey?: undefined | string;

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

property hostKeyAlgorithm

hostKeyAlgorithm?: undefined | 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: string;

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

property strictHostKeyCheckingEnabled

strictHostKeyCheckingEnabled?: undefined | false | true;

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?: outputs.appservice.AppServiceAuthSettingsActiveDirectory;

A activeDirectory block as defined below.

property additionalLoginParams

additionalLoginParams?: undefined | {[key: string]: 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?: string[];

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

property defaultProvider

defaultProvider?: undefined | 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: boolean;

Is Authentication enabled?

property facebook

facebook?: outputs.appservice.AppServiceAuthSettingsFacebook;

A facebook block as defined below.

property google

google?: outputs.appservice.AppServiceAuthSettingsGoogle;

A google block as defined below.

property issuer

issuer?: undefined | 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?: outputs.appservice.AppServiceAuthSettingsMicrosoft;

A microsoft block as defined below.

property runtimeVersion

runtimeVersion?: undefined | string;

The runtime version of the Authentication/Authorization module.

property tokenRefreshExtensionHours

tokenRefreshExtensionHours?: undefined | 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?: undefined | false | true;

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

property twitter

twitter?: outputs.appservice.AppServiceAuthSettingsTwitter;

A twitter block as defined below.

property unauthenticatedClientAction

unauthenticatedClientAction?: undefined | 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?: string[];

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

property clientId

clientId: string;

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

property clientSecret

clientSecret?: undefined | 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: string;

The App ID of the Facebook app used for login

property appSecret

appSecret: string;

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

property oauthScopes

oauthScopes?: 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: string;

The OpenID Connect Client ID for the Google web application.

property clientSecret

clientSecret: string;

The client secret associated with the Google web application.

property oauthScopes

oauthScopes?: 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: string;

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

property clientSecret

clientSecret: string;

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

property oauthScopes

oauthScopes?: 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: string;

property consumerSecret

consumerSecret: string;

interface AppServiceBackup

interface AppServiceBackup

property enabled

enabled?: undefined | false | true;

Is this Backup enabled?

property name

name: string;

Specifies the name for this Backup.

property schedule

schedule: AppServiceBackupSchedule;

A schedule block as defined below.

property storageAccountUrl

storageAccountUrl: string;

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

interface AppServiceBackupSchedule

interface AppServiceBackupSchedule

property frequencyInterval

frequencyInterval: number;

Sets how often the backup should be executed.

property frequencyUnit

frequencyUnit: string;

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

property keepAtLeastOneBackup

keepAtLeastOneBackup?: undefined | false | true;

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?: undefined | number;

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

property startTime

startTime?: undefined | string;

Sets when the schedule should start working.

interface AppServiceConnectionString

interface AppServiceConnectionString

property name

name: string;

The name of the Connection String.

property type

type: 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: string;

The value for the Connection String.

interface AppServiceIdentity

interface AppServiceIdentity

property identityIds

identityIds?: string[];

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

property principalId

principalId: string;

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

property tenantId

tenantId: string;

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

property type

type: 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: AppServiceLogsApplicationLogs;

An applicationLogs block as defined below.

property httpLogs

httpLogs: AppServiceLogsHttpLogs;

An httpLogs block as defined below.

interface AppServiceLogsApplicationLogs

interface AppServiceLogsApplicationLogs

property azureBlobStorage

azureBlobStorage?: outputs.appservice.AppServiceLogsApplicationLogsAzureBlobStorage;

An azureBlobStorage block as defined below.

interface AppServiceLogsApplicationLogsAzureBlobStorage

interface AppServiceLogsApplicationLogsAzureBlobStorage

property level

level: 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: number;

The number of days to retain logs for.

property sasUrl

sasUrl: 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?: outputs.appservice.AppServiceLogsHttpLogsAzureBlobStorage;

An azureBlobStorage block as defined below.

property fileSystem

fileSystem?: outputs.appservice.AppServiceLogsHttpLogsFileSystem;

A fileSystem block as defined below.

interface AppServiceLogsHttpLogsAzureBlobStorage

interface AppServiceLogsHttpLogsAzureBlobStorage

property retentionInDays

retentionInDays: number;

The number of days to retain logs for.

property sasUrl

sasUrl: 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: number;

The number of days to retain logs for.

property retentionInMb

retentionInMb: number;

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

interface AppServiceSiteConfig

interface AppServiceSiteConfig

property alwaysOn

alwaysOn?: undefined | false | true;

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

property appCommandLine

appCommandLine?: undefined | string;

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

property autoSwapSlotName

autoSwapSlotName?: undefined | string;

property cors

cors: AppServiceSiteConfigCors;

A cors block as defined below.

property defaultDocuments

defaultDocuments?: string[];

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

property dotnetFrameworkVersion

dotnetFrameworkVersion?: undefined | 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: string;

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

property healthCheckPath

healthCheckPath?: undefined | string;

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

property http2Enabled

http2Enabled?: undefined | false | true;

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

property ipRestrictions

ipRestrictions: AppServiceSiteConfigIpRestriction[];

A list of objects representing ip restrictions as defined below.

property javaContainer

javaContainer?: undefined | 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?: undefined | string;

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

property javaVersion

javaVersion?: undefined | 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: 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: 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: string;

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

property minTlsVersion

minTlsVersion: 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?: undefined | 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?: undefined | string;

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

property remoteDebuggingEnabled

remoteDebuggingEnabled?: undefined | false | true;

Is Remote Debugging Enabled? Defaults to false.

property remoteDebuggingVersion

remoteDebuggingVersion: string;

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

property scmType

scmType?: undefined | 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?: undefined | false | true;

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

property websocketsEnabled

websocketsEnabled: boolean;

Should WebSockets be enabled?

property windowsFxVersion

windowsFxVersion: string;

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

interface AppServiceSiteConfigCors

interface AppServiceSiteConfigCors

property allowedOrigins

allowedOrigins: string[];

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

property supportCredentials

supportCredentials?: undefined | false | true;

Are credentials supported?

interface AppServiceSiteConfigIpRestriction

interface AppServiceSiteConfigIpRestriction

property action

action?: undefined | string;

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

property ipAddress

ipAddress?: undefined | string;

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

property name

name: string;

The name for this IP Restriction.

property priority

priority?: undefined | 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?: undefined | string;

The Virtual Network Subnet ID used for this IP Restriction.

interface AppServiceSiteCredential

interface AppServiceSiteCredential

property password

password: string;

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

property username

username: string;

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

interface AppServiceSourceControl

interface AppServiceSourceControl

property branch

branch: string;

Branch name of the Git repository for this App Service.

property repoUrl

repoUrl: string;

URL of the Git repository for this App Service.

interface AppServiceStorageAccount

interface AppServiceStorageAccount

property accessKey

accessKey: string;

The access key for the storage account.

property accountName

accountName: string;

The name of the storage account.

property mountPath

mountPath?: undefined | string;

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

property name

name: string;

The name of the storage account identifier.

property shareName

shareName: string;

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

property type

type: string;

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

interface CertificateOrderCertificate

interface CertificateOrderCertificate

property certificateName

certificateName: string;

The name of the App Service Certificate.

property keyVaultId

keyVaultId: string;

Key Vault resource Id.

property keyVaultSecretName

keyVaultSecretName: string;

Key Vault secret name.

property provisioningState

provisioningState: string;

Status of the Key Vault secret.

interface FunctionAppAuthSettings

interface FunctionAppAuthSettings

property activeDirectory

activeDirectory?: outputs.appservice.FunctionAppAuthSettingsActiveDirectory;

A activeDirectory block as defined below.

property additionalLoginParams

additionalLoginParams?: undefined | {[key: string]: 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?: string[];

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

property defaultProvider

defaultProvider?: undefined | 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: boolean;

Is Authentication enabled?

property facebook

facebook?: outputs.appservice.FunctionAppAuthSettingsFacebook;

A facebook block as defined below.

property google

google?: outputs.appservice.FunctionAppAuthSettingsGoogle;

A google block as defined below.

property issuer

issuer?: undefined | 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?: outputs.appservice.FunctionAppAuthSettingsMicrosoft;

A microsoft block as defined below.

property runtimeVersion

runtimeVersion?: undefined | string;

The runtime version of the Authentication/Authorization module.

property tokenRefreshExtensionHours

tokenRefreshExtensionHours?: undefined | 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?: undefined | false | true;

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

property twitter

twitter?: outputs.appservice.FunctionAppAuthSettingsTwitter;

A twitter block as defined below.

property unauthenticatedClientAction

unauthenticatedClientAction?: undefined | 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?: string[];

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

property clientId

clientId: string;

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

property clientSecret

clientSecret?: undefined | 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: string;

The App ID of the Facebook app used for login

property appSecret

appSecret: string;

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

property oauthScopes

oauthScopes?: 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: string;

The OpenID Connect Client ID for the Google web application.

property clientSecret

clientSecret: string;

The client secret associated with the Google web application.

property oauthScopes

oauthScopes?: 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: string;

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

property clientSecret

clientSecret: string;

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

property oauthScopes

oauthScopes?: 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: string;

property consumerSecret

consumerSecret: string;

interface FunctionAppConnectionString

interface FunctionAppConnectionString

property name

name: string;

The name of the Connection String.

property type

type: 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: string;

The value for the Connection String.

interface FunctionAppIdentity

interface FunctionAppIdentity

property identityIds

identityIds?: string[];

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

property principalId

principalId: string;

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

property tenantId

tenantId: string;

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

property type

type: 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?: undefined | false | true;

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

property cors

cors: FunctionAppSiteConfigCors;

A cors block as defined below.

property ftpsState

ftpsState: string;

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

property http2Enabled

http2Enabled?: undefined | false | true;

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

property ipRestrictions

ipRestrictions: FunctionAppSiteConfigIpRestriction[];

A list of objects representing ip restrictions as defined below.

property linuxFxVersion

linuxFxVersion: string;

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

property minTlsVersion

minTlsVersion: 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?: undefined | number;

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

property use32BitWorkerProcess

use32BitWorkerProcess?: undefined | false | true;

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

property websocketsEnabled

websocketsEnabled?: undefined | false | true;

Should WebSockets be enabled?

interface FunctionAppSiteConfigCors

interface FunctionAppSiteConfigCors

property allowedOrigins

allowedOrigins: string[];

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

property supportCredentials

supportCredentials?: undefined | false | true;

Are credentials supported?

interface FunctionAppSiteConfigIpRestriction

interface FunctionAppSiteConfigIpRestriction

property ipAddress

ipAddress?: undefined | string;

The IP Address CIDR notation used for this IP Restriction.

property subnetId

subnetId?: undefined | string;

The Subnet ID used for this IP Restriction.

interface FunctionAppSiteCredential

interface FunctionAppSiteCredential

property password

password: string;

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

property username

username: string;

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

interface FunctionAppSlotAuthSettings

interface FunctionAppSlotAuthSettings

property activeDirectory

activeDirectory?: outputs.appservice.FunctionAppSlotAuthSettingsActiveDirectory;

An activeDirectory block as defined below.

property additionalLoginParams

additionalLoginParams?: undefined | {[key: string]: 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?: string[];

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

property defaultProvider

defaultProvider?: undefined | 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: boolean;

Is Authentication enabled?

property facebook

facebook?: outputs.appservice.FunctionAppSlotAuthSettingsFacebook;

A facebook block as defined below.

property google

google?: outputs.appservice.FunctionAppSlotAuthSettingsGoogle;

A google block as defined below.

property issuer

issuer?: undefined | 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?: outputs.appservice.FunctionAppSlotAuthSettingsMicrosoft;

A microsoft block as defined below.

property runtimeVersion

runtimeVersion?: undefined | string;

The runtime version of the Authentication/Authorization module.

property tokenRefreshExtensionHours

tokenRefreshExtensionHours?: undefined | 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?: undefined | false | true;

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

property twitter

twitter?: outputs.appservice.FunctionAppSlotAuthSettingsTwitter;

A twitter block as defined below.

property unauthenticatedClientAction

unauthenticatedClientAction?: undefined | 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?: string[];

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

property clientId

clientId: string;

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

property clientSecret

clientSecret?: undefined | 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: string;

The App ID of the Facebook app used for login

property appSecret

appSecret: string;

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

property oauthScopes

oauthScopes?: 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: string;

The OpenID Connect Client ID for the Google web application.

property clientSecret

clientSecret: string;

The client secret associated with the Google web application.

property oauthScopes

oauthScopes?: 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: string;

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

property clientSecret

clientSecret: string;

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

property oauthScopes

oauthScopes?: 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: string;

property consumerSecret

consumerSecret: string;

interface FunctionAppSlotConnectionString

interface FunctionAppSlotConnectionString

property name

name: string;

The name of the Connection String.

property type

type: 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: string;

The value for the Connection String.

interface FunctionAppSlotIdentity

interface FunctionAppSlotIdentity

property identityIds

identityIds?: string[];

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

property principalId

principalId: string;

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

property tenantId

tenantId: string;

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

property type

type: 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?: undefined | false | true;

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

property cors

cors: FunctionAppSlotSiteConfigCors;

A cors block as defined below.

property ftpsState

ftpsState: string;

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

property http2Enabled

http2Enabled?: undefined | false | true;

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

property ipRestrictions

ipRestrictions: FunctionAppSlotSiteConfigIpRestriction[];

A List of objects representing ip restrictions as defined below.

property linuxFxVersion

linuxFxVersion: string;

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

property minTlsVersion

minTlsVersion: 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?: undefined | number;

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

property use32BitWorkerProcess

use32BitWorkerProcess?: undefined | false | true;

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

property websocketsEnabled

websocketsEnabled?: undefined | false | true;

Should WebSockets be enabled?

interface FunctionAppSlotSiteConfigCors

interface FunctionAppSlotSiteConfigCors

property allowedOrigins

allowedOrigins: string[];

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

property supportCredentials

supportCredentials?: undefined | false | true;

Are credentials supported?

interface FunctionAppSlotSiteConfigIpRestriction

interface FunctionAppSlotSiteConfigIpRestriction

property ipAddress

ipAddress?: undefined | string;

The IP Address CIDR notation used for this IP Restriction.

property subnetId

subnetId?: undefined | string;

The Subnet ID used for this IP Restriction.

interface FunctionAppSlotSiteCredential

interface FunctionAppSlotSiteCredential

property password

password: string;

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

property username

username: string;

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

interface GetAppServiceConnectionString

interface GetAppServiceConnectionString

property name

name: string;

The name of the App Service.

property type

type: string;

The type of the Connection String.

property value

value: string;

The value for the Connection String.

interface GetAppServicePlanSku

interface GetAppServicePlanSku

property capacity

capacity: number;

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

property size

size: string;

Specifies the plan’s instance size.

property tier

tier: string;

Specifies the plan’s pricing tier.

interface GetAppServiceSiteConfig

interface GetAppServiceSiteConfig

property alwaysOn

alwaysOn: boolean;

Is the app be loaded at all times?

property appCommandLine

appCommandLine: string;

App command line to launch.

property cors

cors: GetAppServiceSiteConfigCor[];

A cors block as defined above.

property defaultDocuments

defaultDocuments: string[];

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

property dotnetFrameworkVersion

dotnetFrameworkVersion: string;

The version of the .net framework’s CLR used in this App Service.

property ftpsState

ftpsState: string;

State of FTP / FTPS service for this AppService.

property healthCheckPath

healthCheckPath: string;

The health check path to be pinged by App Service.

property http2Enabled

http2Enabled: boolean;

Is HTTP2 Enabled on this App Service?

property ipRestrictions

ipRestrictions: GetAppServiceSiteConfigIpRestriction[];

One or more ipRestriction blocks as defined above.

property javaContainer

javaContainer: string;

The Java Container in use.

property javaContainerVersion

javaContainerVersion: string;

The version of the Java Container in use.

property javaVersion

javaVersion: string;

The version of Java in use.

property linuxFxVersion

linuxFxVersion: string;

Linux App Framework and version for the AppService.

property localMysqlEnabled

localMysqlEnabled: 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: string;

The Managed Pipeline Mode used in this App Service.

property minTlsVersion

minTlsVersion: string;

The minimum supported TLS version for this App Service.

property phpVersion

phpVersion: string;

The version of PHP used in this App Service.

property pythonVersion

pythonVersion: string;

The version of Python used in this App Service.

property remoteDebuggingEnabled

remoteDebuggingEnabled: boolean;

Is Remote Debugging Enabled in this App Service?

property remoteDebuggingVersion

remoteDebuggingVersion: string;

Which version of Visual Studio is the Remote Debugger compatible with?

property scmType

scmType: string;

The type of Source Control enabled for this App Service.

property use32BitWorkerProcess

use32BitWorkerProcess: boolean;

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

property websocketsEnabled

websocketsEnabled: boolean;

Are WebSockets enabled for this App Service?

property windowsFxVersion

windowsFxVersion: string;

Windows Container Docker Image for the AppService.

interface GetAppServiceSiteConfigCor

interface GetAppServiceSiteConfigCor

property allowedOrigins

allowedOrigins: string[];

A list of origins which are able to make cross-origin calls.

property supportCredentials

supportCredentials: boolean;

Are credentials supported?

interface GetAppServiceSiteConfigIpRestriction

interface GetAppServiceSiteConfigIpRestriction

property action

action: string;

Does this restriction Allow or Deny access for this IP range?

property ipAddress

ipAddress: string;

The IP Address used for this IP Restriction.

property name

name: string;

The name of the App Service.

property priority

priority: number;

The priority for this IP Restriction.

property virtualNetworkSubnetId

virtualNetworkSubnetId: string;

interface GetAppServiceSiteCredential

interface GetAppServiceSiteCredential

property password

password: string;

property username

username: string;

interface GetAppServiceSourceControl

interface GetAppServiceSourceControl

property branch

branch: string;

property repoUrl

repoUrl: string;

interface GetCertificateOrderCertificate

interface GetCertificateOrderCertificate

property certificateName

certificateName: string;

The name of the App Service Certificate.

property keyVaultId

keyVaultId: string;

Key Vault resource Id.

property keyVaultSecretName

keyVaultSecretName: string;

Key Vault secret name.

property provisioningState

provisioningState: string;

Status of the Key Vault secret.

interface GetFunctionAppConnectionString

interface GetFunctionAppConnectionString

property name

name: string;

The name of the Function App resource.

property type

type: string;

The type of the Connection String.

property value

value: string;

The value for the Connection String.

interface GetFunctionAppSiteCredential

interface GetFunctionAppSiteCredential

property password

password: string;

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

property username

username: string;

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

interface PlanSku

interface PlanSku

property capacity

capacity: number;

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

property size

size: string;

Specifies the plan’s instance size.

property tier

tier: string;

Specifies the plan’s pricing tier.

interface SlotAuthSettings

interface SlotAuthSettings

property activeDirectory

activeDirectory?: outputs.appservice.SlotAuthSettingsActiveDirectory;

A activeDirectory block as defined below.

property additionalLoginParams

additionalLoginParams?: undefined | {[key: string]: 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?: string[];

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

property defaultProvider

defaultProvider?: undefined | 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: boolean;

Is Authentication enabled?

property facebook

facebook?: outputs.appservice.SlotAuthSettingsFacebook;

A facebook block as defined below.

property google

google?: outputs.appservice.SlotAuthSettingsGoogle;

A google block as defined below.

property issuer

issuer?: undefined | 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?: outputs.appservice.SlotAuthSettingsMicrosoft;

A microsoft block as defined below.

property runtimeVersion

runtimeVersion?: undefined | string;

The runtime version of the Authentication/Authorization module.

property tokenRefreshExtensionHours

tokenRefreshExtensionHours?: undefined | 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?: undefined | false | true;

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

property twitter

twitter?: outputs.appservice.SlotAuthSettingsTwitter;

A twitter block as defined below.

property unauthenticatedClientAction

unauthenticatedClientAction?: undefined | 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?: string[];

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

property clientId

clientId: string;

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

property clientSecret

clientSecret?: undefined | 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: string;

The App ID of the Facebook app used for login

property appSecret

appSecret: string;

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

property oauthScopes

oauthScopes?: 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: string;

The OpenID Connect Client ID for the Google web application.

property clientSecret

clientSecret: string;

The client secret associated with the Google web application.

property oauthScopes

oauthScopes?: 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: string;

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

property clientSecret

clientSecret: string;

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

property oauthScopes

oauthScopes?: 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: string;

property consumerSecret

consumerSecret: string;

interface SlotConnectionString

interface SlotConnectionString

property name

name: string;

The name of the Connection String.

property type

type: 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: string;

The value for the Connection String.

interface SlotIdentity

interface SlotIdentity

property identityIds

identityIds?: string[];

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

property principalId

principalId: string;

property tenantId

tenantId: string;

property type

type: 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: SlotLogsApplicationLogs;

An applicationLogs block as defined below.

property httpLogs

httpLogs: SlotLogsHttpLogs;

An httpLogs block as defined below.

interface SlotLogsApplicationLogs

interface SlotLogsApplicationLogs

property azureBlobStorage

azureBlobStorage?: outputs.appservice.SlotLogsApplicationLogsAzureBlobStorage;

An azureBlobStorage block as defined below.

interface SlotLogsApplicationLogsAzureBlobStorage

interface SlotLogsApplicationLogsAzureBlobStorage

property level

level: 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: number;

The number of days to retain logs for.

property sasUrl

sasUrl: 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?: outputs.appservice.SlotLogsHttpLogsAzureBlobStorage;

An azureBlobStorage block as defined below.

property fileSystem

fileSystem?: outputs.appservice.SlotLogsHttpLogsFileSystem;

A fileSystem block as defined below.

interface SlotLogsHttpLogsAzureBlobStorage

interface SlotLogsHttpLogsAzureBlobStorage

property retentionInDays

retentionInDays: number;

The number of days to retain logs for.

property sasUrl

sasUrl: 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: number;

The number of days to retain logs for.

property retentionInMb

retentionInMb: number;

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

interface SlotSiteConfig

interface SlotSiteConfig

property alwaysOn

alwaysOn?: undefined | false | true;

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

property appCommandLine

appCommandLine?: undefined | string;

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

property autoSwapSlotName

autoSwapSlotName?: undefined | string;

The name of the swap to automatically swap to during deployment

property cors

cors: SlotSiteConfigCors;

A cors block as defined below.

property defaultDocuments

defaultDocuments?: string[];

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

property dotnetFrameworkVersion

dotnetFrameworkVersion?: undefined | 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: string;

property healthCheckPath

healthCheckPath?: undefined | string;

property http2Enabled

http2Enabled?: undefined | false | true;

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

property ipRestrictions

ipRestrictions: SlotSiteConfigIpRestriction[];

A list of objects representing ip restrictions as defined below.

property javaContainer

javaContainer?: undefined | string;

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

property javaContainerVersion

javaContainerVersion?: undefined | string;

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

property javaVersion

javaVersion?: undefined | 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: string;

property localMysqlEnabled

localMysqlEnabled: 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: string;

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

property minTlsVersion

minTlsVersion: 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?: undefined | 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?: undefined | string;

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

property remoteDebuggingEnabled

remoteDebuggingEnabled?: undefined | false | true;

Is Remote Debugging Enabled? Defaults to false.

property remoteDebuggingVersion

remoteDebuggingVersion: string;

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

property scmType

scmType?: undefined | 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?: undefined | false | true;

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

property websocketsEnabled

websocketsEnabled: boolean;

Should WebSockets be enabled?

property windowsFxVersion

windowsFxVersion: string;

interface SlotSiteConfigCors

interface SlotSiteConfigCors

property allowedOrigins

allowedOrigins: string[];

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

property supportCredentials

supportCredentials?: undefined | false | true;

Are credentials supported?

interface SlotSiteConfigIpRestriction

interface SlotSiteConfigIpRestriction

property action

action?: undefined | string;

property ipAddress

ipAddress?: undefined | string;

The IP Address used for this IP Restriction.

property name

name: string;

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

property priority

priority?: undefined | number;

property virtualNetworkSubnetId

virtualNetworkSubnetId?: undefined | string;

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

interface SlotSiteCredential

interface SlotSiteCredential

property password

password: string;

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

property username

username: string;

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

namespace authorization

interface GetRoleDefinitionPermission

interface GetRoleDefinitionPermission

property actions

actions: string[];

a list of actions supported by this role

property dataActions

dataActions?: string[];

property notActions

notActions: string[];

a list of actions which are denied by this role

property notDataActions

notDataActions?: string[];

interface RoleDefinitionPermission

interface RoleDefinitionPermission

property actions

actions?: 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?: 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?: 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?: 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?: outputs.automation.ModuleModuleLinkHash;
uri: string;

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

interface ModuleModuleLinkHash

interface ModuleModuleLinkHash

property algorithm

algorithm: string;

property value

value: string;
interface RunBookPublishContentLink
hash?: outputs.automation.RunBookPublishContentLinkHash;
uri: string;

The uri of the runbook content.

version?: undefined | string;

interface RunBookPublishContentLinkHash

interface RunBookPublishContentLinkHash

property algorithm

algorithm: string;

property value

value: string;

interface ScheduleMonthlyOccurrence

interface ScheduleMonthlyOccurrence

property day

day: string;

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

property occurrence

occurrence: 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: string;

Sets the backup frequency. Currently, only Daily is supported

property time

time: string;

interface PolicyFileShareRetentionDaily

interface PolicyFileShareRetentionDaily

property count

count: number;

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

interface PolicyVMBackup

interface PolicyVMBackup

property frequency

frequency: string;

Sets the backup frequency. Must be either Daily orWeekly.

property time

time: string;

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

property weekdays

weekdays?: 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: number;

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

interface PolicyVMRetentionMonthly

interface PolicyVMRetentionMonthly

property count

count: number;

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

property weekdays

weekdays: string[];

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

property weeks

weeks: 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: number;

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

property weekdays

weekdays: 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: number;

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

property months

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

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

property weeks

weeks: 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: string;

The Azure identifier of the Azure KeyVault to use.

property url

url: string;

The HTTPS URL of the Azure KeyVault to use.

interface GetAccountKeyVaultReference

interface GetAccountKeyVaultReference

property id

id: string;

The Azure identifier of the Azure KeyVault reference.

property url

url: string;

The HTTPS URL of the Azure KeyVault reference.

interface GetPoolAutoScale

interface GetPoolAutoScale

property evaluationInterval

evaluationInterval: string;

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

property formula

formula: string;

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

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 GetPoolContainerConfiguration

interface GetPoolContainerConfiguration

property containerRegistries

containerRegistries: GetPoolContainerConfigurationContainerRegistry[];

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

property type

type: string;

The type of container configuration.

interface GetPoolContainerConfigurationContainerRegistry

interface GetPoolContainerConfigurationContainerRegistry

property password

password: string;

The password to log into the registry server.

property registryServer

registryServer: string;

The container registry URL. The default is “docker.io”.

property userName

userName: string;

The user name to log into the registry server.

interface GetPoolFixedScale

interface GetPoolFixedScale

property resizeTimeout

resizeTimeout: string;

The timeout for resize operations.

property targetDedicatedNodes

targetDedicatedNodes: number;

The number of nodes in the Batch pool.

property targetLowPriorityNodes

targetLowPriorityNodes: number;

The number of low priority nodes in the Batch pool.

interface GetPoolNetworkConfiguration

interface GetPoolNetworkConfiguration

property endpointConfiguration

endpointConfiguration: GetPoolNetworkConfigurationEndpointConfiguration;

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

property subnetId

subnetId: 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: number;

The port number on the compute node.

property frontendPortRange

frontendPortRange: 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: 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: string;

The protocol of the endpoint.

interface GetPoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule

interface GetPoolNetworkConfigurationEndpointConfigurationNetworkSecurityGroupRule

property access

access: string;

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

property priority

priority: number;

The priority for this rule.

property sourceAddressPrefix

sourceAddressPrefix: 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: string;

The storage container name in the auto storage account.

property blobPrefix

blobPrefix: string;

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

property fileMode

fileMode: string;

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

property filePath

filePath: 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: 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: 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: string;

The user name to log into the registry server.

interface GetPoolStartTaskUserIdentityAutoUser

interface GetPoolStartTaskUserIdentityAutoUser

property elevationLevel

elevationLevel: string;

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

property scope

scope: string;

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

interface GetPoolStorageImageReference

interface GetPoolStorageImageReference

property id

id: string;

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

property offer

offer: string;

property publisher

publisher: string;

property sku

sku: string;

property version

version: string;

interface PoolAutoScale

interface PoolAutoScale

property evaluationInterval

evaluationInterval?: undefined | string;

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

property formula

formula: string;

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

interface PoolCertificate

interface PoolCertificate

property id

id: string;

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

property storeLocation

storeLocation: 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?: undefined | 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?: 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?: string[];

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

property containerRegistries

containerRegistries?: PoolContainerConfigurationContainerRegistry[];

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

property type

type?: undefined | string;

The type of container configuration. Possible value is DockerCompatible.

interface PoolContainerConfigurationContainerRegistry

interface PoolContainerConfigurationContainerRegistry

property password

password: string;

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

property registryServer

registryServer: string;

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

property userName

userName: 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?: undefined | string;

The timeout for resize operations. Defaults to PT15M.

property targetDedicatedNodes

targetDedicatedNodes?: undefined | number;

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

property targetLowPriorityNodes

targetLowPriorityNodes?: undefined | number;

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

interface PoolNetworkConfiguration

interface PoolNetworkConfiguration

property endpointConfigurations

endpointConfigurations?: 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?: 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: 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: 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: 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: 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?: 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: 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: 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: 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: 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: 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. Defaults to 1.

property resourceFiles

resourceFiles?: PoolStartTaskResourceFile[];

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

property userIdentity

userIdentity: PoolStartTaskUserIdentity;

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. Default to false.

interface PoolStartTaskResourceFile

interface PoolStartTaskResourceFile

property autoStorageContainerName

autoStorageContainerName?: undefined | string;

The storage container name in the auto storage account.

property blobPrefix

blobPrefix?: undefined | 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?: undefined | 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?: 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, 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?: undefined | 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?: undefined | 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?: outputs.batch.PoolStartTaskUserIdentityAutoUser;

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

property userName

userName?: undefined | string;

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

interface PoolStartTaskUserIdentityAutoUser

interface PoolStartTaskUserIdentityAutoUser

property elevationLevel

elevationLevel?: undefined | 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?: undefined | 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?: undefined | 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?: undefined | 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?: undefined | 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?: undefined | 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?: undefined | 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: string[];

property principalId

principalId: string;

property tenantId

tenantId: string;

property type

type: string;

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

namespace bot

interface ChannelDirectLineSite

interface ChannelDirectLineSite

property enabled

enabled?: undefined | false | true;

property enhancedAuthenticationEnabled

enhancedAuthenticationEnabled?: undefined | false | true;

property id

id: string;

property key

key: string;

property key2

key2: string;

property name

name: string;

property trustedOrigins

trustedOrigins?: string[];

property v1Allowed

v1Allowed?: undefined | false | true;

property v3Allowed

v3Allowed?: undefined | false | true;

namespace cdn

interface EndpointDeliveryRule

interface EndpointDeliveryRule

property cacheExpirationAction

cacheExpirationAction?: outputs.cdn.EndpointDeliveryRuleCacheExpirationAction;

A cacheExpirationAction block as defined above.

property cacheKeyQueryStringAction

cacheKeyQueryStringAction?: outputs.cdn.EndpointDeliveryRuleCacheKeyQueryStringAction;

A cacheKeyQueryStringAction block as defined above.

property cookiesConditions

cookiesConditions?: EndpointDeliveryRuleCookiesCondition[];

A cookiesCondition block as defined above.

property deviceCondition

deviceCondition?: outputs.cdn.EndpointDeliveryRuleDeviceCondition;

A deviceCondition block as defined below.

property httpVersionConditions

httpVersionConditions?: EndpointDeliveryRuleHttpVersionCondition[];

A httpVersionCondition block as defined below.

property modifyRequestHeaderActions

modifyRequestHeaderActions?: EndpointDeliveryRuleModifyRequestHeaderAction[];

A modifyRequestHeaderAction block as defined below.

property modifyResponseHeaderActions

modifyResponseHeaderActions?: EndpointDeliveryRuleModifyResponseHeaderAction[];

A modifyResponseHeaderAction block as defined below.

property name

name: string;

The Name which should be used for this Delivery Rule.

property order

order: number;

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

property postArgConditions

postArgConditions?: EndpointDeliveryRulePostArgCondition[];

A postArgCondition block as defined below.

property queryStringConditions

queryStringConditions?: EndpointDeliveryRuleQueryStringCondition[];

A queryStringCondition block as defined below.

property remoteAddressConditions

remoteAddressConditions?: EndpointDeliveryRuleRemoteAddressCondition[];

A remoteAddressCondition block as defined below.

property requestBodyConditions

requestBodyConditions?: EndpointDeliveryRuleRequestBodyCondition[];

A requestBodyCondition block as defined below.

property requestHeaderConditions

requestHeaderConditions?: EndpointDeliveryRuleRequestHeaderCondition[];

A requestHeaderCondition block as defined below.

property requestMethodCondition

requestMethodCondition?: outputs.cdn.EndpointDeliveryRuleRequestMethodCondition;

A requestMethodCondition block as defined below.

property requestSchemeCondition

requestSchemeCondition?: outputs.cdn.EndpointDeliveryRuleRequestSchemeCondition;

A requestSchemeCondition block as defined below.

property requestUriConditions

requestUriConditions?: EndpointDeliveryRuleRequestUriCondition[];

A requestUriCondition block as defined below.

property urlFileExtensionConditions

urlFileExtensionConditions?: EndpointDeliveryRuleUrlFileExtensionCondition[];

A urlFileExtensionCondition block as defined below.

property urlFileNameConditions

urlFileNameConditions?: EndpointDeliveryRuleUrlFileNameCondition[];

A urlFileNameCondition block as defined below.

property urlPathConditions

urlPathConditions?: EndpointDeliveryRuleUrlPathCondition[];

A urlPathCondition block as defined below.

property urlRedirectAction

urlRedirectAction?: outputs.cdn.EndpointDeliveryRuleUrlRedirectAction;

A urlRedirectAction block as defined below.

property urlRewriteAction

urlRewriteAction?: outputs.cdn.EndpointDeliveryRuleUrlRewriteAction;

A urlRewriteAction block as defined below.

interface EndpointDeliveryRuleCacheExpirationAction

interface EndpointDeliveryRuleCacheExpirationAction

property behavior

behavior: string;

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

property duration

duration?: undefined | 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: string;

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

property parameters

parameters?: undefined | string;

Comma separated list of parameter values.

interface EndpointDeliveryRuleCookiesCondition

interface EndpointDeliveryRuleCookiesCondition

property matchValues

matchValues: string[];

List of values for the cookie.

property negateCondition

negateCondition?: undefined | false | true;

Defaults to false.

property operator

operator: string;

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

property selector

selector: string;

Name of the cookie.

property transforms

transforms?: string[];

Valid values are Lowercase and Uppercase.

interface EndpointDeliveryRuleDeviceCondition

interface EndpointDeliveryRuleDeviceCondition

property matchValues

matchValues: string[];

Valid values are Desktop and Mobile.

property negateCondition

negateCondition?: undefined | false | true;

Defaults to false.

property operator

operator?: undefined | string;

Valid values are Equal.

interface EndpointDeliveryRuleHttpVersionCondition

interface EndpointDeliveryRuleHttpVersionCondition

property matchValues

matchValues: string[];

Valid values are 0.9, 1.0, 1.1 and 2.0.

property negateCondition

negateCondition?: undefined | false | true;

Defaults to false.

property operator

operator?: undefined | string;

Valid values are Equal.

interface EndpointDeliveryRuleModifyRequestHeaderAction

interface EndpointDeliveryRuleModifyRequestHeaderAction

property action

action: string;

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

property name

name: string;

The header name.

property value

value?: undefined | string;

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

interface EndpointDeliveryRuleModifyResponseHeaderAction

interface EndpointDeliveryRuleModifyResponseHeaderAction

property action

action: string;

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

property name

name: string;

The header name.

property value

value?: undefined | string;

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

interface EndpointDeliveryRulePostArgCondition

interface EndpointDeliveryRulePostArgCondition

property matchValues

matchValues: string[];

List of string values.

property negateCondition

negateCondition?: undefined | false | true;

Defaults to false.

property operator

operator: string;

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

property selector

selector: string;

Name of the post arg.

property transforms

transforms?: string[];

Valid values are Lowercase and Uppercase.

interface EndpointDeliveryRuleQueryStringCondition

interface EndpointDeliveryRuleQueryStringCondition

property matchValues

matchValues: string[];

List of string values.

property negateCondition

negateCondition?: undefined | false | true;

Defaults to false.

property operator

operator: string;

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

property transforms

transforms?: string[];

Valid values are Lowercase and Uppercase.

interface EndpointDeliveryRuleRemoteAddressCondition

interface EndpointDeliveryRuleRemoteAddressCondition

property matchValues

matchValues: 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?: undefined | false | true;

Defaults to false.

property operator

operator: string;

Valid values are Any, GeoMatch and IPMatch.

interface EndpointDeliveryRuleRequestBodyCondition

interface EndpointDeliveryRuleRequestBodyCondition

property matchValues

matchValues: string[];

List of string values.

property negateCondition

negateCondition?: undefined | false | true;

Defaults to false.

property operator

operator: string;

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

property transforms

transforms?: string[];

Valid values are Lowercase and Uppercase.

interface EndpointDeliveryRuleRequestHeaderCondition

interface EndpointDeliveryRuleRequestHeaderCondition

property matchValues

matchValues: string[];

List of header values.

property negateCondition

negateCondition?: undefined | false | true;

Defaults to false.

property operator

operator: string;

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

property selector

selector: string;

Header name.

property transforms

transforms?: string[];

Valid values are Lowercase and Uppercase.

interface EndpointDeliveryRuleRequestMethodCondition

interface EndpointDeliveryRuleRequestMethodCondition

property matchValues

matchValues: string[];

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

property negateCondition

negateCondition?: undefined | false | true;

Defaults to false.

property operator

operator?: undefined | string;

Valid values are Equal.

interface EndpointDeliveryRuleRequestSchemeCondition

interface EndpointDeliveryRuleRequestSchemeCondition

property matchValues

matchValues: string[];

Valid values are HTTP and HTTPS.

property negateCondition

negateCondition?: undefined | false | true;

Defaults to false.

property operator

operator?: undefined | string;

Valid values are Equal.

interface EndpointDeliveryRuleRequestUriCondition

interface EndpointDeliveryRuleRequestUriCondition

property matchValues

matchValues: string[];

List of string values.

property negateCondition

negateCondition?: undefined | false | true;

Defaults to false.

property operator

operator: string;

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

property transforms

transforms?: string[];

Valid values are Lowercase and Uppercase.

interface EndpointDeliveryRuleUrlFileExtensionCondition

interface EndpointDeliveryRuleUrlFileExtensionCondition

property matchValues

matchValues: string[];

List of string values.

property negateCondition

negateCondition?: undefined | false | true;

Defaults to false.

property operator

operator: string;

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

property transforms

transforms?: string[];

Valid values are Lowercase and Uppercase.

interface EndpointDeliveryRuleUrlFileNameCondition

interface EndpointDeliveryRuleUrlFileNameCondition

property matchValues

matchValues: string[];

List of string values.

property negateCondition

negateCondition?: undefined | false | true;

Defaults to false.

property operator

operator: string;

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

property transforms

transforms?: string[];

Valid values are Lowercase and Uppercase.

interface EndpointDeliveryRuleUrlPathCondition

interface EndpointDeliveryRuleUrlPathCondition

property matchValues

matchValues: string[];

List of string values.

property negateCondition

negateCondition?: undefined | false | true;

Defaults to false.

property operator

operator: string;

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

property transforms

transforms?: string[];

Valid values are Lowercase and Uppercase.

interface EndpointDeliveryRuleUrlRedirectAction

interface EndpointDeliveryRuleUrlRedirectAction

property fragment

fragment?: undefined | string;

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

property hostname

hostname?: undefined | string;

Specifies the hostname part of the URL.

property path

path?: undefined | string;

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

property protocol

protocol?: undefined | string;

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

property queryString

queryString?: undefined | 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: string;

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

interface EndpointDeliveryRuleUrlRewriteAction

interface EndpointDeliveryRuleUrlRewriteAction

property destination

destination: string;

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

property preserveUnmatchedPath

preserveUnmatchedPath?: undefined | false | true;

Defaults to true.

property sourcePattern

sourcePattern: string;

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

interface EndpointGeoFilter

interface EndpointGeoFilter

property action

action: string;

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

property countryCodes

countryCodes: string[];

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

property relativePath

relativePath: string;

The relative path applicable to geo filter.

interface EndpointGlobalDeliveryRule

interface EndpointGlobalDeliveryRule

property cacheExpirationAction

cacheExpirationAction?: outputs.cdn.EndpointGlobalDeliveryRuleCacheExpirationAction;

A cacheExpirationAction block as defined above.

property cacheKeyQueryStringAction

cacheKeyQueryStringAction?: outputs.cdn.EndpointGlobalDeliveryRuleCacheKeyQueryStringAction;

A cacheKeyQueryStringAction block as defined above.

property modifyRequestHeaderActions

modifyRequestHeaderActions?: EndpointGlobalDeliveryRuleModifyRequestHeaderAction[];

A modifyRequestHeaderAction block as defined below.

property modifyResponseHeaderActions

modifyResponseHeaderActions?: EndpointGlobalDeliveryRuleModifyResponseHeaderAction[];

A modifyResponseHeaderAction block as defined below.

property urlRedirectAction

urlRedirectAction?: outputs.cdn.EndpointGlobalDeliveryRuleUrlRedirectAction;

A urlRedirectAction block as defined below.

property urlRewriteAction

urlRewriteAction?: outputs.cdn.EndpointGlobalDeliveryRuleUrlRewriteAction;

A urlRewriteAction block as defined below.

interface EndpointGlobalDeliveryRuleCacheExpirationAction

interface EndpointGlobalDeliveryRuleCacheExpirationAction

property behavior

behavior: string;

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

property duration

duration?: undefined | 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: string;

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

property parameters

parameters?: undefined | string;

Comma separated list of parameter values.

interface EndpointGlobalDeliveryRuleModifyRequestHeaderAction

interface EndpointGlobalDeliveryRuleModifyRequestHeaderAction

property action

action: string;

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

property name

name: string;

The header name.

property value

value?: undefined | string;

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

interface EndpointGlobalDeliveryRuleModifyResponseHeaderAction

interface EndpointGlobalDeliveryRuleModifyResponseHeaderAction

property action

action: string;

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

property name

name: string;

The header name.

property value

value?: undefined | string;

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

interface EndpointGlobalDeliveryRuleUrlRedirectAction

interface EndpointGlobalDeliveryRuleUrlRedirectAction

property fragment

fragment?: undefined | string;

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

property hostname

hostname?: undefined | string;

Specifies the hostname part of the URL.

property path

path?: undefined | string;

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

property protocol

protocol?: undefined | string;

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

property queryString

queryString?: undefined | 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: string;

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

interface EndpointGlobalDeliveryRuleUrlRewriteAction

interface EndpointGlobalDeliveryRuleUrlRewriteAction

property destination

destination: string;

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

property preserveUnmatchedPath

preserveUnmatchedPath?: undefined | false | true;

Defaults to true.

property sourcePattern

sourcePattern: string;

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

interface EndpointOrigin

interface EndpointOrigin

property hostName

hostName: 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?: undefined | number;

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

property httpsPort

httpsPort?: undefined | number;

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

property name

name: 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: string;

The name of the IP configuration.

property publicIpAddressId

publicIpAddressId: string;

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

property subnetId

subnetId: string;

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

interface DiskEncryptionSetIdentity

interface DiskEncryptionSetIdentity

property principalId

principalId: string;

The (Client) ID of the Service Principal.

property tenantId

tenantId: string;

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

property type

type: string;

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

interface GetImageDataDisk

interface GetImageDataDisk

property blobUri

blobUri: string;

the URI in Azure storage of the blob used to create the image.

property caching

caching: string;

the caching mode for the Data Disk, such as ReadWrite, ReadOnly, or None.

property lun

lun: number;

the logical unit number of the data disk.

property managedDiskId

managedDiskId: string;

the ID of the Managed Disk used as the Data Disk Image.

property sizeGb

sizeGb: number;

the size of this Data Disk in GB.

interface GetImageOsDisk

interface GetImageOsDisk

property blobUri

blobUri: string;

the URI in Azure storage of the blob used to create the image.

property caching

caching: string;

the caching mode for the Data Disk, such as ReadWrite, ReadOnly, or None.

property managedDiskId

managedDiskId: string;

the ID of the Managed Disk used as the Data Disk Image.

property osState

osState: string;

the State of the OS used in the Image, such as Generalized.

property osType

osType: string;

the type of Operating System used on the OS Disk. such as Linux or Windows.

property sizeGb

sizeGb: number;

the size of this Data Disk in GB.

interface GetSharedImageIdentifier

interface GetSharedImageIdentifier

property offer

offer: string;

The Offer Name for this Shared Image.

property publisher

publisher: string;

The Publisher Name for this Gallery Image.

property sku

sku: string;

The Name of the SKU for this Gallery Image.

interface GetSharedImageVersionsImage

interface GetSharedImageVersionsImage

property excludeFromLatest

excludeFromLatest: boolean;

Is this Image Version excluded from the latest filter?

property location

location: string;

The supported Azure location where the Shared Image Gallery exists.

property managedImageId

managedImageId: string;

The ID of the Managed Image which was the source of this Shared Image Version.

property name

name: string;

The Azure Region in which this Image Version exists.

property tags

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

A mapping of tags assigned to the Shared Image.

property targetRegions

targetRegions: GetSharedImageVersionsImageTargetRegion[];

One or more targetRegion blocks as documented below.

interface GetSharedImageVersionsImageTargetRegion

interface GetSharedImageVersionsImageTargetRegion

property name

name: string;

The Azure Region in which this Image Version exists.

property regionalReplicaCount

regionalReplicaCount: number;

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

property storageAccountType

storageAccountType: string;

The storage account type for the image version.

interface GetSharedImageVersionTargetRegion

interface GetSharedImageVersionTargetRegion

property name

name: string;

The name of the Image Version.

property regionalReplicaCount

regionalReplicaCount: number;

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

property storageAccountType

storageAccountType: string;

The storage account type for the image version.

interface GetSnapshotEncryptionSetting

interface GetSnapshotEncryptionSetting

property diskEncryptionKeys

diskEncryptionKeys: GetSnapshotEncryptionSettingDiskEncryptionKey[];

property enabled

enabled: boolean;

property keyEncryptionKeys

keyEncryptionKeys: GetSnapshotEncryptionSettingKeyEncryptionKey[];

interface GetSnapshotEncryptionSettingDiskEncryptionKey

interface GetSnapshotEncryptionSettingDiskEncryptionKey

property secretUrl

secretUrl: string;

property sourceVaultId

sourceVaultId: string;

interface GetSnapshotEncryptionSettingKeyEncryptionKey

interface GetSnapshotEncryptionSettingKeyEncryptionKey

property keyUrl

keyUrl: string;

property sourceVaultId

sourceVaultId: string;

interface GetVirtualMachineIdentity

interface GetVirtualMachineIdentity

property identityIds

identityIds: string[];

The list of User Managed Identity ID’s which are assigned to the Virtual Machine.

property principalId

principalId: string;

The ID of the System Managed Service Principal assigned to the Virtual Machine.

property tenantId

tenantId: string;

The ID of the Tenant of the System Managed Service Principal assigned to the Virtual Machine.

property type

type: string;

The identity type of the Managed Identity assigned to the Virtual Machine.

interface GetVirtualMachineScaleSetIdentity

interface GetVirtualMachineScaleSetIdentity

property identityIds

identityIds: string[];

The list of User Managed Identity ID’s which are assigned to the Virtual Machine Scale Set.

property principalId

principalId: string;

The ID of the System Managed Service Principal assigned to the Virtual Machine Scale Set.

property type

type: string;

The identity type of the Managed Identity assigned to the Virtual Machine Scale Set.

interface ImageDataDisk

interface ImageDataDisk

property blobUri

blobUri: string;

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

property caching

caching?: undefined | string;

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

property lun

lun?: undefined | number;

Specifies the logical unit number of the data disk.

property managedDiskId

managedDiskId?: undefined | string;

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

property sizeGb

sizeGb: 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: string;

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

property caching

caching?: undefined | string;

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

property managedDiskId

managedDiskId: string;

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

property osState

osState?: undefined | string;

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

property osType

osType?: undefined | string;

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

property sizeGb

sizeGb: 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?: undefined | false | true;

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

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

property principalId

principalId: string;

The ID of the System Managed Service Principal.

property tenantId

tenantId: string;

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

property type

type: 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: string;

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

property diffDiskSettings

diffDiskSettings?: outputs.compute.LinuxVirtualMachineOsDiskDiffDiskSettings;

A diffDiskSettings block as defined above.

property diskEncryptionSetId

diskEncryptionSetId?: undefined | string;

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

property diskSizeGb

diskSizeGb: 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: string;

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

property storageAccountType

storageAccountType: 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?: undefined | false | true;

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

interface LinuxVirtualMachineOsDiskDiffDiskSettings

interface LinuxVirtualMachineOsDiskDiffDiskSettings

property option

option: 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: 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: 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: 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?: undefined | false | true;

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

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

interface LinuxVirtualMachineScaleSetAutomaticInstanceRepair

interface LinuxVirtualMachineScaleSetAutomaticInstanceRepair

property enabled

enabled: boolean;

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

property gracePeriod

gracePeriod?: undefined | 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: boolean;

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

property enableAutomaticOsUpgrade

enableAutomaticOsUpgrade: 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: 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: string;

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

property createOption

createOption?: undefined | 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?: undefined | string;

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

property diskSizeGb

diskSizeGb: number;

The size of the Data Disk which should be created.

property lun

lun: number;

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

property storageAccountType

storageAccountType: 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?: undefined | false | true;

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

interface LinuxVirtualMachineScaleSetIdentity

interface LinuxVirtualMachineScaleSetIdentity

property identityIds

identityIds?: string[];

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

property principalId

principalId: string;

The ID of the System Managed Service Principal.

property type

type: 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?: string[];

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

property enableAcceleratedNetworking

enableAcceleratedNetworking?: undefined | false | true;

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

property enableIpForwarding

enableIpForwarding?: undefined | false | true;

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

property ipConfigurations

ipConfigurations: LinuxVirtualMachineScaleSetNetworkInterfaceIpConfiguration[];

One or more ipConfiguration blocks as defined above.

property name

name: string;

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

property networkSecurityGroupId

networkSecurityGroupId?: undefined | string;

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

property primary

primary?: undefined | false | true;

Is this the Primary IP Configuration?

interface LinuxVirtualMachineScaleSetNetworkInterfaceIpConfiguration

interface LinuxVirtualMachineScaleSetNetworkInterfaceIpConfiguration

property applicationGatewayBackendAddressPoolIds

applicationGatewayBackendAddressPoolIds?: 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?: string[];

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

property loadBalancerBackendAddressPoolIds

loadBalancerBackendAddressPoolIds?: 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?: 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: string;

The Name which should be used for this IP Configuration.

property primary

primary?: undefined | false | true;

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

property publicIpAddresses

publicIpAddresses?: LinuxVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress[];

A publicIpAddress block as defined below.

property subnetId

subnetId?: undefined | string;

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

property version

version?: undefined | 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?: undefined | 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: number;

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

property ipTags

ipTags?: LinuxVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag[];

One or more ipTag blocks as defined above.

property name

name: string;

The Name of the Public IP Address Configuration.

property publicIpPrefixId

publicIpPrefixId?: undefined | 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: string;

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

property type

type: string;

The Type of IP Tag, such as FirstPartyUsage.

interface LinuxVirtualMachineScaleSetOsDisk

interface LinuxVirtualMachineScaleSetOsDisk

property caching

caching: string;

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

property diffDiskSettings

diffDiskSettings?: outputs.compute.LinuxVirtualMachineScaleSetOsDiskDiffDiskSettings;

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

property diskEncryptionSetId

diskEncryptionSetId?: undefined | string;

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

property diskSizeGb

diskSizeGb: 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: 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?: undefined | false | true;

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

interface LinuxVirtualMachineScaleSetOsDiskDiffDiskSettings

interface LinuxVirtualMachineScaleSetOsDiskDiffDiskSettings

property option

option: string;

interface LinuxVirtualMachineScaleSetPlan

interface LinuxVirtualMachineScaleSetPlan

property name

name: string;

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

property product

product: string;

property publisher

publisher: string;

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

interface LinuxVirtualMachineScaleSetRollingUpgradePolicy

interface LinuxVirtualMachineScaleSetRollingUpgradePolicy

property maxBatchInstancePercent

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

One or more certificate blocks as defined above.

property keyVaultId

keyVaultId: string;

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

interface LinuxVirtualMachineScaleSetSecretCertificate

interface LinuxVirtualMachineScaleSetSecretCertificate

property url

url: string;

The Secret URL of a Key Vault Certificate.

interface LinuxVirtualMachineScaleSetSourceImageReference

interface LinuxVirtualMachineScaleSetSourceImageReference

property offer

offer: string;

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

property publisher

publisher: string;

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

property sku

sku: string;

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

property version

version: string;

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

interface LinuxVirtualMachineScaleSetTerminateNotification

interface LinuxVirtualMachineScaleSetTerminateNotification

property enabled

enabled: boolean;

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

property timeout

timeout?: undefined | 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: LinuxVirtualMachineSecretCertificate[];

One or more certificate blocks as defined above.

property keyVaultId

keyVaultId: string;

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

interface LinuxVirtualMachineSecretCertificate

interface LinuxVirtualMachineSecretCertificate

property url

url: string;

The Secret URL of a Key Vault Certificate.

interface LinuxVirtualMachineSourceImageReference

interface LinuxVirtualMachineSourceImageReference

property offer

offer: string;

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

property publisher

publisher: string;

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

property sku

sku: string;

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

property version

version: string;

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

interface ManagedDiskEncryptionSettings

interface ManagedDiskEncryptionSettings

property diskEncryptionKey

diskEncryptionKey?: outputs.compute.ManagedDiskEncryptionSettingsDiskEncryptionKey;

A diskEncryptionKey block as defined above.

property enabled

enabled: boolean;

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

property keyEncryptionKey

keyEncryptionKey?: outputs.compute.ManagedDiskEncryptionSettingsKeyEncryptionKey;

A keyEncryptionKey block as defined below.

interface ManagedDiskEncryptionSettingsDiskEncryptionKey

interface ManagedDiskEncryptionSettingsDiskEncryptionKey

property secretUrl

secretUrl: 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: string;

The ID of the source Key Vault.

interface ManagedDiskEncryptionSettingsKeyEncryptionKey

interface ManagedDiskEncryptionSettingsKeyEncryptionKey

property keyUrl

keyUrl: 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: string;

The ID of the source Key Vault.

interface ScaleSetBootDiagnostics

interface ScaleSetBootDiagnostics

property enabled

enabled?: undefined | false | true;

property storageUri

storageUri: string;

interface ScaleSetExtension

interface ScaleSetExtension

property autoUpgradeMinorVersion

autoUpgradeMinorVersion?: undefined | false | true;

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

property name

name: string;

Specifies the name of the extension.

property protectedSettings

protectedSettings?: undefined | string;

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

property provisionAfterExtensions

provisionAfterExtensions?: string[];

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

property publisher

publisher: string;

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

property settings

settings?: undefined | string;

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

property type

type: string;

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

property typeHandlerVersion

typeHandlerVersion: 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?: string[];

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

property principalId

principalId: string;

property type

type: 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?: undefined | false | true;

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

property dnsSettings

dnsSettings?: outputs.compute.ScaleSetNetworkProfileDnsSettings;

A dnsSettings block as documented below.

property ipConfigurations

ipConfigurations: ScaleSetNetworkProfileIpConfiguration[];

An ipConfiguration block as documented below.

property ipForwarding

ipForwarding?: undefined | false | true;

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

property name

name: string;

Specifies the name of the network interface configuration.

property networkSecurityGroupId

networkSecurityGroupId?: undefined | string;

Specifies the identifier for the network security group.

property primary

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

Specifies an array of dns servers.

interface ScaleSetNetworkProfileIpConfiguration

interface ScaleSetNetworkProfileIpConfiguration

property applicationGatewayBackendAddressPoolIds

applicationGatewayBackendAddressPoolIds?: 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?: string[];

Specifies up to 20 application security group IDs.

property loadBalancerBackendAddressPoolIds

loadBalancerBackendAddressPoolIds?: 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: 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: string;

Specifies name of the IP configuration.

property primary

primary: boolean;

Specifies if this ipConfiguration is the primary one.

property publicIpAddressConfiguration

publicIpAddressConfiguration?: outputs.compute.ScaleSetNetworkProfileIpConfigurationPublicIpAddressConfiguration;

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

property subnetId

subnetId: string;

Specifies the identifier of the subnet.

interface ScaleSetNetworkProfileIpConfigurationPublicIpAddressConfiguration

interface ScaleSetNetworkProfileIpConfigurationPublicIpAddressConfiguration

property domainNameLabel

domainNameLabel: string;

The domain name label for the dns settings.

property idleTimeout

idleTimeout: number;

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

property name

name: string;

The name of the public ip address configuration

interface ScaleSetOsProfile

interface ScaleSetOsProfile

property adminPassword

adminPassword?: undefined | string;

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

property adminUsername

adminUsername: string;

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

property computerNamePrefix

computerNamePrefix: 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?: undefined | 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?: undefined | false | true;

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

property sshKeys

sshKeys?: ScaleSetOsProfileLinuxConfigSshKey[];

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

interface ScaleSetOsProfileLinuxConfigSshKey

interface ScaleSetOsProfileLinuxConfigSshKey

property keyData

keyData?: undefined | string;

property path

path: string;

interface ScaleSetOsProfileSecret

interface ScaleSetOsProfileSecret

property sourceVaultId

sourceVaultId: string;

Specifies the key vault to use.

property vaultCertificates

vaultCertificates?: ScaleSetOsProfileSecretVaultCertificate[];

A collection of Vault Certificates as documented below

interface ScaleSetOsProfileSecretVaultCertificate

interface ScaleSetOsProfileSecretVaultCertificate

property certificateStore

certificateStore?: undefined | string;

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

property certificateUrl

certificateUrl: 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?: ScaleSetOsProfileWindowsConfigAdditionalUnattendConfig[];

An Additional Unattended Config block as documented below.

property enableAutomaticUpgrades

enableAutomaticUpgrades?: undefined | false | true;

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

property provisionVmAgent

provisionVmAgent?: undefined | false | true;

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

property winrms

winrms?: ScaleSetOsProfileWindowsConfigWinrm[];

A collection of WinRM configuration blocks as documented below.

interface ScaleSetOsProfileWindowsConfigAdditionalUnattendConfig

interface ScaleSetOsProfileWindowsConfigAdditionalUnattendConfig

property component

component: 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: 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: string;

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

property settingName

settingName: 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?: undefined | string;

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

property protocol

protocol: string;

Specifies the protocol of listener

interface ScaleSetPlan

interface ScaleSetPlan

property name

name: string;

Specifies the name of the image from the marketplace.

property product

product: string;

Specifies the product of the image from the marketplace.

property publisher

publisher: string;

Specifies the publisher of the image.

interface ScaleSetRollingUpgradePolicy

interface ScaleSetRollingUpgradePolicy

property maxBatchInstancePercent

maxBatchInstancePercent?: undefined | 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?: undefined | 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?: undefined | 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?: undefined | 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: number;

Specifies the number of virtual machines in the scale set.

property name

name: string;

Specifies the size of virtual machines in a scale set.

property tier

tier: string;

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

interface ScaleSetStorageProfileDataDisk

interface ScaleSetStorageProfileDataDisk

property caching

caching: string;

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

property createOption

createOption: string;

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

property diskSizeGb

diskSizeGb: number;

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

property lun

lun: number;

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

property managedDiskType

managedDiskType: 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?: undefined | 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?: undefined | string;

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

property publisher

publisher?: undefined | string;

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

property sku

sku?: undefined | string;

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

property version

version?: undefined | string;

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

interface ScaleSetStorageProfileOsDisk

interface ScaleSetStorageProfileOsDisk

property caching

caching: string;

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

property createOption

createOption: string;

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

property image

image?: undefined | 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: 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?: undefined | string;

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

property osType

osType?: undefined | string;

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

property vhdContainers

vhdContainers?: string[];

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

interface SharedImageIdentifier

interface SharedImageIdentifier

property offer

offer: string;

The Offer Name for this Shared Image.

property publisher

publisher: string;

The Publisher Name for this Gallery Image.

property sku

sku: string;

The Name of the SKU for this Gallery Image.

interface SharedImageVersionTargetRegion

interface SharedImageVersionTargetRegion

property name

name: string;

The Azure Region in which this Image Version should exist.

property regionalReplicaCount

regionalReplicaCount: number;

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

property storageAccountType

storageAccountType?: undefined | 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?: outputs.compute.SnapshotEncryptionSettingsDiskEncryptionKey;

property enabled

enabled: boolean;

property keyEncryptionKey

keyEncryptionKey?: outputs.compute.SnapshotEncryptionSettingsKeyEncryptionKey;

interface SnapshotEncryptionSettingsDiskEncryptionKey

interface SnapshotEncryptionSettingsDiskEncryptionKey

property secretUrl

secretUrl: string;

property sourceVaultId

sourceVaultId: string;

interface SnapshotEncryptionSettingsKeyEncryptionKey

interface SnapshotEncryptionSettingsKeyEncryptionKey

property keyUrl

keyUrl: string;

property sourceVaultId

sourceVaultId: string;

interface VirtualMachineAdditionalCapabilities

interface VirtualMachineAdditionalCapabilities

property ultraSsdEnabled

ultraSsdEnabled: boolean;

Should Ultra SSD disk be enabled for this Virtual Machine?

interface VirtualMachineBootDiagnostics

interface VirtualMachineBootDiagnostics

property enabled

enabled: boolean;

Should Boot Diagnostics be enabled for this Virtual Machine?

property storageUri

storageUri: string;

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

interface VirtualMachineIdentity

interface VirtualMachineIdentity

property identityIds

identityIds?: string[];

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

property principalId

principalId: string;

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

property type

type: 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?: undefined | string;

The password associated with the local administrator account.

property adminUsername

adminUsername: string;

Specifies the name of the local administrator account.

property computerName

computerName: string;

Specifies the name of the Virtual Machine.

property customData

customData: 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: boolean;

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

property sshKeys

sshKeys?: VirtualMachineOsProfileLinuxConfigSshKey[];

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

interface VirtualMachineOsProfileLinuxConfigSshKey

interface VirtualMachineOsProfileLinuxConfigSshKey

property keyData

keyData: string;

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

property path

path: string;

The path of the destination file on the virtual machine

interface VirtualMachineOsProfileSecret

interface VirtualMachineOsProfileSecret

property sourceVaultId

sourceVaultId: string;

Specifies the ID of the Key Vault to use.

property vaultCertificates

vaultCertificates?: VirtualMachineOsProfileSecretVaultCertificate[];

One or more vaultCertificates blocks.

interface VirtualMachineOsProfileSecretVaultCertificate

interface VirtualMachineOsProfileSecretVaultCertificate

property certificateStore

certificateStore?: undefined | string;

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

property certificateUrl

certificateUrl: 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?: VirtualMachineOsProfileWindowsConfigAdditionalUnattendConfig[];

A additionalUnattendConfig block.

property enableAutomaticUpgrades

enableAutomaticUpgrades?: undefined | false | true;

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

property provisionVmAgent

provisionVmAgent?: undefined | false | true;

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

property timezone

timezone?: undefined | string;

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

property winrms

winrms?: VirtualMachineOsProfileWindowsConfigWinrm[];

One or more winrm block.

interface VirtualMachineOsProfileWindowsConfigAdditionalUnattendConfig

interface VirtualMachineOsProfileWindowsConfigAdditionalUnattendConfig

property component

component: 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: 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: string;

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

property settingName

settingName: 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?: undefined | 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: string;

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

interface VirtualMachinePlan

interface VirtualMachinePlan

property name

name: string;

Specifies the name of the image from the marketplace.

property product

product: string;

Specifies the product of the image from the marketplace.

property publisher

publisher: string;

Specifies the publisher of the image.

interface VirtualMachineStorageDataDisk

interface VirtualMachineStorageDataDisk

property caching

caching: string;

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

property createOption

createOption: string;

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

property diskSizeGb

diskSizeGb: number;

Specifies the size of the data disk in gigabytes.

property lun

lun: 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: 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: 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: string;

The name of the Data Disk.

property vhdUri

vhdUri?: undefined | 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?: undefined | false | true;

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

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

property createOption

createOption: string;

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

property diskSizeGb

diskSizeGb: number;

Specifies the size of the OS Disk in gigabytes.

property imageUri

imageUri?: undefined | 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: 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: string;

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

property name

name: string;

Specifies the name of the OS Disk.

property osType

osType: string;

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

property vhdUri

vhdUri?: undefined | 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?: undefined | false | true;

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?: undefined | false | true;

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

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

property principalId

principalId: string;

The ID of the System Managed Service Principal.

property tenantId

tenantId: string;

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

property type

type: 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: string;

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

property diffDiskSettings

diffDiskSettings?: outputs.compute.WindowsVirtualMachineOsDiskDiffDiskSettings;

A diffDiskSettings block as defined above.

property diskEncryptionSetId

diskEncryptionSetId?: undefined | string;

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

property diskSizeGb

diskSizeGb: 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: string;

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

property storageAccountType

storageAccountType: 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?: undefined | false | true;

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

interface WindowsVirtualMachineOsDiskDiffDiskSettings

interface WindowsVirtualMachineOsDiskDiffDiskSettings

property option

option: 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: 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: 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: 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?: undefined | false | true;

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

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

property gracePeriod

gracePeriod?: undefined | 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: boolean;

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

property enableAutomaticOsUpgrade

enableAutomaticOsUpgrade: 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: 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: string;

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

property createOption

createOption?: undefined | 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?: undefined | string;

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

property diskSizeGb

diskSizeGb: number;

The size of the Data Disk which should be created.

property lun

lun: number;

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

property storageAccountType

storageAccountType: 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?: undefined | false | true;

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

interface WindowsVirtualMachineScaleSetIdentity

interface WindowsVirtualMachineScaleSetIdentity

property identityIds

identityIds?: string[];

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

property principalId

principalId: string;

The ID of the System Managed Service Principal.

property type

type: 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?: string[];

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

property enableAcceleratedNetworking

enableAcceleratedNetworking?: undefined | false | true;

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

property enableIpForwarding

enableIpForwarding?: undefined | false | true;

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

property ipConfigurations

ipConfigurations: WindowsVirtualMachineScaleSetNetworkInterfaceIpConfiguration[];

One or more ipConfiguration blocks as defined above.

property name

name: string;

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

property networkSecurityGroupId

networkSecurityGroupId?: undefined | string;

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

property primary

primary?: undefined | false | true;

Is this the Primary IP Configuration?

interface WindowsVirtualMachineScaleSetNetworkInterfaceIpConfiguration

interface WindowsVirtualMachineScaleSetNetworkInterfaceIpConfiguration

property applicationGatewayBackendAddressPoolIds

applicationGatewayBackendAddressPoolIds?: 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?: string[];

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

property loadBalancerBackendAddressPoolIds

loadBalancerBackendAddressPoolIds?: 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?: 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: string;

The Name which should be used for this IP Configuration.

property primary

primary?: undefined | false | true;

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

property publicIpAddresses

publicIpAddresses?: WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddress[];

A publicIpAddress block as defined below.

property subnetId

subnetId?: undefined | string;

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

property version

version?: undefined | 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?: undefined | 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: number;

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

property ipTags

ipTags?: WindowsVirtualMachineScaleSetNetworkInterfaceIpConfigurationPublicIpAddressIpTag[];

One or more ipTag blocks as defined above.

property name

name: string;

The Name of the Public IP Address Configuration.

property publicIpPrefixId

publicIpPrefixId?: undefined | 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: string;

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

property type

type: string;

The Type of IP Tag, such as FirstPartyUsage.

interface WindowsVirtualMachineScaleSetOsDisk

interface WindowsVirtualMachineScaleSetOsDisk

property caching

caching: string;

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

property diffDiskSettings

diffDiskSettings?: outputs.compute.WindowsVirtualMachineScaleSetOsDiskDiffDiskSettings;

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

property diskEncryptionSetId

diskEncryptionSetId?: undefined | string;

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

property diskSizeGb

diskSizeGb: 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: 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?: undefined | false | true;

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

interface WindowsVirtualMachineScaleSetOsDiskDiffDiskSettings

interface WindowsVirtualMachineScaleSetOsDiskDiffDiskSettings

property option

option: string;

interface WindowsVirtualMachineScaleSetPlan

interface WindowsVirtualMachineScaleSetPlan

property name

name: string;

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

property product

product: string;

property publisher

publisher: string;

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

interface WindowsVirtualMachineScaleSetRollingUpgradePolicy

interface WindowsVirtualMachineScaleSetRollingUpgradePolicy

property maxBatchInstancePercent

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

One or more certificate blocks as defined above.

property keyVaultId

keyVaultId: string;

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

interface WindowsVirtualMachineScaleSetSecretCertificate

interface WindowsVirtualMachineScaleSetSecretCertificate

property store

store: string;

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

property url

url: string;

The Secret URL of a Key Vault Certificate.

interface WindowsVirtualMachineScaleSetSourceImageReference

interface WindowsVirtualMachineScaleSetSourceImageReference

property offer

offer: string;

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

property publisher

publisher: string;

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

property sku

sku: string;

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

property version

version: string;

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

interface WindowsVirtualMachineScaleSetTerminateNotification

interface WindowsVirtualMachineScaleSetTerminateNotification

property enabled

enabled: boolean;

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

property timeout

timeout?: undefined | 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?: undefined | string;

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

property protocol

protocol: string;

The Protocol of the WinRM Listener. Possible values are Http and Https.

interface WindowsVirtualMachineSecret

interface WindowsVirtualMachineSecret

property certificates

certificates: WindowsVirtualMachineSecretCertificate[];

One or more certificate blocks as defined above.

property keyVaultId

keyVaultId: string;

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

interface WindowsVirtualMachineSecretCertificate

interface WindowsVirtualMachineSecretCertificate

property store

store: string;

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

property url

url: string;

The Secret URL of a Key Vault Certificate.

interface WindowsVirtualMachineSourceImageReference

interface WindowsVirtualMachineSourceImageReference

property offer

offer: string;

(Optional) Specifies the offer of the image used to create the virtual machines.

property publisher

publisher: 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: string;

(Optional) Specifies the SKU of the image used to create the virtual machines.

property version

version: string;

(Optional) Specifies the version of the image used to create the virtual machines.

interface WindowsVirtualMachineWinrmListener

interface WindowsVirtualMachineWinrmListener

property certificateUrl

certificateUrl?: undefined | string;

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

property protocol

protocol: string;

namespace config

interface Features

interface Features

property keyVault

keyVault?: outputs.config.FeaturesKeyVault;

property virtualMachine

virtualMachine?: outputs.config.FeaturesVirtualMachine;

property virtualMachineScaleSet

virtualMachineScaleSet?: outputs.config.FeaturesVirtualMachineScaleSet;

interface FeaturesKeyVault

interface FeaturesKeyVault

property purgeSoftDeleteOnDestroy

purgeSoftDeleteOnDestroy?: undefined | false | true;

property recoverSoftDeletedKeyVaults

recoverSoftDeletedKeyVaults?: undefined | false | true;

interface FeaturesVirtualMachine

interface FeaturesVirtualMachine

property deleteOsDiskOnDeletion

deleteOsDiskOnDeletion: boolean;

interface FeaturesVirtualMachineScaleSet

interface FeaturesVirtualMachineScaleSet

property rollInstancesWhenRequired

rollInstancesWhenRequired: boolean;

namespace containerservice

interface GetKubernetesClusterAddonProfile

interface GetKubernetesClusterAddonProfile

property azurePolicies

azurePolicies: GetKubernetesClusterAddonProfileAzurePolicy[];

A azurePolicy block.

property httpApplicationRoutings

httpApplicationRoutings: GetKubernetesClusterAddonProfileHttpApplicationRouting[];

A httpApplicationRouting block.

property kubeDashboards

kubeDashboards: GetKubernetesClusterAddonProfileKubeDashboard[];

A kubeDashboard block.

property omsAgents

omsAgents: GetKubernetesClusterAddonProfileOmsAgent[];

A omsAgent block.

interface GetKubernetesClusterAddonProfileAzurePolicy

interface GetKubernetesClusterAddonProfileAzurePolicy

property enabled

enabled: boolean;

Is Role Based Access Control enabled?

interface GetKubernetesClusterAddonProfileHttpApplicationRouting

interface GetKubernetesClusterAddonProfileHttpApplicationRouting

property enabled

enabled: boolean;

Is Role Based Access Control enabled?

property httpApplicationRoutingZoneName

httpApplicationRoutingZoneName: string;

The Zone Name of the HTTP Application Routing.

interface GetKubernetesClusterAddonProfileKubeDashboard

interface GetKubernetesClusterAddonProfileKubeDashboard

property enabled

enabled: boolean;

Is Role Based Access Control enabled?

interface GetKubernetesClusterAddonProfileOmsAgent

interface GetKubernetesClusterAddonProfileOmsAgent

property enabled

enabled: boolean;

Is Role Based Access Control enabled?

property logAnalyticsWorkspaceId

logAnalyticsWorkspaceId: string;

The ID of the Log Analytics Workspace which the OMS Agent should send data to.

property omsAgentIdentities

omsAgentIdentities: GetKubernetesClusterAddonProfileOmsAgentOmsAgentIdentity[];

An omsAgentIdentity block as defined below.

interface GetKubernetesClusterAddonProfileOmsAgentOmsAgentIdentity

interface GetKubernetesClusterAddonProfileOmsAgentOmsAgentIdentity

property clientId

clientId: string;

The Client ID of the user-defined Managed Identity assigned to the Kubelets.

property objectId

objectId: string;

The Object ID of the user-defined Managed Identity assigned to the Kubelets.

property userAssignedIdentityId

userAssignedIdentityId: string;

The ID of the User Assigned Identity assigned to the Kubelets.

interface GetKubernetesClusterAgentPoolProfile

interface GetKubernetesClusterAgentPoolProfile

property availabilityZones

availabilityZones: string[];

The availability zones used for the nodes.

property count

count: number;

The number of Agents (VM’s) in the Pool.

property enableAutoScaling

enableAutoScaling: boolean;

If the auto-scaler is enabled.

property enableNodePublicIp

enableNodePublicIp: boolean;

property maxCount

maxCount: number;

Maximum number of nodes for auto-scaling

property maxPods

maxPods: number;

The maximum number of pods that can run on each agent.

property minCount

minCount: number;

Minimum number of nodes for auto-scaling

property name

name: string;

The name of the managed Kubernetes Cluster.

property nodeLabels

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

property nodeTaints

nodeTaints: string[];

The list of Kubernetes taints which are applied to nodes in the agent pool

property orchestratorVersion

orchestratorVersion: string;

Kubernetes version used for the Agents.

property osDiskSizeGb

osDiskSizeGb: number;

The size of the Agent VM’s Operating System Disk in GB.

property osType

osType: string;

The Operating System used for the Agents.

property tags

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

A mapping of tags to assign to the resource.

property type

type: string;

The type of identity used for the managed cluster.

property vmSize

vmSize: string;

The size of each VM in the Agent Pool (e.g. Standard_F1).

property vnetSubnetId

vnetSubnetId: string;

The ID of the Subnet where the Agents in the Pool are provisioned.

interface GetKubernetesClusterIdentity

interface GetKubernetesClusterIdentity

property principalId

principalId: string;

The principal id of the system assigned identity which is used by master components.

property tenantId

tenantId: string;

The tenant id of the system assigned identity which is used by master components.

property type

type: string;

The type of identity used for the managed cluster.

interface GetKubernetesClusterKubeAdminConfig

interface GetKubernetesClusterKubeAdminConfig

property clientCertificate

clientCertificate: string;

Base64 encoded public certificate used by clients to authenticate to the Kubernetes cluster.

property clientKey

clientKey: string;

Base64 encoded private key used by clients to authenticate to the Kubernetes cluster.

property clusterCaCertificate

clusterCaCertificate: string;

Base64 encoded public CA certificate used as the root of trust for the Kubernetes cluster.

property host

host: string;

The Kubernetes cluster server host.

property password

password: string;

A password or token used to authenticate to the Kubernetes cluster.

property username

username: string;

A username used to authenticate to the Kubernetes cluster.

interface GetKubernetesClusterKubeConfig

interface GetKubernetesClusterKubeConfig

property clientCertificate

clientCertificate: string;

Base64 encoded public certificate used by clients to authenticate to the Kubernetes cluster.

property clientKey

clientKey: string;

Base64 encoded private key used by clients to authenticate to the Kubernetes cluster.

property clusterCaCertificate

clusterCaCertificate: string;

Base64 encoded public CA certificate used as the root of trust for the Kubernetes cluster.

property host

host: string;

The Kubernetes cluster server host.

property password

password: string;

A password or token used to authenticate to the Kubernetes cluster.

property username

username: string;

A username used to authenticate to the Kubernetes cluster.

interface GetKubernetesClusterKubeletIdentity

interface GetKubernetesClusterKubeletIdentity

property clientId

clientId: string;

The Client ID of the user-defined Managed Identity assigned to the Kubelets.

property objectId

objectId: string;

The Object ID of the user-defined Managed Identity assigned to the Kubelets.

property userAssignedIdentityId

userAssignedIdentityId: string;

The ID of the User Assigned Identity assigned to the Kubelets.

interface GetKubernetesClusterLinuxProfile

interface GetKubernetesClusterLinuxProfile

property adminUsername

adminUsername: string;

The username associated with the administrator account of the Windows VMs.

property sshKeys

sshKeys: GetKubernetesClusterLinuxProfileSshKey[];

An sshKey block as defined below.

interface GetKubernetesClusterLinuxProfileSshKey

interface GetKubernetesClusterLinuxProfileSshKey

property keyData

keyData: string;

The Public SSH Key used to access the cluster.

interface GetKubernetesClusterNetworkProfile

interface GetKubernetesClusterNetworkProfile

property dnsServiceIp

dnsServiceIp: string;

IP address within the Kubernetes service address range used by cluster service discovery (kube-dns).

property dockerBridgeCidr

dockerBridgeCidr: string;

IP address (in CIDR notation) used as the Docker bridge IP address on nodes.

property loadBalancerSku

loadBalancerSku: string;

property networkPlugin

networkPlugin: string;

Network plugin used such as azure or kubenet.

property networkPolicy

networkPolicy: string;

Network policy to be used with Azure CNI. Eg: calico or azure

property podCidr

podCidr: string;

The CIDR used for pod IP addresses.

property serviceCidr

serviceCidr: string;

Network range used by the Kubernetes service.

interface GetKubernetesClusterRoleBasedAccessControl

interface GetKubernetesClusterRoleBasedAccessControl

property azureActiveDirectories

azureActiveDirectories: GetKubernetesClusterRoleBasedAccessControlAzureActiveDirectory[];

A azureActiveDirectory block as documented above.

property enabled

enabled: boolean;

Is Role Based Access Control enabled?

interface GetKubernetesClusterRoleBasedAccessControlAzureActiveDirectory

interface GetKubernetesClusterRoleBasedAccessControlAzureActiveDirectory

property adminGroupObjectIds

adminGroupObjectIds: string[];

The list of Object IDs of Azure Active Directory Groups which have Admin Role on the Cluster (when using a Managed integration).

property clientAppId

clientAppId: string;

The Client ID of an Azure Active Directory Application.

property managed

managed: boolean;

Is the Azure Active Directory Integration managed (also known as AAD Integration V2)?

property serverAppId

serverAppId: string;

The Server ID of an Azure Active Directory Application.

property tenantId

tenantId: string;

The tenant id of the system assigned identity which is used by master components.

interface GetKubernetesClusterServicePrincipal

interface GetKubernetesClusterServicePrincipal

property clientId

clientId: string;

The Client ID of the user-defined Managed Identity assigned to the Kubelets.

interface GetKubernetesClusterWindowsProfile

interface GetKubernetesClusterWindowsProfile

property adminUsername

adminUsername: string;

The username associated with the administrator account of the Windows VMs.

interface GroupContainer

interface GroupContainer

property commands

commands: string[];

A list of commands which should be run on the container. Changing this forces a new resource to be created.

property cpu

cpu: number;

The required number of CPU cores of the containers. Changing this forces a new resource to be created.

property environmentVariables

environmentVariables?: undefined | {[key: string]: 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?: outputs.containerservice.GroupContainerGpu;

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

property image

image: string;

The container image name. Changing this forces a new resource to be created.

property livenessProbe

livenessProbe?: outputs.containerservice.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: number;

The required memory of the containers in GB. Changing this forces a new resource to be created.

property name

name: string;

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

property ports

ports?: 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?: outputs.containerservice.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?: undefined | {[key: string]: 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?: 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?: undefined | 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?: undefined | 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?: string[];

Commands to be run to validate container readiness. Changing this forces a new resource to be created.

property failureThreshold

failureThreshold?: undefined | 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?: 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?: undefined | 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?: undefined | 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?: undefined | 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?: undefined | 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?: undefined | string;

Path to access on the HTTP server. Changing this forces a new resource to be created.

property port

port?: undefined | number;

The port number the container will expose. Changing this forces a new resource to be created.

property scheme

scheme?: undefined | 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?: undefined | number;

The port number the container will expose. Changing this forces a new resource to be created.

property protocol

protocol?: undefined | 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?: string[];

Commands to be run to validate container readiness. Changing this forces a new resource to be created.

property failureThreshold

failureThreshold?: undefined | 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?: 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?: undefined | 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?: undefined | 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?: undefined | 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?: undefined | 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?: undefined | string;

Path to access on the HTTP server. Changing this forces a new resource to be created.

property port

port?: undefined | number;

The port number the container will expose. Changing this forces a new resource to be created.

property scheme

scheme?: undefined | 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: string;

The path on which this volume is to be mounted. Changing this forces a new resource to be created.

property name

name: string;

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

property readOnly

readOnly?: undefined | false | true;

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

The access key for the Azure Storage account specified as above. Changing this forces a new resource to be created.

property storageAccountName

storageAccountName: 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: GroupDiagnosticsLogAnalytics;

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

interface GroupDiagnosticsLogAnalytics

interface GroupDiagnosticsLogAnalytics

property logType

logType?: undefined | 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?: undefined | {[key: string]: string};

Any metadata required for Log Analytics. Changing this forces a new resource to be created.

property workspaceId

workspaceId: string;

The Workspace ID of the Log Analytics Workspace. Changing this forces a new resource to be created.

property workspaceKey

workspaceKey: 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?: 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: string;

property type

type: 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: string;

The password with which to connect to the registry. Changing this forces a new resource to be created.

property server

server: 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: 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?: outputs.containerservice.KubernetesClusterAddonProfileAciConnectorLinux;

A aciConnectorLinux block. For more details, please visit Create and configure an AKS cluster to use virtual nodes.

property azurePolicy

azurePolicy?: outputs.containerservice.KubernetesClusterAddonProfileAzurePolicy;

A azurePolicy block as defined below. For more details please visit Understand Azure Policy for Azure Kubernetes Service

property httpApplicationRouting

httpApplicationRouting?: outputs.containerservice.KubernetesClusterAddonProfileHttpApplicationRouting;

A httpApplicationRouting block as defined below.

property kubeDashboard

kubeDashboard?: outputs.containerservice.KubernetesClusterAddonProfileKubeDashboard;

A kubeDashboard block as defined below.

property omsAgent

omsAgent?: outputs.containerservice.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: boolean;

Is the virtual node addon enabled?

property subnetName

subnetName?: undefined | 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: boolean;

Is the Azure Policy for Kubernetes Add On enabled?

interface KubernetesClusterAddonProfileHttpApplicationRouting

interface KubernetesClusterAddonProfileHttpApplicationRouting

property enabled

enabled: boolean;

Is HTTP Application Routing Enabled? Changing this forces a new resource to be created.

property httpApplicationRoutingZoneName

httpApplicationRoutingZoneName: string;

The Zone Name of the HTTP Application Routing.

interface KubernetesClusterAddonProfileKubeDashboard

interface KubernetesClusterAddonProfileKubeDashboard

property enabled

enabled: boolean;

Is the Kubernetes Dashboard enabled?

interface KubernetesClusterAddonProfileOmsAgent

interface KubernetesClusterAddonProfileOmsAgent

property enabled

enabled: boolean;

Is the OMS Agent Enabled?

property logAnalyticsWorkspaceId

logAnalyticsWorkspaceId?: undefined | 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: KubernetesClusterAddonProfileOmsAgentOmsAgentIdentity[];

An omsAgentIdentity block as defined below.

interface KubernetesClusterAddonProfileOmsAgentOmsAgentIdentity

interface KubernetesClusterAddonProfileOmsAgentOmsAgentIdentity

property clientId

clientId: string;

The Client ID for the Service Principal.

property objectId

objectId: string;

The Object ID of the user-defined Managed Identity used by the OMS Agents.

property userAssignedIdentityId

userAssignedIdentityId: string;

The ID of the User Assigned Identity used by the OMS Agents.

interface KubernetesClusterAutoScalerProfile

interface KubernetesClusterAutoScalerProfile

property balanceSimilarNodeGroups

balanceSimilarNodeGroups?: undefined | false | true;

Detect similar node groups and balance the number of nodes between them. Defaults to false.

property maxGracefulTerminationSec

maxGracefulTerminationSec: 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: string;

How long after the scale up of AKS nodes the scale down evaluation resumes. Defaults to 10m.

property scaleDownDelayAfterDelete

scaleDownDelayAfterDelete: string;

How long after node deletion that scale down evaluation resumes. Defaults to the value used for scanInterval.

property scaleDownDelayAfterFailure

scaleDownDelayAfterFailure: string;

How long after scale down failure that scale down evaluation resumes. Defaults to 3m.

property scaleDownUnneeded

scaleDownUnneeded: string;

How long a node should be unneeded before it is eligible for scale down. Defaults to 10m.

property scaleDownUnready

scaleDownUnready: string;

How long an unready node should be unneeded before it is eligible for scale down. Defaults to 20m.

property scaleDownUtilizationThreshold

scaleDownUtilizationThreshold: 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: string;

How often the AKS Cluster should be re-evaluated for scale up/down. Defaults to 10s.

interface KubernetesClusterDefaultNodePool

interface KubernetesClusterDefaultNodePool

property availabilityZones

availabilityZones?: string[];

A list of Availability Zones across which the Node Pool should be spread.

property enableAutoScaling

enableAutoScaling?: undefined | false | true;

Should the Kubernetes Auto Scaler be enabled for this Node Pool? Defaults to false.

property enableNodePublicIp

enableNodePublicIp?: undefined | false | true;

Should nodes in this Node Pool have a Public IP Address? Defaults to false.

property maxCount

maxCount?: undefined | 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: number;

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

property minCount

minCount?: undefined | 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: 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: 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?: undefined | {[key: string]: 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?: 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: 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: 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?: undefined | {[key: string]: string};

A mapping of tags to assign to the Node Pool.

property type

type?: undefined | string;

The type of Node Pool which should be created. Possible values are AvailabilitySet and VirtualMachineScaleSets. Defaults to VirtualMachineScaleSets.

property vmSize

vmSize: string;

The size of the Virtual Machine, such as Standard_DS2_v2.

property vnetSubnetId

vnetSubnetId?: undefined | 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: string;

The principal id of the system assigned identity which is used by master components.

property tenantId

tenantId: 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: 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: string;

Base64 encoded public certificate used by clients to authenticate to the Kubernetes cluster.

property clientKey

clientKey: string;

Base64 encoded private key used by clients to authenticate to the Kubernetes cluster.

property clusterCaCertificate

clusterCaCertificate: string;

Base64 encoded public CA certificate used as the root of trust for the Kubernetes cluster.

property host

host: string;

The Kubernetes cluster server host.

property password

password: string;

A password or token used to authenticate to the Kubernetes cluster.

property username

username: string;

A username used to authenticate to the Kubernetes cluster.

interface KubernetesClusterKubeConfig

interface KubernetesClusterKubeConfig

property clientCertificate

clientCertificate: string;

Base64 encoded public certificate used by clients to authenticate to the Kubernetes cluster.

property clientKey

clientKey: string;

Base64 encoded private key used by clients to authenticate to the Kubernetes cluster.

property clusterCaCertificate

clusterCaCertificate: string;

Base64 encoded public CA certificate used as the root of trust for the Kubernetes cluster.

property host

host: string;

The Kubernetes cluster server host.

property password

password: string;

A password or token used to authenticate to the Kubernetes cluster.

property username

username: string;

A username used to authenticate to the Kubernetes cluster.

interface KubernetesClusterKubeletIdentity

interface KubernetesClusterKubeletIdentity

property clientId

clientId: string;

The Client ID for the Service Principal.

property objectId

objectId: string;

The Object ID of the user-defined Managed Identity used by the OMS Agents.

property userAssignedIdentityId

userAssignedIdentityId: string;

The ID of the User Assigned Identity used by the OMS Agents.

interface KubernetesClusterLinuxProfile

interface KubernetesClusterLinuxProfile

property adminUsername

adminUsername: string;

The Admin Username for the Cluster. Changing this forces a new resource to be created.

property sshKey

sshKey: 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: 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: 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: 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: KubernetesClusterNetworkProfileLoadBalancerProfile;

A loadBalancerProfile block. This can only be specified when loadBalancerSku is set to Standard.

property loadBalancerSku

loadBalancerSku?: undefined | 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: string;

Network plugin to use for networking. Currently supported values are azure and kubenet. Changing this forces a new resource to be created.

property networkPolicy

networkPolicy: string;

Sets up network policy to be used with Azure CNI. Network policy allows us to control the traffic flow between pods. Currently supported values are calico and azure. Changing this forces a new resource to be created.

property outboundType

outboundType?: undefined | string;

The outbound (egress) routing method which should be used for this Kubernetes Cluster. Possible values are loadBalancer and userDefinedRouting. Defaults to loadBalancer.

property podCidr

podCidr: string;

The CIDR to use for pod IP addresses. This field can only be set when networkPlugin is set to kubenet. Changing this forces a new resource to be created.

property serviceCidr

serviceCidr: string;

The Network Range used by the Kubernetes service. Changing this forces a new resource to be created.

interface KubernetesClusterNetworkProfileLoadBalancerProfile

interface KubernetesClusterNetworkProfileLoadBalancerProfile

property effectiveOutboundIps

effectiveOutboundIps: string[];

The outcome (resource IDs) of the specified arguments.

property idleTimeoutInMinutes

idleTimeoutInMinutes?: undefined | number;

Desired outbound flow idle timeout in minutes for the cluster load balancer. Must be between 4 and 120 inclusive. Defaults to 30.

property managedOutboundIpCount

managedOutboundIpCount: number;

Count of desired managed outbound IPs for the cluster load balancer. Must be between 1 and 100 inclusive.

property outboundIpAddressIds

outboundIpAddressIds: string[];

The ID of the Public IP Addresses which should be used for outbound communication for the cluster load balancer.

property outboundIpPrefixIds

outboundIpPrefixIds: string[];

The ID of the outbound Public IP Address Prefixes which should be used for the cluster load balancer.

property outboundPortsAllocated

outboundPortsAllocated?: undefined | number;

Number of desired SNAT port for each VM in the clusters load balancer. Must be between 0 and 64000 inclusive. Defaults to 0.

interface KubernetesClusterRoleBasedAccessControl

interface KubernetesClusterRoleBasedAccessControl

property azureActiveDirectory

azureActiveDirectory?: outputs.containerservice.KubernetesClusterRoleBasedAccessControlAzureActiveDirectory;

An azureActiveDirectory block.

property enabled

enabled: boolean;

Is Role Based Access Control Enabled? Changing this forces a new resource to be created.

interface KubernetesClusterRoleBasedAccessControlAzureActiveDirectory

interface KubernetesClusterRoleBasedAccessControlAzureActiveDirectory

property adminGroupObjectIds

adminGroupObjectIds?: string[];

A list of Object IDs of Azure Active Directory Groups which should have Admin Role on the Cluster.

property clientAppId

clientAppId?: undefined | string;

The Client ID of an Azure Active Directory Application.

property managed

managed?: undefined | false | true;

Is the Azure Active Directory integration Managed, meaning that Azure will create/manage the Service Principal used for integration.

property serverAppId

serverAppId?: undefined | string;

The Server ID of an Azure Active Directory Application.

property serverAppSecret

serverAppSecret?: undefined | string;

The Server Secret of an Azure Active Directory Application.

property tenantId

tenantId: string;

The Tenant ID used for Azure Active Directory Application. If this isn’t specified the Tenant ID of the current Subscription is used.

interface KubernetesClusterServicePrincipal

interface KubernetesClusterServicePrincipal

property clientId

clientId: string;

The Client ID for the Service Principal.

property clientSecret

clientSecret: string;

The Client Secret for the Service Principal.

interface KubernetesClusterWindowsProfile

interface KubernetesClusterWindowsProfile

property adminPassword

adminPassword?: undefined | string;

The Admin Password for Windows VMs.

property adminUsername

adminUsername: string;

The Admin Username for Windows VMs.

interface RegistryNetworkRuleSet

interface RegistryNetworkRuleSet

property defaultAction

defaultAction?: undefined | string;

The behaviour for requests matching no rules. Either Allow or Deny. Defaults to Allow

property ipRules

ipRules?: RegistryNetworkRuleSetIpRule[];

One or more ipRule blocks as defined below.

property virtualNetworks

virtualNetworks?: RegistryNetworkRuleSetVirtualNetwork[];

One or more virtualNetwork blocks as defined below.

interface RegistryNetworkRuleSetIpRule

interface RegistryNetworkRuleSetIpRule

property action

action: string;

The behaviour for requests matching this rule. At this time the only supported value is Allow

property ipRange

ipRange: string;

The CIDR block from which requests will match the rule.

interface RegistryNetworkRuleSetVirtualNetwork

interface RegistryNetworkRuleSetVirtualNetwork

property action

action: string;

The behaviour for requests matching this rule. At this time the only supported value is Allow

property subnetId

subnetId: string;

The subnet id from which requests will match the rule.

namespace core

interface CustomProviderAction

interface CustomProviderAction

property endpoint

endpoint: string;

Specifies the endpoint of the action.

property name

name: string;

Specifies the name of the action.

interface CustomProviderResourceType

interface CustomProviderResourceType

property endpoint

endpoint: string;

Specifies the endpoint of the route definition.

property name

name: string;

Specifies the name of the route definition.

property routingType

routingType?: undefined | string;

The routing type that is supported for the resource request. Valid values are ResourceTypeRoutingProxy or ResourceTypeRoutingProxyCache. This value defaults to ResourceTypeRoutingProxy.

interface CustomProviderValidation

interface CustomProviderValidation

property specification

specification: string;

The endpoint where the validation specification is located.

interface GetResourcesResource

interface GetResourcesResource

property id

id: string;

The ID of this Resource.

property location

location: string;

The Azure Region in which this Resource exists.

property name

name: string;

The name of the Resource.

property tags

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

A map of tags assigned to this Resource.

property type

type: string;

The Resource Type of the Resources you want to list (e.g. Microsoft.Network/virtualNetworks). A full list of available Resource Types can be found here.

interface GetSubscriptionsSubscription

interface GetSubscriptionsSubscription

property displayName

displayName: string;

The subscription display name.

property locationPlacementId

locationPlacementId: string;

The subscription location placement ID.

property quotaId

quotaId: string;

The subscription quota ID.

property spendingLimit

spendingLimit: string;

The subscription spending limit.

property state

state: string;

The subscription state. Possible values are Enabled, Warned, PastDue, Disabled, and Deleted.

property subscriptionId

subscriptionId: string;

The subscription GUID.

property tenantId

tenantId: string;

The subscription tenant ID.

namespace cosmosdb

interface AccountCapability

interface AccountCapability

property name

name: string;

Specifies the name of the CosmosDB Account. Changing this forces a new resource to be created.

interface AccountConsistencyPolicy

interface AccountConsistencyPolicy

property consistencyLevel

consistencyLevel: string;

The Consistency Level to use for this CosmosDB Account - can be either BoundedStaleness, Eventual, Session, Strong or ConsistentPrefix.

property maxIntervalInSeconds

maxIntervalInSeconds?: undefined | number;

When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400 (1 day). Defaults to 5. Required when consistencyLevel is set to BoundedStaleness.

property maxStalenessPrefix

maxStalenessPrefix?: undefined | number;

When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 10 – 2147483647. Defaults to 100. Required when consistencyLevel is set to BoundedStaleness.

interface AccountGeoLocation

interface AccountGeoLocation

property failoverPriority

failoverPriority: number;

The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists. Changing this causes the location to be re-provisioned and cannot be changed for the location with failover priority 0.

property id

id: string;

The ID of the virtual network subnet.

property location

location: string;

The name of the Azure region to host replicated data.

property prefix

prefix?: undefined | string;

The string used to generate the document endpoints for this region. If not specified it defaults to ${cosmosdb_account.name}-${location}. Changing this causes the location to be deleted and re-provisioned and cannot be changed for the location with failover priority 0.

interface AccountVirtualNetworkRule

interface AccountVirtualNetworkRule

property id

id: string;

The ID of the virtual network subnet.

interface GetAccountCapability

interface GetAccountCapability

property name

name: string;

Specifies the name of the CosmosDB Account.

interface GetAccountConsistencyPolicy

interface GetAccountConsistencyPolicy

property consistencyLevel

consistencyLevel: string;

The Consistency Level used by this CosmosDB Account.

property maxIntervalInSeconds

maxIntervalInSeconds: number;

The amount of staleness (in seconds) tolerated when the consistency level is Bounded Staleness.

property maxStalenessPrefix

maxStalenessPrefix: number;

The number of stale requests tolerated when the consistency level is Bounded Staleness.

interface GetAccountGeoLocation

interface GetAccountGeoLocation

property failoverPriority

failoverPriority: number;

property id

id: string;

The ID of the virtual network subnet.

property location

location: string;

The name of the Azure region hosting replicated data.

interface GetAccountVirtualNetworkRule

interface GetAccountVirtualNetworkRule

property id

id: string;

The ID of the virtual network subnet.

interface GremlinGraphConflictResolutionPolicy

interface GremlinGraphConflictResolutionPolicy

property conflictResolutionPath

conflictResolutionPath?: undefined | string;

The conflict resolution path in the case of LastWriterWins mode.

property conflictResolutionProcedure

conflictResolutionProcedure?: undefined | string;

The procedure to resolve conflicts in the case of custom mode.

property mode

mode: string;

Indicates the conflict resolution mode. Possible values include: LastWriterWins, Custom.

interface GremlinGraphIndexPolicy

interface GremlinGraphIndexPolicy

property automatic

automatic?: undefined | false | true;

Indicates if the indexing policy is automatic. Defaults to true.

property excludedPaths

excludedPaths?: string[];

List of paths to exclude from indexing. Required if indexingMode is Consistent or Lazy.

property includedPaths

includedPaths?: string[];

List of paths to include in the indexing. Required if indexingMode is Consistent or Lazy.

property indexingMode

indexingMode: string;

Indicates the indexing mode. Possible values include: Consistent, Lazy, None.

interface GremlinGraphUniqueKey

interface GremlinGraphUniqueKey

property paths

paths: string[];

A list of paths to use for this unique key.

interface MongoCollectionIndex

interface MongoCollectionIndex

property keys

keys: string[];

Specifies the list of user settable keys for each Cosmos DB Mongo Collection.

property unique

unique?: undefined | false | true;

Is the index unique or not? Defaults to false.

interface MongoCollectionSystemIndex

interface MongoCollectionSystemIndex

property keys

keys: string[];

Specifies the list of user settable keys for each Cosmos DB Mongo Collection.

property unique

unique: boolean;

Is the index unique or not? Defaults to false.

interface SqlContainerUniqueKey

interface SqlContainerUniqueKey

property paths

paths: string[];

A list of paths to use for this unique key.

namespace costmanagement

interface ResourceGroupExportDeliveryInfo

interface ResourceGroupExportDeliveryInfo

property containerName

containerName: string;

The name of the container where exports will be uploaded.

property rootFolderPath

rootFolderPath: string;

The path of the directory where exports will be uploaded.

property storageAccountId

storageAccountId: string;

The storage account id where exports will be delivered.

interface ResourceGroupExportQuery

interface ResourceGroupExportQuery

property timeFrame

timeFrame: string;

The time frame for pulling data for the query. If custom, then a specific time period must be provided. Possible values include: WeekToDate, MonthToDate, YearToDate, TheLastWeek, TheLastMonth, TheLastYear, Custom.

property type

type: string;

The type of the query.

namespace databricks

interface WorkspaceCustomParameters

interface WorkspaceCustomParameters

property noPublicIp

noPublicIp?: undefined | false | true;

Are public IP Addresses not allowed?

property privateSubnetName

privateSubnetName?: undefined | string;

The name of the Private Subnet within the Virtual Network. Required if virtualNetworkId is set.

property publicSubnetName

publicSubnetName?: undefined | string;

The name of the Public Subnet within the Virtual Network. Required if virtualNetworkId is set.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of a Virtual Network where this Databricks Cluster should be created.

namespace datafactory

interface DatasetMysqlSchemaColumn

interface DatasetMysqlSchemaColumn

property description

description?: undefined | string;

The description of the column.

property name

name: string;

The name of the column.

property type

type?: undefined | string;

Type of the column. Valid values are Byte, Byte[], Boolean, Date, DateTime,DateTimeOffset, Decimal, Double, Guid, Int16, Int32, Int64, Single, String, TimeSpan. Please note these values are case sensitive.

interface DatasetPostgresqlSchemaColumn

interface DatasetPostgresqlSchemaColumn

property description

description?: undefined | string;

The description of the column.

property name

name: string;

The name of the column.

property type

type?: undefined | string;

Type of the column. Valid values are Byte, Byte[], Boolean, Date, DateTime,DateTimeOffset, Decimal, Double, Guid, Int16, Int32, Int64, Single, String, TimeSpan. Please note these values are case sensitive.

interface DatasetSqlServerTableSchemaColumn

interface DatasetSqlServerTableSchemaColumn

property description

description?: undefined | string;

The description of the column.

property name

name: string;

The name of the column.

property type

type?: undefined | string;

Type of the column. Valid values are Byte, Byte[], Boolean, Date, DateTime,DateTimeOffset, Decimal, Double, Guid, Int16, Int32, Int64, Single, String, TimeSpan. Please note these values are case sensitive.

interface FactoryGithubConfiguration

interface FactoryGithubConfiguration

property accountName

accountName: string;

Specifies the GitHub account name.

property branchName

branchName: string;

Specifies the branch of the repository to get code from.

property gitUrl

gitUrl: string;

Specifies the GitHub Enterprise host name. For example: https://github.mydomain.com. Use https://github.com for open source repositories.

property repositoryName

repositoryName: string;

Specifies the name of the git repository.

property rootFolder

rootFolder: string;

Specifies the root folder within the repository. Set to / for the top level.

interface FactoryIdentity

interface FactoryIdentity

property principalId

principalId: string;

The ID of the Principal (Client) in Azure Active Directory

property tenantId

tenantId: string;

Specifies the Tenant ID associated with the VSTS account.

property type

type: string;

Specifies the identity type of the Data Factory. At this time the only allowed value is SystemAssigned.

interface FactoryVstsConfiguration

interface FactoryVstsConfiguration

property accountName

accountName: string;

Specifies the VSTS account name.

property branchName

branchName: string;

Specifies the branch of the repository to get code from.

property projectName

projectName: string;

Specifies the name of the VSTS project.

property repositoryName

repositoryName: string;

Specifies the name of the git repository.

property rootFolder

rootFolder: string;

Specifies the root folder within the repository. Set to / for the top level.

property tenantId

tenantId: string;

Specifies the Tenant ID associated with the VSTS account.

interface GetFactoryGithubConfiguration

interface GetFactoryGithubConfiguration

property accountName

accountName: string;

The VSTS account name.

property branchName

branchName: string;

The branch of the repository to get code from.

property gitUrl

gitUrl: string;

The GitHub Enterprise host name.

property repositoryName

repositoryName: string;

The name of the git repository.

property rootFolder

rootFolder: string;

The root folder within the repository.

interface GetFactoryIdentity

interface GetFactoryIdentity

property principalId

principalId: string;

The ID of the Principal (Client) in Azure Active Directory.

property tenantId

tenantId: string;

The Tenant ID associated with the VSTS account.

property type

type: string;

The identity type of the Data Factory.

interface GetFactoryVstsConfiguration

interface GetFactoryVstsConfiguration

property accountName

accountName: string;

The VSTS account name.

property branchName

branchName: string;

The branch of the repository to get code from.

property projectName

projectName: string;

The name of the VSTS project.

property repositoryName

repositoryName: string;

The name of the git repository.

property rootFolder

rootFolder: string;

The root folder within the repository.

property tenantId

tenantId: string;

The Tenant ID associated with the VSTS account.

interface IntegrationRuntimeManagedCatalogInfo

interface IntegrationRuntimeManagedCatalogInfo

property administratorLogin

administratorLogin: string;

Administrator login name for the SQL Server.

property administratorPassword

administratorPassword: string;

Administrator login password for the SQL Server.

property pricingTier

pricingTier?: undefined | string;

Pricing tier for the database that will be created for the SSIS catalog. Valid values are: Basic, Standard, Premium and PremiumRS.

property serverEndpoint

serverEndpoint: string;

The endpoint of an Azure SQL Server that will be used to host the SSIS catalog.

interface IntegrationRuntimeManagedCustomSetupScript

interface IntegrationRuntimeManagedCustomSetupScript

property blobContainerUri

blobContainerUri: string;

The blob endpoint for the container which contains a custom setup script that will be run on every node on startup. See https://docs.microsoft.com/en-us/azure/data-factory/how-to-configure-azure-ssis-ir-custom-setup for more information.

property sasToken

sasToken: string;

A container SAS token that gives access to the files. See https://docs.microsoft.com/en-us/azure/data-factory/how-to-configure-azure-ssis-ir-custom-setup for more information.

interface IntegrationRuntimeManagedVnetIntegration

interface IntegrationRuntimeManagedVnetIntegration

property subnetName

subnetName: string;

Name of the subnet to which the nodes of the Managed Integration Runtime will be added.

property vnetId

vnetId: string;

ID of the virtual network to which the nodes of the Managed Integration Runtime will be added.

namespace datashare

interface AccountIdentity

interface AccountIdentity

property principalId

principalId: string;

The Principal ID for the Service Principal associated with the Identity of this Data Share Account.

property tenantId

tenantId: string;

The Tenant ID for the Service Principal associated with the Identity of this Data Share Account.

property type

type: string;

Specifies the identity type of the Data Share Account. At this time the only allowed value is SystemAssigned.

interface GetAccountIdentity

interface GetAccountIdentity

property principalId

principalId: string;

The ID of the Principal (Client) in Azure Active Directory.

property tenantId

tenantId: string;

The ID of the Azure Active Directory Tenant.

property type

type: string;

The identity type of the Data Share Account.

interface GetShareSnapshotSchedule

interface GetShareSnapshotSchedule

property name

name: string;

The name of this Data Share.

property recurrence

recurrence: string;

The interval of the synchronization with the source data.

property startTime

startTime: string;

The synchronization with the source data’s start time.

interface ShareSnapshotSchedule

interface ShareSnapshotSchedule

property name

name: string;

The name of the snapshot schedule.

property recurrence

recurrence: string;

The interval of the synchronization with the source data. Possible values are Hour and Day.

property startTime

startTime: string;

The synchronization with the source data’s start time.

namespace devtest

interface GetVirtualNetworkAllowedSubnet

interface GetVirtualNetworkAllowedSubnet

property allowPublicIp

allowPublicIp: string;

Indicates if this subnet allows public IP addresses. Possible values are Allow, Default and Deny.

property labSubnetName

labSubnetName: string;

The name of the subnet.

property resourceId

resourceId: string;

The resource identifier for the subnet.

interface GetVirtualNetworkSubnetOverride

interface GetVirtualNetworkSubnetOverride

property labSubnetName

labSubnetName: string;

The name of the subnet.

property resourceId

resourceId: string;

The resource identifier for the subnet.

property useInVmCreationPermission

useInVmCreationPermission: string;

Indicates if the subnet can be used for VM creation. Possible values are Allow, Default and Deny.

property usePublicIpAddressPermission

usePublicIpAddressPermission: string;

property virtualNetworkPoolName

virtualNetworkPoolName: string;

The virtual network pool associated with this subnet.

interface GlobalVMShutdownScheduleNotificationSettings

interface GlobalVMShutdownScheduleNotificationSettings

property enabled

enabled: boolean;

Whether to enable pre-shutdown notifications. Possible values are true and false. Defaults to false

property timeInMinutes

timeInMinutes?: undefined | number;

Time in minutes between 15 and 120 before a shutdown event at which a notification will be sent. Defaults to 30.

property webhookUrl

webhookUrl?: undefined | string;

The webhook URL to which the notification will be sent. Required if enabled is true. Optional otherwise.

interface LinuxVirtualMachineGalleryImageReference

interface LinuxVirtualMachineGalleryImageReference

property offer

offer: string;

The Offer of the Gallery Image. Changing this forces a new resource to be created.

property publisher

publisher: string;

The Publisher of the Gallery Image. Changing this forces a new resource to be created.

property sku

sku: string;

The SKU of the Gallery Image. Changing this forces a new resource to be created.

property version

version: string;

The Version of the Gallery Image. Changing this forces a new resource to be created.

interface LinuxVirtualMachineInboundNatRule

interface LinuxVirtualMachineInboundNatRule

property backendPort

backendPort: number;

The Backend Port associated with this NAT Rule. Changing this forces a new resource to be created.

property frontendPort

frontendPort: number;

The frontend port associated with this Inbound NAT Rule.

property protocol

protocol: string;

The Protocol used for this NAT Rule. Possible values are Tcp and Udp. Changing this forces a new resource to be created.

interface ScheduleDailyRecurrence

interface ScheduleDailyRecurrence

property time

time: string;

The time each day when the schedule takes effect.

interface ScheduleHourlyRecurrence

interface ScheduleHourlyRecurrence

property minute

minute: number;

interface ScheduleNotificationSettings

interface ScheduleNotificationSettings

property status

status?: undefined | string;

The status of the notification. Possible values are Enabled and Disabled. Defaults to Disabled

property timeInMinutes

timeInMinutes?: undefined | number;

Time in minutes before event at which notification will be sent.

property webhookUrl

webhookUrl?: undefined | string;

The webhook URL to which the notification will be sent.

interface ScheduleWeeklyRecurrence

interface ScheduleWeeklyRecurrence

property time

time: string;

The time when the schedule takes effect.

property weekDays

weekDays?: string[];

A list of days that this schedule takes effect . Possible values include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.

interface VirtualNetworkSubnet

interface VirtualNetworkSubnet

property name

name: string;

Specifies the name of the Dev Test Virtual Network. Changing this forces a new resource to be created.

property useInVirtualMachineCreation

useInVirtualMachineCreation?: undefined | string;

Can this subnet be used for creating Virtual Machines? Possible values are Allow, Default and Deny.

property usePublicIpAddress

usePublicIpAddress?: undefined | string;

Can Virtual Machines in this Subnet use Public IP Addresses? Possible values are Allow, Default and Deny.

interface WindowsVirtualMachineGalleryImageReference

interface WindowsVirtualMachineGalleryImageReference

property offer

offer: string;

The Offer of the Gallery Image. Changing this forces a new resource to be created.

property publisher

publisher: string;

The Publisher of the Gallery Image. Changing this forces a new resource to be created.

property sku

sku: string;

The SKU of the Gallery Image. Changing this forces a new resource to be created.

property version

version: string;

The Version of the Gallery Image. Changing this forces a new resource to be created.

interface WindowsVirtualMachineInboundNatRule

interface WindowsVirtualMachineInboundNatRule

property backendPort

backendPort: number;

The Backend Port associated with this NAT Rule. Changing this forces a new resource to be created.

property frontendPort

frontendPort: number;

The frontend port associated with this Inbound NAT Rule.

property protocol

protocol: string;

The Protocol used for this NAT Rule. Possible values are Tcp and Udp. Changing this forces a new resource to be created.

namespace dns

interface CaaRecordRecord

interface CaaRecordRecord

property flags

flags: number;

Extensible CAA flags, currently only 1 is implemented to set the issuer critical flag.

property tag

tag: string;

A property tag, options are issue, issuewild and iodef.

property value

value: string;

A property value such as a registrar domain.

interface MxRecordRecord

interface MxRecordRecord

property exchange

exchange: string;

The mail server responsible for the domain covered by the MX record.

property preference

preference: string;

String representing the “preference” value of the MX records. Records with lower preference value take priority.

interface SrvRecordRecord

interface SrvRecordRecord

property port

port: number;

Port the service is listening on.

property priority

priority: number;

Priority of the SRV record.

property target

target: string;

FQDN of the service.

property weight

weight: number;

Weight of the SRV record.

interface TxtRecordRecord

interface TxtRecordRecord

property value

value: string;

The value of the record. Max length: 1024 characters

namespace eventgrid

interface DomainInputMappingDefaultValues

interface DomainInputMappingDefaultValues

property dataVersion

dataVersion?: undefined | string;

Specifies the default data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property eventType

eventType?: undefined | string;

Specifies the default event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property subject

subject?: undefined | string;

Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

interface DomainInputMappingFields

interface DomainInputMappingFields

property dataVersion

dataVersion?: undefined | string;

Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property eventTime

eventTime?: undefined | string;

Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property eventType

eventType?: undefined | string;

Specifies the event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property id

id?: undefined | string;

Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property subject

subject?: undefined | string;

Specifies the subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property topic

topic?: undefined | string;

Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

interface EventSubscriptionAdvancedFilter

interface EventSubscriptionAdvancedFilter

property boolEquals

boolEquals?: EventSubscriptionAdvancedFilterBoolEqual[];

Compares a value of an event using a single boolean value.

property numberGreaterThanOrEquals

numberGreaterThanOrEquals?: EventSubscriptionAdvancedFilterNumberGreaterThanOrEqual[];

Compares a value of an event using a single floating point number.

property numberGreaterThans

numberGreaterThans?: EventSubscriptionAdvancedFilterNumberGreaterThan[];

Compares a value of an event using a single floating point number.

property numberIns

numberIns?: EventSubscriptionAdvancedFilterNumberIn[];

Compares a value of an event using multiple floating point numbers.

property numberLessThanOrEquals

numberLessThanOrEquals?: EventSubscriptionAdvancedFilterNumberLessThanOrEqual[];

Compares a value of an event using a single floating point number.

property numberLessThans

numberLessThans?: EventSubscriptionAdvancedFilterNumberLessThan[];

Compares a value of an event using a single floating point number.

property numberNotIns

numberNotIns?: EventSubscriptionAdvancedFilterNumberNotIn[];

Compares a value of an event using multiple floating point numbers.

property stringBeginsWiths

stringBeginsWiths?: EventSubscriptionAdvancedFilterStringBeginsWith[];

Compares a value of an event using multiple string values.

property stringContains

stringContains?: EventSubscriptionAdvancedFilterStringContain[];

Compares a value of an event using multiple string values.

property stringEndsWiths

stringEndsWiths?: EventSubscriptionAdvancedFilterStringEndsWith[];

Compares a value of an event using multiple string values.

property stringIns

stringIns?: EventSubscriptionAdvancedFilterStringIn[];

Compares a value of an event using multiple string values.

property stringNotIns

stringNotIns?: EventSubscriptionAdvancedFilterStringNotIn[];

Compares a value of an event using multiple string values.

interface EventSubscriptionAdvancedFilterBoolEqual

interface EventSubscriptionAdvancedFilterBoolEqual

property key

key: string;

Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.

property value

value: boolean;

Specifies a single value to compare to when using a single value operator.

interface EventSubscriptionAdvancedFilterNumberGreaterThan

interface EventSubscriptionAdvancedFilterNumberGreaterThan

property key

key: string;

Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.

property value

value: number;

Specifies a single value to compare to when using a single value operator.

interface EventSubscriptionAdvancedFilterNumberGreaterThanOrEqual

interface EventSubscriptionAdvancedFilterNumberGreaterThanOrEqual

property key

key: string;

Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.

property value

value: number;

Specifies a single value to compare to when using a single value operator.

interface EventSubscriptionAdvancedFilterNumberIn

interface EventSubscriptionAdvancedFilterNumberIn

property key

key: string;

Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.

property values

values: number[];

Specifies an array of values to compare to when using a multiple values operator.

interface EventSubscriptionAdvancedFilterNumberLessThan

interface EventSubscriptionAdvancedFilterNumberLessThan

property key

key: string;

Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.

property value

value: number;

Specifies a single value to compare to when using a single value operator.

interface EventSubscriptionAdvancedFilterNumberLessThanOrEqual

interface EventSubscriptionAdvancedFilterNumberLessThanOrEqual

property key

key: string;

Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.

property value

value: number;

Specifies a single value to compare to when using a single value operator.

interface EventSubscriptionAdvancedFilterNumberNotIn

interface EventSubscriptionAdvancedFilterNumberNotIn

property key

key: string;

Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.

property values

values: number[];

Specifies an array of values to compare to when using a multiple values operator.

interface EventSubscriptionAdvancedFilterStringBeginsWith

interface EventSubscriptionAdvancedFilterStringBeginsWith

property key

key: string;

Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.

property values

values: string[];

Specifies an array of values to compare to when using a multiple values operator.

interface EventSubscriptionAdvancedFilterStringContain

interface EventSubscriptionAdvancedFilterStringContain

property key

key: string;

Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.

property values

values: string[];

Specifies an array of values to compare to when using a multiple values operator.

interface EventSubscriptionAdvancedFilterStringEndsWith

interface EventSubscriptionAdvancedFilterStringEndsWith

property key

key: string;

Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.

property values

values: string[];

Specifies an array of values to compare to when using a multiple values operator.

interface EventSubscriptionAdvancedFilterStringIn

interface EventSubscriptionAdvancedFilterStringIn

property key

key: string;

Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.

property values

values: string[];

Specifies an array of values to compare to when using a multiple values operator.

interface EventSubscriptionAdvancedFilterStringNotIn

interface EventSubscriptionAdvancedFilterStringNotIn

property key

key: string;

Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.

property values

values: string[];

Specifies an array of values to compare to when using a multiple values operator.

interface EventSubscriptionAzureFunctionEndpoint

interface EventSubscriptionAzureFunctionEndpoint

property functionId

functionId: string;

Specifies the ID of the Function where the Event Subscription will receive events.

property maxEventsPerBatch

maxEventsPerBatch?: undefined | number;

Maximum number of events per batch.

property preferredBatchSizeInKilobytes

preferredBatchSizeInKilobytes?: undefined | number;

Preferred batch size in Kilobytes.

interface EventSubscriptionEventhubEndpoint

interface EventSubscriptionEventhubEndpoint

property eventhubId

eventhubId: string;

Specifies the id of the eventhub where the Event Subscription will receive events.

interface EventSubscriptionHybridConnectionEndpoint

interface EventSubscriptionHybridConnectionEndpoint

property hybridConnectionId

hybridConnectionId: string;

Specifies the id of the hybrid connection where the Event Subscription will receive events.

interface EventSubscriptionRetryPolicy

interface EventSubscriptionRetryPolicy

property eventTimeToLive

eventTimeToLive: number;

Specifies the time to live (in minutes) for events.

property maxDeliveryAttempts

maxDeliveryAttempts: number;

Specifies the maximum number of delivery retry attempts for events.

interface EventSubscriptionStorageBlobDeadLetterDestination

interface EventSubscriptionStorageBlobDeadLetterDestination

property storageAccountId

storageAccountId: string;

Specifies the id of the storage account id where the storage blob is located.

property storageBlobContainerName

storageBlobContainerName: string;

Specifies the name of the Storage blob container that is the destination of the deadletter events.

interface EventSubscriptionStorageQueueEndpoint

interface EventSubscriptionStorageQueueEndpoint

property queueName

queueName: string;

Specifies the name of the storage queue where the Event Subscription will receive events.

property storageAccountId

storageAccountId: string;

Specifies the id of the storage account id where the storage queue is located.

interface EventSubscriptionSubjectFilter

interface EventSubscriptionSubjectFilter

property caseSensitive

caseSensitive?: undefined | false | true;

Specifies if subjectBeginsWith and subjectEndsWith case sensitive. This value defaults to false.

property subjectBeginsWith

subjectBeginsWith?: undefined | string;

A string to filter events for an event subscription based on a resource path prefix.

property subjectEndsWith

subjectEndsWith?: undefined | string;

A string to filter events for an event subscription based on a resource path suffix.

interface EventSubscriptionWebhookEndpoint

interface EventSubscriptionWebhookEndpoint

property activeDirectoryAppIdOrUri

activeDirectoryAppIdOrUri?: undefined | string;

The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests.

property activeDirectoryTenantId

activeDirectoryTenantId?: undefined | string;

The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.

property baseUrl

baseUrl: string;

The base url of the webhook where the Event Subscription will receive events.

property maxEventsPerBatch

maxEventsPerBatch?: undefined | number;

Maximum number of events per batch.

property preferredBatchSizeInKilobytes

preferredBatchSizeInKilobytes?: undefined | number;

Preferred batch size in Kilobytes.

property url

url: string;

Specifies the url of the webhook where the Event Subscription will receive events.

interface TopicInputMappingDefaultValues

interface TopicInputMappingDefaultValues

property dataVersion

dataVersion?: undefined | string;

Specifies the default data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property eventType

eventType?: undefined | string;

Specifies the default event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property subject

subject?: undefined | string;

Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

interface TopicInputMappingFields

interface TopicInputMappingFields

property dataVersion

dataVersion?: undefined | string;

Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property eventTime

eventTime?: undefined | string;

Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property eventType

eventType?: undefined | string;

Specifies the event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property id

id?: undefined | string;

Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property subject

subject?: undefined | string;

Specifies the subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property topic

topic?: undefined | string;

Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

namespace eventhub

interface DomainInputMappingDefaultValues

interface DomainInputMappingDefaultValues

property dataVersion

dataVersion?: undefined | string;

Specifies the default data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property eventType

eventType?: undefined | string;

Specifies the default event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property subject

subject?: undefined | string;

Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

interface DomainInputMappingFields

interface DomainInputMappingFields

property dataVersion

dataVersion?: undefined | string;

Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property eventTime

eventTime?: undefined | string;

Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property eventType

eventType?: undefined | string;

Specifies the event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property id

id?: undefined | string;

Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property subject

subject?: undefined | string;

Specifies the subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property topic

topic?: undefined | string;

Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

interface EventGridTopicInputMappingDefaultValues

interface EventGridTopicInputMappingDefaultValues

property dataVersion

dataVersion?: undefined | string;

Specifies the default data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property eventType

eventType?: undefined | string;

Specifies the default event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property subject

subject?: undefined | string;

Specifies the default subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

interface EventGridTopicInputMappingFields

interface EventGridTopicInputMappingFields

property dataVersion

dataVersion?: undefined | string;

Specifies the data version of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property eventTime

eventTime?: undefined | string;

Specifies the event time of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property eventType

eventType?: undefined | string;

Specifies the event type of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property id

id?: undefined | string;

Specifies the id of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property subject

subject?: undefined | string;

Specifies the subject of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

property topic

topic?: undefined | string;

Specifies the topic of the EventGrid Event to associate with the domain. Changing this forces a new resource to be created.

interface EventHubCaptureDescription

interface EventHubCaptureDescription

property destination

destination: EventHubCaptureDescriptionDestination;

A destination block as defined below.

property enabled

enabled: boolean;

Specifies if the Capture Description is Enabled.

property encoding

encoding: string;

Specifies the Encoding used for the Capture Description. Possible values are Avro and AvroDeflate.

property intervalInSeconds

intervalInSeconds?: undefined | number;

Specifies the time interval in seconds at which the capture will happen. Values can be between 60 and 900 seconds. Defaults to 300 seconds.

property sizeLimitInBytes

sizeLimitInBytes?: undefined | number;

Specifies the amount of data built up in your EventHub before a Capture Operation occurs. Value should be between 10485760 and 524288000 bytes. Defaults to 314572800 bytes.

property skipEmptyArchives

skipEmptyArchives?: undefined | false | true;

Specifies if empty files should not be emitted if no events occur during the Capture time window. Defaults to false.

interface EventHubCaptureDescriptionDestination

interface EventHubCaptureDescriptionDestination

property archiveNameFormat

archiveNameFormat: string;

The Blob naming convention for archiving. e.g. {Namespace}/{EventHub}/{PartitionId}/{Year}/{Month}/{Day}/{Hour}/{Minute}/{Second}. Here all the parameters (Namespace,EventHub .. etc) are mandatory irrespective of order

property blobContainerName

blobContainerName: string;

The name of the Container within the Blob Storage Account where messages should be archived.

property name

name: string;

The Name of the Destination where the capture should take place. At this time the only supported value is EventHubArchive.AzureBlockBlob.

property storageAccountId

storageAccountId: string;

The ID of the Blob Storage Account where messages should be archived.

interface EventHubNamespaceNetworkRulesets

interface EventHubNamespaceNetworkRulesets

property defaultAction

defaultAction: string;

The default action to take when a rule is not matched. Possible values are Allow and Deny. Defaults to Deny.

property ipRules

ipRules?: EventHubNamespaceNetworkRulesetsIpRule[];

One or more ipRule blocks as defined below.

property virtualNetworkRules

virtualNetworkRules?: EventHubNamespaceNetworkRulesetsVirtualNetworkRule[];

One or more virtualNetworkRule blocks as defined below.

interface EventHubNamespaceNetworkRulesetsIpRule

interface EventHubNamespaceNetworkRulesetsIpRule

property action

action?: undefined | string;

The action to take when the rule is matched. Possible values are Allow.

property ipMask

ipMask: string;

The ip mask to match on.

interface EventHubNamespaceNetworkRulesetsVirtualNetworkRule

interface EventHubNamespaceNetworkRulesetsVirtualNetworkRule

property ignoreMissingVirtualNetworkServiceEndpoint

ignoreMissingVirtualNetworkServiceEndpoint?: undefined | false | true;

Are missing virtual network service endpoints ignored? Defaults to false.

property subnetId

subnetId: string;

The id of the subnet to match on.

interface EventSubscriptionAdvancedFilter

interface EventSubscriptionAdvancedFilter

property boolEquals

boolEquals?: EventSubscriptionAdvancedFilterBoolEqual[];

Compares a value of an event using a single boolean value.

property numberGreaterThanOrEquals

numberGreaterThanOrEquals?: EventSubscriptionAdvancedFilterNumberGreaterThanOrEqual[];

Compares a value of an event using a single floating point number.

property numberGreaterThans

numberGreaterThans?: EventSubscriptionAdvancedFilterNumberGreaterThan[];

Compares a value of an event using a single floating point number.

property numberIns

numberIns?: EventSubscriptionAdvancedFilterNumberIn[];

Compares a value of an event using multiple floating point numbers.

property numberLessThanOrEquals

numberLessThanOrEquals?: EventSubscriptionAdvancedFilterNumberLessThanOrEqual[];

Compares a value of an event using a single floating point number.

property numberLessThans

numberLessThans?: EventSubscriptionAdvancedFilterNumberLessThan[];

Compares a value of an event using a single floating point number.

property numberNotIns

numberNotIns?: EventSubscriptionAdvancedFilterNumberNotIn[];

Compares a value of an event using multiple floating point numbers.

property stringBeginsWiths

stringBeginsWiths?: EventSubscriptionAdvancedFilterStringBeginsWith[];

Compares a value of an event using multiple string values.

property stringContains

stringContains?: EventSubscriptionAdvancedFilterStringContain[];

Compares a value of an event using multiple string values.

property stringEndsWiths

stringEndsWiths?: EventSubscriptionAdvancedFilterStringEndsWith[];

Compares a value of an event using multiple string values.

property stringIns

stringIns?: EventSubscriptionAdvancedFilterStringIn[];

Compares a value of an event using multiple string values.

property stringNotIns

stringNotIns?: EventSubscriptionAdvancedFilterStringNotIn[];

Compares a value of an event using multiple string values.

interface EventSubscriptionAdvancedFilterBoolEqual

interface EventSubscriptionAdvancedFilterBoolEqual

property key

key: string;

Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.

property value

value: boolean;

Specifies a single value to compare to when using a single value operator.

interface EventSubscriptionAdvancedFilterNumberGreaterThan

interface EventSubscriptionAdvancedFilterNumberGreaterThan

property key

key: string;

Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.

property value

value: number;

Specifies a single value to compare to when using a single value operator.

interface EventSubscriptionAdvancedFilterNumberGreaterThanOrEqual

interface EventSubscriptionAdvancedFilterNumberGreaterThanOrEqual

property key

key: string;

Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.

property value

value: number;

Specifies a single value to compare to when using a single value operator.

interface EventSubscriptionAdvancedFilterNumberIn

interface EventSubscriptionAdvancedFilterNumberIn

property key

key: string;

Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.

property values

values: number[];

Specifies an array of values to compare to when using a multiple values operator.

interface EventSubscriptionAdvancedFilterNumberLessThan

interface EventSubscriptionAdvancedFilterNumberLessThan

property key

key: string;

Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.

property value

value: number;

Specifies a single value to compare to when using a single value operator.

interface EventSubscriptionAdvancedFilterNumberLessThanOrEqual

interface EventSubscriptionAdvancedFilterNumberLessThanOrEqual

property key

key: string;

Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.

property value

value: number;

Specifies a single value to compare to when using a single value operator.

interface EventSubscriptionAdvancedFilterNumberNotIn

interface EventSubscriptionAdvancedFilterNumberNotIn

property key

key: string;

Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.

property values

values: number[];

Specifies an array of values to compare to when using a multiple values operator.

interface EventSubscriptionAdvancedFilterStringBeginsWith

interface EventSubscriptionAdvancedFilterStringBeginsWith

property key

key: string;

Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.

property values

values: string[];

Specifies an array of values to compare to when using a multiple values operator.

interface EventSubscriptionAdvancedFilterStringContain

interface EventSubscriptionAdvancedFilterStringContain

property key

key: string;

Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.

property values

values: string[];

Specifies an array of values to compare to when using a multiple values operator.

interface EventSubscriptionAdvancedFilterStringEndsWith

interface EventSubscriptionAdvancedFilterStringEndsWith

property key

key: string;

Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.

property values

values: string[];

Specifies an array of values to compare to when using a multiple values operator.

interface EventSubscriptionAdvancedFilterStringIn

interface EventSubscriptionAdvancedFilterStringIn

property key

key: string;

Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.

property values

values: string[];

Specifies an array of values to compare to when using a multiple values operator.

interface EventSubscriptionAdvancedFilterStringNotIn

interface EventSubscriptionAdvancedFilterStringNotIn

property key

key: string;

Specifies the field within the event data that you want to use for filtering. Type of the field can be a number, boolean, or string.

property values

values: string[];

Specifies an array of values to compare to when using a multiple values operator.

interface EventSubscriptionAzureFunctionEndpoint

interface EventSubscriptionAzureFunctionEndpoint

property functionId

functionId: string;

Specifies the ID of the Function where the Event Subscription will receive events.

property maxEventsPerBatch

maxEventsPerBatch?: undefined | number;

Maximum number of events per batch.

property preferredBatchSizeInKilobytes

preferredBatchSizeInKilobytes?: undefined | number;

Preferred batch size in Kilobytes.

interface EventSubscriptionEventhubEndpoint

interface EventSubscriptionEventhubEndpoint

property eventhubId

eventhubId: string;

Specifies the id of the eventhub where the Event Subscription will receive events.

interface EventSubscriptionHybridConnectionEndpoint

interface EventSubscriptionHybridConnectionEndpoint

property hybridConnectionId

hybridConnectionId: string;

Specifies the id of the hybrid connection where the Event Subscription will receive events.

interface EventSubscriptionRetryPolicy

interface EventSubscriptionRetryPolicy

property eventTimeToLive

eventTimeToLive: number;

Specifies the time to live (in minutes) for events.

property maxDeliveryAttempts

maxDeliveryAttempts: number;

Specifies the maximum number of delivery retry attempts for events.

interface EventSubscriptionStorageBlobDeadLetterDestination

interface EventSubscriptionStorageBlobDeadLetterDestination

property storageAccountId

storageAccountId: string;

Specifies the id of the storage account id where the storage blob is located.

property storageBlobContainerName

storageBlobContainerName: string;

Specifies the name of the Storage blob container that is the destination of the deadletter events.

interface EventSubscriptionStorageQueueEndpoint

interface EventSubscriptionStorageQueueEndpoint

property queueName

queueName: string;

Specifies the name of the storage queue where the Event Subscription will receive events.

property storageAccountId

storageAccountId: string;

Specifies the id of the storage account id where the storage queue is located.

interface EventSubscriptionSubjectFilter

interface EventSubscriptionSubjectFilter

property caseSensitive

caseSensitive?: undefined | false | true;

Specifies if subjectBeginsWith and subjectEndsWith case sensitive. This value defaults to false.

property subjectBeginsWith

subjectBeginsWith?: undefined | string;

A string to filter events for an event subscription based on a resource path prefix.

property subjectEndsWith

subjectEndsWith?: undefined | string;

A string to filter events for an event subscription based on a resource path suffix.

interface EventSubscriptionWebhookEndpoint

interface EventSubscriptionWebhookEndpoint

property activeDirectoryAppIdOrUri

activeDirectoryAppIdOrUri?: undefined | string;

The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests.

property activeDirectoryTenantId

activeDirectoryTenantId?: undefined | string;

The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.

property baseUrl

baseUrl: string;

The base url of the webhook where the Event Subscription will receive events.

property maxEventsPerBatch

maxEventsPerBatch?: undefined | number;

Maximum number of events per batch.

property preferredBatchSizeInKilobytes

preferredBatchSizeInKilobytes?: undefined | number;

Preferred batch size in Kilobytes.

property url

url: string;

Specifies the url of the webhook where the Event Subscription will receive events.

interface SubscriptionRuleCorrelationFilter

interface SubscriptionRuleCorrelationFilter

property contentType

contentType?: undefined | string;

Content type of the message.

property correlationId

correlationId?: undefined | string;

Identifier of the correlation.

property label

label?: undefined | string;

Application specific label.

property messageId

messageId?: undefined | string;

Identifier of the message.

property replyTo

replyTo?: undefined | string;

Address of the queue to reply to.

property replyToSessionId

replyToSessionId?: undefined | string;

Session identifier to reply to.

property sessionId

sessionId?: undefined | string;

Session identifier.

property to

to?: undefined | string;

Address to send to.

namespace frontdoor

interface FirewallPolicyCustomRule

interface FirewallPolicyCustomRule

property action

action: string;

The action to perform when the rule is matched. Possible values are Allow, Block, Log, or Redirect.

property enabled

enabled?: undefined | false | true;

Is the rule is enabled or disabled? Defaults to true.

property matchConditions

matchConditions?: FirewallPolicyCustomRuleMatchCondition[];

One or more matchCondition block defined below.

property name

name: string;

Gets name of the resource that is unique within a policy. This name can be used to access the resource.

property priority

priority?: undefined | number;

The priority of the rule. Rules with a lower value will be evaluated before rules with a higher value. Defaults to 1.

property rateLimitDurationInMinutes

rateLimitDurationInMinutes?: undefined | number;

The rate limit duration in minutes. Defaults to 1.

property rateLimitThreshold

rateLimitThreshold?: undefined | number;

The rate limit threshold. Defaults to 10.

property type

type: string;

The type of rule. Possible values are MatchRule or RateLimitRule.

interface FirewallPolicyCustomRuleMatchCondition

interface FirewallPolicyCustomRuleMatchCondition

property matchValues

matchValues: string[];

Up to 100 possible values to match.

property matchVariable

matchVariable: string;

The request variable to compare with. Possible values are Cookies, PostArgs, QueryString, RemoteAddr, RequestBody, RequestHeader, RequestMethod, or RequestUri.

property negationCondition

negationCondition?: undefined | false | true;

Should the result of the condition be negated.

property operator

operator: string;

Comparison type to use for matching with the variable value. Possible values are Any, BeginsWith, Contains, EndsWith, Equal, GeoMatch, GreaterThan, GreaterThanOrEqual, IPMatch, LessThan, LessThanOrEqual or RegEx.

property selector

selector?: undefined | string;

Match against a specific key if the matchVariable is QueryString, PostArgs, RequestHeader or Cookies.

property transforms

transforms?: string[];

Up to 5 transforms to apply. Possible values are Lowercase, RemoveNulls, Trim, Uppercase, URLDecode orURLEncode.

interface FirewallPolicyManagedRule

interface FirewallPolicyManagedRule

property exclusions

exclusions?: FirewallPolicyManagedRuleExclusion[];

One or more exclusion blocks as defined below.

property overrides

overrides?: FirewallPolicyManagedRuleOverride[];

One or more override blocks as defined below.

property type

type: string;

The name of the managed rule to use with this resource.

property version

version: string;

The version on the managed rule to use with this resource.

interface FirewallPolicyManagedRuleExclusion

interface FirewallPolicyManagedRuleExclusion

property matchVariable

matchVariable: string;

The variable type to be excluded. Possible values are QueryStringArgNames, RequestBodyPostArgNames, RequestCookieNames, RequestHeaderNames.

property operator

operator: string;

Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. Possible values are: Equals, Contains, StartsWith, EndsWith, EqualsAny.

property selector

selector: string;

Selector for the value in the matchVariable attribute this exclusion applies to.

interface FirewallPolicyManagedRuleOverride

interface FirewallPolicyManagedRuleOverride

property exclusions

exclusions?: FirewallPolicyManagedRuleOverrideExclusion[];

One or more exclusion blocks as defined below.

property ruleGroupName

ruleGroupName: string;

The managed rule group to override.

property rules

rules?: FirewallPolicyManagedRuleOverrideRule[];

One or more rule blocks as defined below. If none are specified, all of the rules in the group will be disabled.

interface FirewallPolicyManagedRuleOverrideExclusion

interface FirewallPolicyManagedRuleOverrideExclusion

property matchVariable

matchVariable: string;

The variable type to be excluded. Possible values are QueryStringArgNames, RequestBodyPostArgNames, RequestCookieNames, RequestHeaderNames.

property operator

operator: string;

Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. Possible values are: Equals, Contains, StartsWith, EndsWith, EqualsAny.

property selector

selector: string;

Selector for the value in the matchVariable attribute this exclusion applies to.

interface FirewallPolicyManagedRuleOverrideRule

interface FirewallPolicyManagedRuleOverrideRule

property action

action: string;

The action to be applied when the rule matches. Possible values are Allow, Block, Log, or Redirect.

property enabled

enabled?: undefined | false | true;

Is the managed rule override enabled or disabled. Defaults to false

property exclusions

exclusions?: FirewallPolicyManagedRuleOverrideRuleExclusion[];

One or more exclusion blocks as defined below.

property ruleId

ruleId: string;

Identifier for the managed rule.

interface FirewallPolicyManagedRuleOverrideRuleExclusion

interface FirewallPolicyManagedRuleOverrideRuleExclusion

property matchVariable

matchVariable: string;

The variable type to be excluded. Possible values are QueryStringArgNames, RequestBodyPostArgNames, RequestCookieNames, RequestHeaderNames.

property operator

operator: string;

Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to. Possible values are: Equals, Contains, StartsWith, EndsWith, EqualsAny.

property selector

selector: string;

Selector for the value in the matchVariable attribute this exclusion applies to.

interface FrontdoorBackendPool

interface FrontdoorBackendPool

property backends

backends: FrontdoorBackendPoolBackend[];

A backend block as defined below.

property healthProbeName

healthProbeName: string;

Specifies the name of the backendPoolHealthProbe block whithin this resource to use for this Backend Pool.

property id

id: string;

The ID of the FrontDoor.

property loadBalancingName

loadBalancingName: string;

Specifies the name of the backendPoolLoadBalancing block within this resource to use for this Backend Pool.

property name

name: string;

Specifies the name of the Backend Pool.

interface FrontdoorBackendPoolBackend

interface FrontdoorBackendPoolBackend

property address

address: string;

Location of the backend (IP address or FQDN)

property enabled

enabled?: undefined | false | true;

Specifies if the backend is enabled or not. Valid options are true or false. Defaults to true.

property hostHeader

hostHeader: string;

The value to use as the host header sent to the backend.

property httpPort

httpPort: number;

The HTTP TCP port number. Possible values are between 1 - 65535.

property httpsPort

httpsPort: number;

The HTTPS TCP port number. Possible values are between 1 - 65535.

property priority

priority?: undefined | number;

Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy. Defaults to 1.

property weight

weight?: undefined | number;

Weight of this endpoint for load balancing purposes. Defaults to 50.

interface FrontdoorBackendPoolHealthProbe

interface FrontdoorBackendPoolHealthProbe

property enabled

enabled?: undefined | false | true;

Is this health probe enabled? Dafaults to true.

property id

id: string;

The ID of the FrontDoor.

property intervalInSeconds

intervalInSeconds?: undefined | number;

The number of seconds between each Health Probe. Defaults to 120.

property name

name: string;

Specifies the name of the Health Probe.

property path

path?: undefined | string;

The path to use for the Health Probe. Default is /.

property probeMethod

probeMethod?: undefined | string;

Specifies HTTP method the health probe uses when querying the backend pool instances. Possible values include: Get and Head. Defaults to Get.

property protocol

protocol?: undefined | string;

Protocol scheme to use for the Health Probe. Defaults to Http.

interface FrontdoorBackendPoolLoadBalancing

interface FrontdoorBackendPoolLoadBalancing

property additionalLatencyMilliseconds

additionalLatencyMilliseconds?: undefined | number;

The additional latency in milliseconds for probes to fall into the lowest latency bucket. Defaults to 0.

property id

id: string;

The ID of the FrontDoor.

property name

name: string;

Specifies the name of the Load Balancer.

property sampleSize

sampleSize?: undefined | number;

The number of samples to consider for load balancing decisions. Defaults to 4.

property successfulSamplesRequired

successfulSamplesRequired?: undefined | number;

The number of samples within the sample period that must succeed. Defaults to 2.

interface FrontdoorFrontendEndpoint

interface FrontdoorFrontendEndpoint

property customHttpsConfiguration

customHttpsConfiguration?: outputs.frontdoor.FrontdoorFrontendEndpointCustomHttpsConfiguration;

A customHttpsConfiguration block as defined below.

property customHttpsProvisioningEnabled

customHttpsProvisioningEnabled: boolean;

Should the HTTPS protocol be enabled for a custom domain associated with the Front Door?

property hostName

hostName: string;

Specifies the host name of the frontendEndpoint. Must be a domain name.

property id

id: string;

The ID of the FrontDoor.

property name

name: string;

Specifies the name of the frontendEndpoint.

property sessionAffinityEnabled

sessionAffinityEnabled?: undefined | false | true;

Whether to allow session affinity on this host. Valid options are true or false Defaults to false.

property sessionAffinityTtlSeconds

sessionAffinityTtlSeconds?: undefined | number;

The TTL to use in seconds for session affinity, if applicable. Defaults to 0.

property webApplicationFirewallPolicyLinkId

webApplicationFirewallPolicyLinkId?: undefined | string;

Defines the Web Application Firewall policy ID for each host.

interface FrontdoorFrontendEndpointCustomHttpsConfiguration

interface FrontdoorFrontendEndpointCustomHttpsConfiguration

property azureKeyVaultCertificateSecretName

azureKeyVaultCertificateSecretName?: undefined | string;

The name of the Key Vault secret representing the full certificate PFX.

property azureKeyVaultCertificateSecretVersion

azureKeyVaultCertificateSecretVersion?: undefined | string;

The version of the Key Vault secret representing the full certificate PFX.

property azureKeyVaultCertificateVaultId

azureKeyVaultCertificateVaultId?: undefined | string;

The ID of the Key Vault containing the SSL certificate.

property certificateSource

certificateSource?: undefined | string;

Certificate source to encrypted HTTPS traffic with. Allowed values are FrontDoor or AzureKeyVault. Defaults to FrontDoor.

property minimumTlsVersion

minimumTlsVersion: string;

Minimum client TLS version supported.

property provisioningState

provisioningState: string;

Provisioning state of the Front Door.

property provisioningSubstate

provisioningSubstate: string;

Provisioning substate of the Front Door

interface FrontdoorRoutingRule

interface FrontdoorRoutingRule

property acceptedProtocols

acceptedProtocols: string[];

Protocol schemes to match for the Backend Routing Rule. Defaults to Http.

property enabled

enabled?: undefined | false | true;

Enable or Disable use of this Backend Routing Rule. Permitted values are true or false. Defaults to true.

property forwardingConfiguration

forwardingConfiguration?: outputs.frontdoor.FrontdoorRoutingRuleForwardingConfiguration;

A forwardingConfiguration block as defined below.

property frontendEndpoints

frontendEndpoints: string[];

The names of the frontendEndpoint blocks whithin this resource to associate with this routingRule.

property id

id: string;

The ID of the FrontDoor.

property name

name: string;

Specifies the name of the Routing Rule.

property patternsToMatches

patternsToMatches: string[];

The route patterns for the Backend Routing Rule. Defaults to /*.

property redirectConfiguration

redirectConfiguration?: outputs.frontdoor.FrontdoorRoutingRuleRedirectConfiguration;

A redirectConfiguration block as defined below.

interface FrontdoorRoutingRuleForwardingConfiguration

interface FrontdoorRoutingRuleForwardingConfiguration

property backendPoolName

backendPoolName: string;

Specifies the name of the Backend Pool to forward the incoming traffic to.

property cacheEnabled

cacheEnabled?: undefined | false | true;

Specifies whether to Enable caching or not. Valid options are true or false. Defaults to false.

property cacheQueryParameterStripDirective

cacheQueryParameterStripDirective?: undefined | string;

Defines cache behavior in releation to query string parameters. Valid options are StripAll or StripNone. Defaults to StripAll.

property cacheUseDynamicCompression

cacheUseDynamicCompression?: undefined | false | true;

Whether to use dynamic compression when caching. Valid options are true or false. Defaults to false.

property customForwardingPath

customForwardingPath?: undefined | string;

Path to use when constructing the request to forward to the backend. This functions as a URL Rewrite. Default behavior preserves the URL path.

property forwardingProtocol

forwardingProtocol?: undefined | string;

Protocol to use when redirecting. Valid options are HttpOnly, HttpsOnly, or MatchRequest. Defaults to HttpsOnly.

interface FrontdoorRoutingRuleRedirectConfiguration

interface FrontdoorRoutingRuleRedirectConfiguration

property customFragment

customFragment?: undefined | string;

The destination fragment in the portion of URL after ‘#’. Set this to add a fragment to the redirect URL.

property customHost

customHost?: undefined | string;

Set this to change the URL for the redirection.

property customPath

customPath?: undefined | string;

The path to retain as per the incoming request, or update in the URL for the redirection.

property customQueryString

customQueryString?: undefined | string;

Replace any existing query string from the incoming request URL.

property redirectProtocol

redirectProtocol: string;

Protocol to use when redirecting. Valid options are HttpOnly, HttpsOnly, or MatchRequest. Defaults to MatchRequest

property redirectType

redirectType: string;

Status code for the redirect. Valida options are Moved, Found, TemporaryRedirect, PermanentRedirect. Defaults to Found

namespace hdinsight

interface GetClusterGateway

interface GetClusterGateway

property enabled

enabled: boolean;

Is the Ambari Portal enabled?

property password

password: string;

The password used for the Ambari Portal.

property username

username: string;

The username used for the Ambari Portal.

interface HadoopClusterComponentVersion

interface HadoopClusterComponentVersion

property hadoop

hadoop: string;

The version of Hadoop which should be used for this HDInsight Hadoop Cluster. Changing this forces a new resource to be created.

interface HadoopClusterGateway

interface HadoopClusterGateway

property enabled

enabled: boolean;

Is the Ambari portal enabled? Changing this forces a new resource to be created.

property password

password: string;

The password used for the Ambari Portal. Changing this forces a new resource to be created.

property username

username: string;

The username used for the Ambari Portal. Changing this forces a new resource to be created.

interface HadoopClusterMetastores

interface HadoopClusterMetastores

property ambari

ambari?: outputs.hdinsight.HadoopClusterMetastoresAmbari;

An ambari block as defined below.

property hive

hive?: outputs.hdinsight.HadoopClusterMetastoresHive;

A hive block as defined below.

property oozie

oozie?: outputs.hdinsight.HadoopClusterMetastoresOozie;

An oozie block as defined below.

interface HadoopClusterMetastoresAmbari

interface HadoopClusterMetastoresAmbari

property databaseName

databaseName: string;

The external Hive metastore’s existing SQL database. Changing this forces a new resource to be created.

property password

password: string;

The external Ambari metastore’s existing SQL server admin password. Changing this forces a new resource to be created.

property server

server: string;

The fully-qualified domain name (FQDN) of the SQL server to use for the external Ambari metastore. Changing this forces a new resource to be created.

property username

username: string;

The external Ambari metastore’s existing SQL server admin username. Changing this forces a new resource to be created.

interface HadoopClusterMetastoresHive

interface HadoopClusterMetastoresHive

property databaseName

databaseName: string;

The external Hive metastore’s existing SQL database. Changing this forces a new resource to be created.

property password

password: string;

The external Hive metastore’s existing SQL server admin password. Changing this forces a new resource to be created.

property server

server: string;

The fully-qualified domain name (FQDN) of the SQL server to use for the external Hive metastore. Changing this forces a new resource to be created.

property username

username: string;

The external Hive metastore’s existing SQL server admin username. Changing this forces a new resource to be created.

interface HadoopClusterMetastoresOozie

interface HadoopClusterMetastoresOozie

property databaseName

databaseName: string;

The external Oozie metastore’s existing SQL database. Changing this forces a new resource to be created.

property password

password: string;

The external Oozie metastore’s existing SQL server admin password. Changing this forces a new resource to be created.

property server

server: string;

The fully-qualified domain name (FQDN) of the SQL server to use for the external Oozie metastore. Changing this forces a new resource to be created.

property username

username: string;

The external Oozie metastore’s existing SQL server admin username. Changing this forces a new resource to be created.

interface HadoopClusterRoles

interface HadoopClusterRoles

property edgeNode

edgeNode?: outputs.hdinsight.HadoopClusterRolesEdgeNode;

A edgeNode block as defined below.

property headNode

headNode: HadoopClusterRolesHeadNode;

A headNode block as defined above.

property workerNode

workerNode: HadoopClusterRolesWorkerNode;

A workerNode block as defined below.

property zookeeperNode

zookeeperNode: HadoopClusterRolesZookeeperNode;

A zookeeperNode block as defined below.

interface HadoopClusterRolesEdgeNode

interface HadoopClusterRolesEdgeNode

property installScriptActions

installScriptActions: HadoopClusterRolesEdgeNodeInstallScriptAction[];

A installScriptAction block as defined below.

property targetInstanceCount

targetInstanceCount: number;

The number of instances which should be run for the Worker Nodes.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Edge Nodes. Changing this forces a new resource to be created.

interface HadoopClusterRolesEdgeNodeInstallScriptAction

interface HadoopClusterRolesEdgeNodeInstallScriptAction

property name

name: string;

The name of the install script action. Changing this forces a new resource to be created.

property uri

uri: string;

The URI pointing to the script to run during the installation of the edge node. Changing this forces a new resource to be created.

interface HadoopClusterRolesHeadNode

interface HadoopClusterRolesHeadNode

property password

password?: undefined | string;

The Password associated with the local administrator for the Head Nodes. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Head Nodes. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Head Nodes should be provisioned within. Changing this forces a new resource to be created.

property username

username: string;

The Username of the local administrator for the Head Nodes. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Head Nodes should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Head Nodes. Changing this forces a new resource to be created.

interface HadoopClusterRolesWorkerNode

interface HadoopClusterRolesWorkerNode

property minInstanceCount

minInstanceCount?: undefined | number;

The minimum number of instances which should be run for the Worker Nodes. Changing this forces a new resource to be created.

property password

password?: undefined | string;

The Password associated with the local administrator for the Worker Nodes. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Worker Nodes. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Worker Nodes should be provisioned within. Changing this forces a new resource to be created.

property targetInstanceCount

targetInstanceCount: number;

The number of instances which should be run for the Worker Nodes.

property username

username: string;

The Username of the local administrator for the Worker Nodes. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Worker Nodes should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Worker Nodes. Changing this forces a new resource to be created.

interface HadoopClusterRolesZookeeperNode

interface HadoopClusterRolesZookeeperNode

property password

password?: undefined | string;

The Password associated with the local administrator for the Zookeeper Nodes. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Zookeeper Nodes. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Zookeeper Nodes should be provisioned within. Changing this forces a new resource to be created.

property username

username: string;

The Username of the local administrator for the Zookeeper Nodes. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Zookeeper Nodes should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Zookeeper Nodes. Changing this forces a new resource to be created.

interface HadoopClusterStorageAccount

interface HadoopClusterStorageAccount

property isDefault

isDefault: boolean;

Is this the Default Storage Account for the HDInsight Hadoop Cluster? Changing this forces a new resource to be created.

property storageAccountKey

storageAccountKey: string;

The Access Key which should be used to connect to the Storage Account. Changing this forces a new resource to be created.

property storageContainerId

storageContainerId: string;

The ID of the Storage Container. Changing this forces a new resource to be created.

interface HadoopClusterStorageAccountGen2

interface HadoopClusterStorageAccountGen2

property filesystemId

filesystemId: string;

The ID of the Gen2 Filesystem. Changing this forces a new resource to be created.

property isDefault

isDefault: boolean;

Is this the Default Storage Account for the HDInsight Hadoop Cluster? Changing this forces a new resource to be created.

property managedIdentityResourceId

managedIdentityResourceId: string;

The ID of Managed Identity to use for accessing the Gen2 filesystem. Changing this forces a new resource to be created.

property storageResourceId

storageResourceId: string;

The ID of the Storage Account. Changing this forces a new resource to be created.

interface HBaseClusterComponentVersion

interface HBaseClusterComponentVersion

property hbase

hbase: string;

The version of HBase which should be used for this HDInsight HBase Cluster. Changing this forces a new resource to be created.

interface HBaseClusterGateway

interface HBaseClusterGateway

property enabled

enabled: boolean;

Is the Ambari portal enabled? Changing this forces a new resource to be created.

property password

password: string;

The password used for the Ambari Portal. Changing this forces a new resource to be created.

property username

username: string;

The username used for the Ambari Portal. Changing this forces a new resource to be created.

interface HBaseClusterRoles

interface HBaseClusterRoles

property headNode

headNode: HBaseClusterRolesHeadNode;

A headNode block as defined above.

property workerNode

workerNode: HBaseClusterRolesWorkerNode;

A workerNode block as defined below.

property zookeeperNode

zookeeperNode: HBaseClusterRolesZookeeperNode;

A zookeeperNode block as defined below.

interface HBaseClusterRolesHeadNode

interface HBaseClusterRolesHeadNode

property password

password?: undefined | string;

The Password associated with the local administrator for the Head Nodes. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Head Nodes. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Head Nodes should be provisioned within. Changing this forces a new resource to be created.

property username

username: string;

The Username of the local administrator for the Head Nodes. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Head Nodes should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Head Nodes. Changing this forces a new resource to be created.

interface HBaseClusterRolesWorkerNode

interface HBaseClusterRolesWorkerNode

property minInstanceCount

minInstanceCount?: undefined | number;

The minimum number of instances which should be run for the Worker Nodes. Changing this forces a new resource to be created.

property password

password?: undefined | string;

The Password associated with the local administrator for the Worker Nodes. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Worker Nodes. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Worker Nodes should be provisioned within. Changing this forces a new resource to be created.

property targetInstanceCount

targetInstanceCount: number;

The number of instances which should be run for the Worker Nodes.

property username

username: string;

The Username of the local administrator for the Worker Nodes. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Worker Nodes should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Worker Nodes. Changing this forces a new resource to be created.

interface HBaseClusterRolesZookeeperNode

interface HBaseClusterRolesZookeeperNode

property password

password?: undefined | string;

The Password associated with the local administrator for the Zookeeper Nodes. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Zookeeper Nodes. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Zookeeper Nodes should be provisioned within. Changing this forces a new resource to be created.

property username

username: string;

The Username of the local administrator for the Zookeeper Nodes. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Zookeeper Nodes should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Zookeeper Nodes. Changing this forces a new resource to be created.

interface HBaseClusterStorageAccount

interface HBaseClusterStorageAccount

property isDefault

isDefault: boolean;

Is this the Default Storage Account for the HDInsight Hadoop Cluster? Changing this forces a new resource to be created.

property storageAccountKey

storageAccountKey: string;

The Access Key which should be used to connect to the Storage Account. Changing this forces a new resource to be created.

property storageContainerId

storageContainerId: string;

The ID of the Storage Container. Changing this forces a new resource to be created.

interface HBaseClusterStorageAccountGen2

interface HBaseClusterStorageAccountGen2

property filesystemId

filesystemId: string;

The ID of the Gen2 Filesystem. Changing this forces a new resource to be created.

property isDefault

isDefault: boolean;

Is this the Default Storage Account for the HDInsight Hadoop Cluster? Changing this forces a new resource to be created.

property managedIdentityResourceId

managedIdentityResourceId: string;

The ID of Managed Identity to use for accessing the Gen2 filesystem. Changing this forces a new resource to be created.

property storageResourceId

storageResourceId: string;

The ID of the Storage Account. Changing this forces a new resource to be created.

interface InteractiveQueryClusterComponentVersion

interface InteractiveQueryClusterComponentVersion

property interactiveHive

interactiveHive: string;

interface InteractiveQueryClusterGateway

interface InteractiveQueryClusterGateway

property enabled

enabled: boolean;

Is the Ambari portal enabled? Changing this forces a new resource to be created.

property password

password: string;

The password used for the Ambari Portal. Changing this forces a new resource to be created.

property username

username: string;

The username used for the Ambari Portal. Changing this forces a new resource to be created.

interface InteractiveQueryClusterRoles

interface InteractiveQueryClusterRoles

property headNode

headNode: InteractiveQueryClusterRolesHeadNode;

A headNode block as defined above.

property workerNode

workerNode: InteractiveQueryClusterRolesWorkerNode;

A workerNode block as defined below.

property zookeeperNode

zookeeperNode: InteractiveQueryClusterRolesZookeeperNode;

A zookeeperNode block as defined below.

interface InteractiveQueryClusterRolesHeadNode

interface InteractiveQueryClusterRolesHeadNode

property password

password?: undefined | string;

The Password associated with the local administrator for the Head Nodes. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Head Nodes. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Head Nodes should be provisioned within. Changing this forces a new resource to be created.

property username

username: string;

The Username of the local administrator for the Head Nodes. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Head Nodes should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Head Nodes. Changing this forces a new resource to be created.

interface InteractiveQueryClusterRolesWorkerNode

interface InteractiveQueryClusterRolesWorkerNode

property minInstanceCount

minInstanceCount?: undefined | number;

The minimum number of instances which should be run for the Worker Nodes. Changing this forces a new resource to be created.

property password

password?: undefined | string;

The Password associated with the local administrator for the Worker Nodes. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Worker Nodes. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Worker Nodes should be provisioned within. Changing this forces a new resource to be created.

property targetInstanceCount

targetInstanceCount: number;

The number of instances which should be run for the Worker Nodes.

property username

username: string;

The Username of the local administrator for the Worker Nodes. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Worker Nodes should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Worker Nodes. Changing this forces a new resource to be created.

interface InteractiveQueryClusterRolesZookeeperNode

interface InteractiveQueryClusterRolesZookeeperNode

property password

password?: undefined | string;

The Password associated with the local administrator for the Zookeeper Nodes. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Zookeeper Nodes. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Zookeeper Nodes should be provisioned within. Changing this forces a new resource to be created.

property username

username: string;

The Username of the local administrator for the Zookeeper Nodes. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Zookeeper Nodes should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Zookeeper Nodes. Changing this forces a new resource to be created.

interface InteractiveQueryClusterStorageAccount

interface InteractiveQueryClusterStorageAccount

property isDefault

isDefault: boolean;

Is this the Default Storage Account for the HDInsight Hadoop Cluster? Changing this forces a new resource to be created.

property storageAccountKey

storageAccountKey: string;

The Access Key which should be used to connect to the Storage Account. Changing this forces a new resource to be created.

property storageContainerId

storageContainerId: string;

The ID of the Storage Container. Changing this forces a new resource to be created.

interface InteractiveQueryClusterStorageAccountGen2

interface InteractiveQueryClusterStorageAccountGen2

property filesystemId

filesystemId: string;

The ID of the Gen2 Filesystem. Changing this forces a new resource to be created.

property isDefault

isDefault: boolean;

Is this the Default Storage Account for the HDInsight Hadoop Cluster? Changing this forces a new resource to be created.

property managedIdentityResourceId

managedIdentityResourceId: string;

The ID of Managed Identity to use for accessing the Gen2 filesystem. Changing this forces a new resource to be created.

property storageResourceId

storageResourceId: string;

The ID of the Storage Account. Changing this forces a new resource to be created.

interface KafkaClusterComponentVersion

interface KafkaClusterComponentVersion

property kafka

kafka: string;

The version of Kafka which should be used for this HDInsight Kafka Cluster. Changing this forces a new resource to be created.

interface KafkaClusterGateway

interface KafkaClusterGateway

property enabled

enabled: boolean;

Is the Ambari portal enabled? Changing this forces a new resource to be created.

property password

password: string;

The password used for the Ambari Portal. Changing this forces a new resource to be created.

property username

username: string;

The username used for the Ambari Portal. Changing this forces a new resource to be created.

interface KafkaClusterRoles

interface KafkaClusterRoles

property headNode

headNode: KafkaClusterRolesHeadNode;

A headNode block as defined above.

property workerNode

workerNode: KafkaClusterRolesWorkerNode;

A workerNode block as defined below.

property zookeeperNode

zookeeperNode: KafkaClusterRolesZookeeperNode;

A zookeeperNode block as defined below.

interface KafkaClusterRolesHeadNode

interface KafkaClusterRolesHeadNode

property password

password?: undefined | string;

The Password associated with the local administrator for the Head Nodes. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Head Nodes. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Head Nodes should be provisioned within. Changing this forces a new resource to be created.

property username

username: string;

The Username of the local administrator for the Head Nodes. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Head Nodes should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Head Nodes. Changing this forces a new resource to be created.

interface KafkaClusterRolesWorkerNode

interface KafkaClusterRolesWorkerNode

property minInstanceCount

minInstanceCount?: undefined | number;

The minimum number of instances which should be run for the Worker Nodes. Changing this forces a new resource to be created.

property numberOfDisksPerNode

numberOfDisksPerNode: number;

The number of Data Disks which should be assigned to each Worker Node, which can be between 1 and 8. Changing this forces a new resource to be created.

property password

password?: undefined | string;

The Password associated with the local administrator for the Worker Nodes. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Worker Nodes. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Worker Nodes should be provisioned within. Changing this forces a new resource to be created.

property targetInstanceCount

targetInstanceCount: number;

The number of instances which should be run for the Worker Nodes.

property username

username: string;

The Username of the local administrator for the Worker Nodes. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Worker Nodes should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Worker Nodes. Changing this forces a new resource to be created.

interface KafkaClusterRolesZookeeperNode

interface KafkaClusterRolesZookeeperNode

property password

password?: undefined | string;

The Password associated with the local administrator for the Zookeeper Nodes. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Zookeeper Nodes. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Zookeeper Nodes should be provisioned within. Changing this forces a new resource to be created.

property username

username: string;

The Username of the local administrator for the Zookeeper Nodes. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Zookeeper Nodes should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Zookeeper Nodes. Changing this forces a new resource to be created.

interface KafkaClusterStorageAccount

interface KafkaClusterStorageAccount

property isDefault

isDefault: boolean;

Is this the Default Storage Account for the HDInsight Hadoop Cluster? Changing this forces a new resource to be created.

property storageAccountKey

storageAccountKey: string;

The Access Key which should be used to connect to the Storage Account. Changing this forces a new resource to be created.

property storageContainerId

storageContainerId: string;

The ID of the Storage Container. Changing this forces a new resource to be created.

interface KafkaClusterStorageAccountGen2

interface KafkaClusterStorageAccountGen2

property filesystemId

filesystemId: string;

The ID of the Gen2 Filesystem. Changing this forces a new resource to be created.

property isDefault

isDefault: boolean;

Is this the Default Storage Account for the HDInsight Hadoop Cluster? Changing this forces a new resource to be created.

property managedIdentityResourceId

managedIdentityResourceId: string;

The ID of Managed Identity to use for accessing the Gen2 filesystem. Changing this forces a new resource to be created.

property storageResourceId

storageResourceId: string;

The ID of the Storage Account. Changing this forces a new resource to be created.

interface MLServicesClusterGateway

interface MLServicesClusterGateway

property enabled

enabled: boolean;

Is the Ambari portal enabled? Changing this forces a new resource to be created.

property password

password: string;

The password used for the Ambari Portal. Changing this forces a new resource to be created.

property username

username: string;

The username used for the Ambari Portal. Changing this forces a new resource to be created.

interface MLServicesClusterRoles

interface MLServicesClusterRoles

property edgeNode

edgeNode: MLServicesClusterRolesEdgeNode;

A edgeNode block as defined above.

property headNode

headNode: MLServicesClusterRolesHeadNode;

A headNode block as defined above.

property workerNode

workerNode: MLServicesClusterRolesWorkerNode;

A workerNode block as defined below.

property zookeeperNode

zookeeperNode: MLServicesClusterRolesZookeeperNode;

A zookeeperNode block as defined below.

interface MLServicesClusterRolesEdgeNode

interface MLServicesClusterRolesEdgeNode

property password

password?: undefined | string;

The Password associated with the local administrator for the Edge Node. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Edge Node. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Edge Node should be provisioned within. Changing this forces a new resource to be created.

property username

username: string;

The Username of the local administrator for the Edge Node. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Edge Node should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Edge Node. Changing this forces a new resource to be created.

interface MLServicesClusterRolesHeadNode

interface MLServicesClusterRolesHeadNode

property password

password?: undefined | string;

The Password associated with the local administrator for the Head Nodes. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Head Nodes. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Head Nodes should be provisioned within. Changing this forces a new resource to be created.

property username

username: string;

The Username of the local administrator for the Head Nodes. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Head Nodes should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Head Nodes. Changing this forces a new resource to be created.

interface MLServicesClusterRolesWorkerNode

interface MLServicesClusterRolesWorkerNode

property minInstanceCount

minInstanceCount?: undefined | number;

The minimum number of instances which should be run for the Worker Nodes. Changing this forces a new resource to be created.

property password

password?: undefined | string;

The Password associated with the local administrator for the Worker Nodes. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Worker Nodes. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Worker Nodes should be provisioned within. Changing this forces a new resource to be created.

property targetInstanceCount

targetInstanceCount: number;

The number of instances which should be run for the Worker Nodes.

property username

username: string;

The Username of the local administrator for the Worker Nodes. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Worker Nodes should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Worker Nodes. Changing this forces a new resource to be created.

interface MLServicesClusterRolesZookeeperNode

interface MLServicesClusterRolesZookeeperNode

property password

password?: undefined | string;

The Password associated with the local administrator for the Zookeeper Nodes. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Zookeeper Nodes. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Zookeeper Nodes should be provisioned within. Changing this forces a new resource to be created.

property username

username: string;

The Username of the local administrator for the Zookeeper Nodes. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Zookeeper Nodes should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Zookeeper Nodes. Changing this forces a new resource to be created.

interface MLServicesClusterStorageAccount

interface MLServicesClusterStorageAccount

property isDefault

isDefault: boolean;

Is this the Default Storage Account for the HDInsight ML Services Cluster? Changing this forces a new resource to be created.

property storageAccountKey

storageAccountKey: string;

The Access Key which should be used to connect to the Storage Account. Changing this forces a new resource to be created.

property storageContainerId

storageContainerId: string;

The ID of the Storage Container. Changing this forces a new resource to be created.

interface RServerClusterGateway

interface RServerClusterGateway

property enabled

enabled: boolean;

Is the Ambari portal enabled? Changing this forces a new resource to be created.

property password

password: string;

The password used for the Ambari Portal. Changing this forces a new resource to be created.

property username

username: string;

The username used for the Ambari Portal. Changing this forces a new resource to be created.

interface RServerClusterRoles

interface RServerClusterRoles

property edgeNode

edgeNode: RServerClusterRolesEdgeNode;

A edgeNode block as defined above.

property headNode

headNode: RServerClusterRolesHeadNode;

A headNode block as defined above.

property workerNode

workerNode: RServerClusterRolesWorkerNode;

A workerNode block as defined below.

property zookeeperNode

zookeeperNode: RServerClusterRolesZookeeperNode;

A zookeeperNode block as defined below.

interface RServerClusterRolesEdgeNode

interface RServerClusterRolesEdgeNode

property password

password?: undefined | string;

The Password associated with the local administrator for the Edge Node. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Edge Node. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Edge Node should be provisioned within. Changing this forces a new resource to be created.

property username

username: string;

The Username of the local administrator for the Edge Node. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Edge Node should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Edge Node. Changing this forces a new resource to be created.

interface RServerClusterRolesHeadNode

interface RServerClusterRolesHeadNode

property password

password?: undefined | string;

The Password associated with the local administrator for the Head Nodes. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Head Nodes. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Head Nodes should be provisioned within. Changing this forces a new resource to be created.

property username

username: string;

The Username of the local administrator for the Head Nodes. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Head Nodes should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Head Nodes. Changing this forces a new resource to be created.

interface RServerClusterRolesWorkerNode

interface RServerClusterRolesWorkerNode

property minInstanceCount

minInstanceCount?: undefined | number;

The minimum number of instances which should be run for the Worker Nodes. Changing this forces a new resource to be created.

property password

password?: undefined | string;

The Password associated with the local administrator for the Worker Nodes. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Worker Nodes. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Worker Nodes should be provisioned within. Changing this forces a new resource to be created.

property targetInstanceCount

targetInstanceCount: number;

The number of instances which should be run for the Worker Nodes.

property username

username: string;

The Username of the local administrator for the Worker Nodes. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Worker Nodes should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Worker Nodes. Changing this forces a new resource to be created.

interface RServerClusterRolesZookeeperNode

interface RServerClusterRolesZookeeperNode

property password

password?: undefined | string;

The Password associated with the local administrator for the Zookeeper Nodes. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Zookeeper Nodes. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Zookeeper Nodes should be provisioned within. Changing this forces a new resource to be created.

property username

username: string;

The Username of the local administrator for the Zookeeper Nodes. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Zookeeper Nodes should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Zookeeper Nodes. Changing this forces a new resource to be created.

interface RServerClusterStorageAccount

interface RServerClusterStorageAccount

property isDefault

isDefault: boolean;

Is this the Default Storage Account for the HDInsight RServer Cluster? Changing this forces a new resource to be created.

property storageAccountKey

storageAccountKey: string;

The Access Key which should be used to connect to the Storage Account. Changing this forces a new resource to be created.

property storageContainerId

storageContainerId: string;

The ID of the Storage Container. Changing this forces a new resource to be created.

interface SparkClusterComponentVersion

interface SparkClusterComponentVersion

property spark

spark: string;

The version of Spark which should be used for this HDInsight Spark Cluster. Changing this forces a new resource to be created.

interface SparkClusterGateway

interface SparkClusterGateway

property enabled

enabled: boolean;

Is the Ambari portal enabled? Changing this forces a new resource to be created.

property password

password: string;

The password used for the Ambari Portal. Changing this forces a new resource to be created.

property username

username: string;

The username used for the Ambari Portal. Changing this forces a new resource to be created.

interface SparkClusterRoles

interface SparkClusterRoles

property headNode

headNode: SparkClusterRolesHeadNode;

A headNode block as defined above.

property workerNode

workerNode: SparkClusterRolesWorkerNode;

A workerNode block as defined below.

property zookeeperNode

zookeeperNode: SparkClusterRolesZookeeperNode;

A zookeeperNode block as defined below.

interface SparkClusterRolesHeadNode

interface SparkClusterRolesHeadNode

property password

password?: undefined | string;

The Password associated with the local administrator for the Head Nodes. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Head Nodes. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Head Nodes should be provisioned within. Changing this forces a new resource to be created.

property username

username: string;

The Username of the local administrator for the Head Nodes. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Head Nodes should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Head Nodes. Changing this forces a new resource to be created.

interface SparkClusterRolesWorkerNode

interface SparkClusterRolesWorkerNode

property minInstanceCount

minInstanceCount?: undefined | number;

The minimum number of instances which should be run for the Worker Nodes. Changing this forces a new resource to be created.

property password

password?: undefined | string;

The Password associated with the local administrator for the Worker Nodes. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Worker Nodes. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Worker Nodes should be provisioned within. Changing this forces a new resource to be created.

property targetInstanceCount

targetInstanceCount: number;

The number of instances which should be run for the Worker Nodes.

property username

username: string;

The Username of the local administrator for the Worker Nodes. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Worker Nodes should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Worker Nodes. Changing this forces a new resource to be created.

interface SparkClusterRolesZookeeperNode

interface SparkClusterRolesZookeeperNode

property password

password?: undefined | string;

The Password associated with the local administrator for the Zookeeper Nodes. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Zookeeper Nodes. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Zookeeper Nodes should be provisioned within. Changing this forces a new resource to be created.

property username

username: string;

The Username of the local administrator for the Zookeeper Nodes. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Zookeeper Nodes should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Zookeeper Nodes. Changing this forces a new resource to be created.

interface SparkClusterStorageAccount

interface SparkClusterStorageAccount

property isDefault

isDefault: boolean;

Is this the Default Storage Account for the HDInsight Hadoop Cluster? Changing this forces a new resource to be created.

property storageAccountKey

storageAccountKey: string;

The Access Key which should be used to connect to the Storage Account. Changing this forces a new resource to be created.

property storageContainerId

storageContainerId: string;

The ID of the Storage Container. Changing this forces a new resource to be created.

interface SparkClusterStorageAccountGen2

interface SparkClusterStorageAccountGen2

property filesystemId

filesystemId: string;

The ID of the Gen2 Filesystem. Changing this forces a new resource to be created.

property isDefault

isDefault: boolean;

Is this the Default Storage Account for the HDInsight Hadoop Cluster? Changing this forces a new resource to be created.

property managedIdentityResourceId

managedIdentityResourceId: string;

The ID of Managed Identity to use for accessing the Gen2 filesystem. Changing this forces a new resource to be created.

property storageResourceId

storageResourceId: string;

The ID of the Storage Account. Changing this forces a new resource to be created.

interface StormClusterComponentVersion

interface StormClusterComponentVersion

property storm

storm: string;

The version of Storm which should be used for this HDInsight Storm Cluster. Changing this forces a new resource to be created.

interface StormClusterGateway

interface StormClusterGateway

property enabled

enabled: boolean;

Is the Ambari portal enabled? Changing this forces a new resource to be created.

property password

password: string;

The password used for the Ambari Portal. Changing this forces a new resource to be created.

property username

username: string;

The username used for the Ambari Portal. Changing this forces a new resource to be created.

interface StormClusterRoles

interface StormClusterRoles

property headNode

headNode: StormClusterRolesHeadNode;

A headNode block as defined above.

property workerNode

workerNode: StormClusterRolesWorkerNode;

A workerNode block as defined below.

property zookeeperNode

zookeeperNode: StormClusterRolesZookeeperNode;

A zookeeperNode block as defined below.

interface StormClusterRolesHeadNode

interface StormClusterRolesHeadNode

property password

password?: undefined | string;

The Password associated with the local administrator for the Head Nodes. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Head Nodes. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Head Nodes should be provisioned within. Changing this forces a new resource to be created.

property username

username: string;

The Username of the local administrator for the Head Nodes. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Head Nodes should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Head Nodes. Changing this forces a new resource to be created.

interface StormClusterRolesWorkerNode

interface StormClusterRolesWorkerNode

property minInstanceCount

minInstanceCount?: undefined | number;

The minimum number of instances which should be run for the Worker Nodes. Changing this forces a new resource to be created.

property password

password?: undefined | string;

The Password associated with the local administrator for the Worker Nodes. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Worker Nodes. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Worker Nodes should be provisioned within. Changing this forces a new resource to be created.

property targetInstanceCount

targetInstanceCount: number;

The number of instances which should be run for the Worker Nodes.

property username

username: string;

The Username of the local administrator for the Worker Nodes. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Worker Nodes should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Worker Nodes. Changing this forces a new resource to be created.

interface StormClusterRolesZookeeperNode

interface StormClusterRolesZookeeperNode

property password

password?: undefined | string;

The Password associated with the local administrator for the Zookeeper Nodes. Changing this forces a new resource to be created.

property sshKeys

sshKeys?: string[];

A list of SSH Keys which should be used for the local administrator on the Zookeeper Nodes. Changing this forces a new resource to be created.

property subnetId

subnetId?: undefined | string;

The ID of the Subnet within the Virtual Network where the Zookeeper Nodes should be provisioned within. Changing this forces a new resource to be created.

property username

username: string;

The Username of the local administrator for the Zookeeper Nodes. Changing this forces a new resource to be created.

property virtualNetworkId

virtualNetworkId?: undefined | string;

The ID of the Virtual Network where the Zookeeper Nodes should be provisioned within. Changing this forces a new resource to be created.

property vmSize

vmSize: string;

The Size of the Virtual Machine which should be used as the Zookeeper Nodes. Changing this forces a new resource to be created.

interface StormClusterStorageAccount

interface StormClusterStorageAccount

property isDefault

isDefault: boolean;

Is this the Default Storage Account for the HDInsight Storm Cluster? Changing this forces a new resource to be created.

property storageAccountKey

storageAccountKey: string;

The Access Key which should be used to connect to the Storage Account. Changing this forces a new resource to be created.

property storageContainerId

storageContainerId: string;

The ID of the Storage Container. Changing this forces a new resource to be created.

namespace healthcare

interface GetServiceAuthenticationConfiguration

interface GetServiceAuthenticationConfiguration

property audience

audience: string;

The intended audience to receive authentication tokens for the service.

property authority

authority: string;

The Azure Active Directory (tenant) that serves as the authentication authority to access the service.

property smartProxyEnabled

smartProxyEnabled: boolean;

Is the ‘SMART on FHIR’ option for mobile and web implementations enbled?

interface GetServiceCorsConfiguration

interface GetServiceCorsConfiguration

property allowCredentials

allowCredentials: boolean;

Are credentials are allowed via CORS?

property allowedHeaders

allowedHeaders: string[];

The set of headers to be allowed via CORS.

property allowedMethods

allowedMethods: string[];

The methods to be allowed via CORS.

property allowedOrigins

allowedOrigins: string[];

The set of origins to be allowed via CORS.

property maxAgeInSeconds

maxAgeInSeconds: number;

The max age to be allowed via CORS.

interface ServiceAuthenticationConfiguration

interface ServiceAuthenticationConfiguration

property audience

audience?: undefined | string;

The intended audience to receive authentication tokens for the service. The default value is https://azurehealthcareapis.com

property authority

authority?: undefined | string;

The Azure Active Directory (tenant) that serves as the authentication authority to access the service. The default authority is the Directory defined in the authentication scheme in use when running this provider. Authority must be registered to Azure AD and in the following format: https://{Azure-AD-endpoint}/{tenant-id}.

property smartProxyEnabled

smartProxyEnabled?: undefined | false | true;

Enables the ‘SMART on FHIR’ option for mobile and web implementations.

interface ServiceCorsConfiguration

interface ServiceCorsConfiguration

property allowCredentials

allowCredentials?: undefined | false | true;

If credentials are allowed via CORS.

property allowedHeaders

allowedHeaders?: string[];

A set of headers to be allowed via CORS.

property allowedMethods

allowedMethods?: string[];

The methods to be allowed via CORS.

property allowedOrigins

allowedOrigins?: string[];

A set of origins to be allowed via CORS.

property maxAgeInSeconds

maxAgeInSeconds?: undefined | number;

The max age to be allowed via CORS.

namespace hpc

interface CacheNfsTargetNamespaceJunction

interface CacheNfsTargetNamespaceJunction

property namespacePath

namespacePath: string;

The client-facing file path of this NFS target within the HPC Cache NFS Target.

property nfsExport

nfsExport: string;

The NFS export of this NFS target within the HPC Cache NFS Target.

property targetPath

targetPath?: undefined | string;

The relative subdirectory path from the nfsExport to map to the namespacePath. Defaults to "", in which case the whole nfsExport is exported.

namespace iot

interface IotHubDpsLinkedHub

interface IotHubDpsLinkedHub

property allocationWeight

allocationWeight?: undefined | number;

The weight applied to the IoT Hub. Defaults to 0.

property applyAllocationPolicy

applyAllocationPolicy?: undefined | false | true;

Determines whether to apply allocation policies to the IoT Hub. Defaults to false.

property connectionString

connectionString: string;

The connection string to connect to the IoT Hub. Changing this forces a new resource.

property hostname

hostname: string;

The IoT Hub hostname.

property location

location: string;

The location of the IoT hub. Changing this forces a new resource.

interface IotHubDpsSku

interface IotHubDpsSku

property capacity

capacity: number;

The number of provisioned IoT Device Provisioning Service units.

property name

name: string;

The name of the sku. Possible values are B1, B2, B3, F1, S1, S2, and S3.

interface IoTHubEndpoint

interface IoTHubEndpoint

property batchFrequencyInSeconds

batchFrequencyInSeconds?: undefined | number;

Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.

property connectionString

connectionString: string;

The connection string for the endpoint.

property containerName

containerName?: undefined | string;

The name of storage container in the storage account. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.

property encoding

encoding?: undefined | string;

Encoding that is used to serialize messages to blobs. Supported values are ‘avro’ and ‘avrodeflate’. Default value is ‘avro’. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.

property fileNameFormat

fileNameFormat?: undefined | string;

File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered. This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.

property maxChunkSizeInBytes

maxChunkSizeInBytes?: undefined | number;

Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB). This attribute is mandatory for endpoint type AzureIotHub.StorageContainer.

property name

name: string;

The name of the endpoint. The name must be unique across endpoint types. The following names are reserved: events, operationsMonitoringEvents, fileNotifications and $default.

property type

type: string;

The type of the endpoint. Possible values are AzureIotHub.StorageContainer, AzureIotHub.ServiceBusQueue, AzureIotHub.ServiceBusTopic or AzureIotHub.EventHub.

interface IoTHubFallbackRoute

interface IoTHubFallbackRoute

property condition

condition?: undefined | string;

The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.

property enabled

enabled: boolean;

Used to specify whether the fallback route is enabled.

property endpointNames

endpointNames: string[];

The endpoints to which messages that satisfy the condition are routed. Currently only 1 endpoint is allowed.

property source

source?: undefined | string;

The source that the routing rule is to be applied to, such as DeviceMessages. Possible values include: RoutingSourceInvalid, RoutingSourceDeviceMessages, RoutingSourceTwinChangeEvents, RoutingSourceDeviceLifecycleEvents, RoutingSourceDeviceJobLifecycleEvents.

interface IoTHubFileUpload

interface IoTHubFileUpload

property connectionString

connectionString: string;

The connection string for the Azure Storage account to which files are uploaded.

property containerName

containerName: string;

The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.

property defaultTtl

defaultTtl: string;

The period of time for which a file upload notification message is available to consume before it is expired by the IoT hub, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 48 hours, and evaluates to ‘PT1H’ by default.

property lockDuration

lockDuration: string;

The lock duration for the file upload notifications queue, specified as an ISO 8601 timespan duration. This value must be between 5 and 300 seconds, and evaluates to ‘PT1M’ by default.

property maxDeliveryCount

maxDeliveryCount?: undefined | number;

The number of times the IoT hub attempts to deliver a file upload notification message. It evaluates to 10 by default.

property notifications

notifications?: undefined | false | true;

Used to specify whether file notifications are sent to IoT Hub on upload. It evaluates to false by default.

property sasTtl

sasTtl: string;

The period of time for which the SAS URI generated by IoT Hub for file upload is valid, specified as an ISO 8601 timespan duration. This value must be between 1 minute and 24 hours, and evaluates to ‘PT1H’ by default.

interface IoTHubIpFilterRule

interface IoTHubIpFilterRule

property action

action: string;

The desired action for requests captured by this rule. Possible values are Accept, Reject

property ipMask

ipMask: string;

The IP address range in CIDR notation for the rule.

property name

name: string;

The name of the filter.

interface IoTHubRoute

interface IoTHubRoute

property condition

condition?: undefined | string;

The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language.

property enabled

enabled: boolean;

Used to specify whether a route is enabled.

property endpointNames

endpointNames: string[];

The list of endpoints to which messages that satisfy the condition are routed.

property name

name: string;

The name of the route.

property source

source: string;

The source that the routing rule is to be applied to, such as DeviceMessages. Possible values include: RoutingSourceInvalid, RoutingSourceDeviceMessages, RoutingSourceTwinChangeEvents, RoutingSourceDeviceLifecycleEvents, RoutingSourceDeviceJobLifecycleEvents.

interface IoTHubSharedAccessPolicy

interface IoTHubSharedAccessPolicy

property keyName

keyName: string;

The name of the shared access policy.

property permissions

permissions: string;

The permissions assigned to the shared access policy.

property primaryKey

primaryKey: string;

The primary key.

property secondaryKey

secondaryKey: string;

The secondary key.

interface IoTHubSku

interface IoTHubSku

property capacity

capacity: number;

The number of provisioned IoT Hub units.

property name

name: string;

The name of the sku. Possible values are B1, B2, B3, F1, S1, S2, and S3.

interface TimeSeriesInsightsReferenceDataSetKeyProperty

interface TimeSeriesInsightsReferenceDataSetKeyProperty

property name

name: string;

The name of the key property.

property type

type: string;

The data type of the key property. Valid values include Bool, DateTime, Double, String.

namespace keyvault

interface CertifiateCertificate

interface CertifiateCertificate

property contents

contents: string;

The base64-encoded certificate contents. Changing this forces a new resource to be created.

property password

password?: undefined | string;

The password associated with the certificate. Changing this forces a new resource to be created.

interface CertifiateCertificatePolicy

interface CertifiateCertificatePolicy

property issuerParameters

issuerParameters: CertifiateCertificatePolicyIssuerParameters;

A issuerParameters block as defined below.

property keyProperties

keyProperties: CertifiateCertificatePolicyKeyProperties;

A keyProperties block as defined below.

property lifetimeActions

lifetimeActions?: CertifiateCertificatePolicyLifetimeAction[];

A lifetimeAction block as defined below.

property secretProperties

secretProperties: CertifiateCertificatePolicySecretProperties;

A secretProperties block as defined below.

property x509CertificateProperties

x509CertificateProperties: CertifiateCertificatePolicyX509CertificateProperties;

A x509CertificateProperties block as defined below. Required when certificate block is not specified.

interface CertifiateCertificatePolicyIssuerParameters

interface CertifiateCertificatePolicyIssuerParameters

property name

name: string;

The name of the Certificate Issuer. Possible values include Self (for self-signed certificate), or Unknown (for a certificate issuing authority like Let's Encrypt and Azure direct supported ones). Changing this forces a new resource to be created.

interface CertifiateCertificatePolicyKeyProperties

interface CertifiateCertificatePolicyKeyProperties

property exportable

exportable: boolean;

Is this Certificate Exportable? Changing this forces a new resource to be created.

property keySize

keySize: number;

The size of the Key used in the Certificate. Possible values include 2048 and 4096. Changing this forces a new resource to be created.

property keyType

keyType: string;

Specifies the Type of Key, such as RSA. Changing this forces a new resource to be created.

property reuseKey

reuseKey: boolean;

Is the key reusable? Changing this forces a new resource to be created.

interface CertifiateCertificatePolicyLifetimeAction

interface CertifiateCertificatePolicyLifetimeAction

property action

action: CertifiateCertificatePolicyLifetimeActionAction;

A action block as defined below.

property trigger

trigger: CertifiateCertificatePolicyLifetimeActionTrigger;

A trigger block as defined below.

interface CertifiateCertificatePolicyLifetimeActionAction

interface CertifiateCertificatePolicyLifetimeActionAction

property actionType

actionType: string;

The Type of action to be performed when the lifetime trigger is triggerec. Possible values include AutoRenew and EmailContacts. Changing this forces a new resource to be created.

interface CertifiateCertificatePolicyLifetimeActionTrigger

interface CertifiateCertificatePolicyLifetimeActionTrigger

property daysBeforeExpiry

daysBeforeExpiry?: undefined | number;

The number of days before the Certificate expires that the action associated with this Trigger should run. Changing this forces a new resource to be created. Conflicts with lifetimePercentage.

property lifetimePercentage

lifetimePercentage?: undefined | number;

The percentage at which during the Certificates Lifetime the action associated with this Trigger should run. Changing this forces a new resource to be created. Conflicts with daysBeforeExpiry.

interface CertifiateCertificatePolicySecretProperties

interface CertifiateCertificatePolicySecretProperties

property contentType

contentType: string;

The Content-Type of the Certificate, such as application/x-pkcs12 for a PFX or application/x-pem-file for a PEM. Changing this forces a new resource to be created.

interface CertifiateCertificatePolicyX509CertificateProperties

interface CertifiateCertificatePolicyX509CertificateProperties

property extendedKeyUsages

extendedKeyUsages: string[];

A list of Extended/Enhanced Key Usages. Changing this forces a new resource to be created.

property keyUsages

keyUsages: string[];

A list of uses associated with this Key. Possible values include cRLSign, dataEncipherment, decipherOnly, digitalSignature, encipherOnly, keyAgreement, keyCertSign, keyEncipherment and nonRepudiation and are case-sensitive. Changing this forces a new resource to be created.

property subject

subject: string;

The Certificate’s Subject. Changing this forces a new resource to be created.

property subjectAlternativeNames

subjectAlternativeNames: CertifiateCertificatePolicyX509CertificatePropertiesSubjectAlternativeNames;

A subjectAlternativeNames block as defined below.

property validityInMonths

validityInMonths: number;

The Certificates Validity Period in Months. Changing this forces a new resource to be created.

interface CertifiateCertificatePolicyX509CertificatePropertiesSubjectAlternativeNames

interface CertifiateCertificatePolicyX509CertificatePropertiesSubjectAlternativeNames

property dnsNames

dnsNames?: string[];

A list of alternative DNS names (FQDNs) identified by the Certificate. Changing this forces a new resource to be created.

property emails

emails?: string[];

A list of email addresses identified by this Certificate. Changing this forces a new resource to be created.

property upns

upns?: string[];

A list of User Principal Names identified by the Certificate. Changing this forces a new resource to be created.

interface CertificateCertificate

interface CertificateCertificate

property contents

contents: string;

The base64-encoded certificate contents. Changing this forces a new resource to be created.

property password

password?: undefined | string;

The password associated with the certificate. Changing this forces a new resource to be created.

interface CertificateCertificatePolicy

interface CertificateCertificatePolicy

property issuerParameters

issuerParameters: CertificateCertificatePolicyIssuerParameters;

A issuerParameters block as defined below.

property keyProperties

keyProperties: CertificateCertificatePolicyKeyProperties;

A keyProperties block as defined below.

property lifetimeActions

lifetimeActions?: CertificateCertificatePolicyLifetimeAction[];

A lifetimeAction block as defined below.

property secretProperties

secretProperties: CertificateCertificatePolicySecretProperties;

A secretProperties block as defined below.

property x509CertificateProperties

x509CertificateProperties: CertificateCertificatePolicyX509CertificateProperties;

A x509CertificateProperties block as defined below. Required when certificate block is not specified.

interface CertificateCertificatePolicyIssuerParameters

interface CertificateCertificatePolicyIssuerParameters

property name

name: string;

The name of the Certificate Issuer. Possible values include Self (for self-signed certificate), or Unknown (for a certificate issuing authority like Let's Encrypt and Azure direct supported ones). Changing this forces a new resource to be created.

interface CertificateCertificatePolicyKeyProperties

interface CertificateCertificatePolicyKeyProperties

property exportable

exportable: boolean;

Is this Certificate Exportable? Changing this forces a new resource to be created.

property keySize

keySize: number;

The size of the Key used in the Certificate. Possible values include 2048 and 4096. Changing this forces a new resource to be created.

property keyType

keyType: string;

Specifies the Type of Key, such as RSA. Changing this forces a new resource to be created.

property reuseKey

reuseKey: boolean;

Is the key reusable? Changing this forces a new resource to be created.

interface CertificateCertificatePolicyLifetimeAction

interface CertificateCertificatePolicyLifetimeAction

property action

action: CertificateCertificatePolicyLifetimeActionAction;

A action block as defined below.

property trigger

trigger: CertificateCertificatePolicyLifetimeActionTrigger;

A trigger block as defined below.

interface CertificateCertificatePolicyLifetimeActionAction

interface CertificateCertificatePolicyLifetimeActionAction

property actionType

actionType: string;

The Type of action to be performed when the lifetime trigger is triggerec. Possible values include AutoRenew and EmailContacts. Changing this forces a new resource to be created.

interface CertificateCertificatePolicyLifetimeActionTrigger

interface CertificateCertificatePolicyLifetimeActionTrigger

property daysBeforeExpiry

daysBeforeExpiry?: undefined | number;

The number of days before the Certificate expires that the action associated with this Trigger should run. Changing this forces a new resource to be created. Conflicts with lifetimePercentage.

property lifetimePercentage

lifetimePercentage?: undefined | number;

The percentage at which during the Certificates Lifetime the action associated with this Trigger should run. Changing this forces a new resource to be created. Conflicts with daysBeforeExpiry.

interface CertificateCertificatePolicySecretProperties

interface CertificateCertificatePolicySecretProperties

property contentType

contentType: string;

The Content-Type of the Certificate, such as application/x-pkcs12 for a PFX or application/x-pem-file for a PEM. Changing this forces a new resource to be created.

interface CertificateCertificatePolicyX509CertificateProperties

interface CertificateCertificatePolicyX509CertificateProperties

property extendedKeyUsages

extendedKeyUsages: string[];

A list of Extended/Enhanced Key Usages. Changing this forces a new resource to be created.

property keyUsages

keyUsages: string[];

A list of uses associated with this Key. Possible values include cRLSign, dataEncipherment, decipherOnly, digitalSignature, encipherOnly, keyAgreement, keyCertSign, keyEncipherment and nonRepudiation and are case-sensitive. Changing this forces a new resource to be created.

property subject

subject: string;

The Certificate’s Subject. Changing this forces a new resource to be created.

property subjectAlternativeNames

subjectAlternativeNames: CertificateCertificatePolicyX509CertificatePropertiesSubjectAlternativeNames;

A subjectAlternativeNames block as defined below.

property validityInMonths

validityInMonths: number;

The Certificates Validity Period in Months. Changing this forces a new resource to be created.

interface CertificateCertificatePolicyX509CertificatePropertiesSubjectAlternativeNames

interface CertificateCertificatePolicyX509CertificatePropertiesSubjectAlternativeNames

property dnsNames

dnsNames?: string[];

A list of alternative DNS names (FQDNs) identified by the Certificate. Changing this forces a new resource to be created.

property emails

emails?: string[];

A list of email addresses identified by this Certificate. Changing this forces a new resource to be created.

property upns

upns?: string[];

A list of User Principal Names identified by the Certificate. Changing this forces a new resource to be created.

interface GetCertificateCertificatePolicy

interface GetCertificateCertificatePolicy

property issuerParameters

issuerParameters: GetCertificateCertificatePolicyIssuerParameter[];

A issuerParameters block as defined below.

property keyProperties

keyProperties: GetCertificateCertificatePolicyKeyProperty[];

A keyProperties block as defined below.

property lifetimeActions

lifetimeActions?: GetCertificateCertificatePolicyLifetimeAction[];

A lifetimeAction block as defined below.

property secretProperties

secretProperties: GetCertificateCertificatePolicySecretProperty[];

A secretProperties block as defined below.

property x509CertificateProperties

x509CertificateProperties: GetCertificateCertificatePolicyX509CertificateProperty[];

An x509CertificateProperties block as defined below.

interface GetCertificateCertificatePolicyIssuerParameter

interface GetCertificateCertificatePolicyIssuerParameter

property name

name: string;

Specifies the name of the Key Vault Secret.

interface GetCertificateCertificatePolicyKeyProperty

interface GetCertificateCertificatePolicyKeyProperty

property exportable

exportable: boolean;

Is this Certificate Exportable?

property keySize

keySize: number;

The size of the Key used in the Certificate.

property keyType

keyType: string;

Specifies the Type of Key, for example RSA.

property reuseKey

reuseKey: boolean;

Is the key reusable?

interface GetCertificateCertificatePolicyLifetimeAction

interface GetCertificateCertificatePolicyLifetimeAction

property actions

actions: GetCertificateCertificatePolicyLifetimeActionAction[];

A action block as defined below.

property triggers

triggers: GetCertificateCertificatePolicyLifetimeActionTrigger[];

A trigger block as defined below.

interface GetCertificateCertificatePolicyLifetimeActionAction

interface GetCertificateCertificatePolicyLifetimeActionAction

property actionType

actionType: string;

The Type of action to be performed when the lifetime trigger is triggerec.

interface GetCertificateCertificatePolicyLifetimeActionTrigger

interface GetCertificateCertificatePolicyLifetimeActionTrigger

property daysBeforeExpiry

daysBeforeExpiry: number;

The number of days before the Certificate expires that the action associated with this Trigger should run.

property lifetimePercentage

lifetimePercentage: number;

The percentage at which during the Certificates Lifetime the action associated with this Trigger should run.

interface GetCertificateCertificatePolicySecretProperty

interface GetCertificateCertificatePolicySecretProperty

property contentType

contentType: string;

The Content-Type of the Certificate, for example application/x-pkcs12 for a PFX or application/x-pem-file for a PEM.

interface GetCertificateCertificatePolicyX509CertificateProperty

interface GetCertificateCertificatePolicyX509CertificateProperty

property extendedKeyUsages

extendedKeyUsages: string[];

A list of Extended/Enhanced Key Usages.

property keyUsages

keyUsages: string[];

A list of uses associated with this Key.

property subject

subject: string;

The Certificate’s Subject.

property subjectAlternativeNames

subjectAlternativeNames: GetCertificateCertificatePolicyX509CertificatePropertySubjectAlternativeName[];

A subjectAlternativeNames block as defined below.

property validityInMonths

validityInMonths: number;

The Certificates Validity Period in Months.

interface GetCertificateCertificatePolicyX509CertificatePropertySubjectAlternativeName

interface GetCertificateCertificatePolicyX509CertificatePropertySubjectAlternativeName

property dnsNames

dnsNames: string[];

A list of alternative DNS names (FQDNs) identified by the Certificate.

property emails

emails: string[];

A list of email addresses identified by this Certificate.

property upns

upns: string[];

A list of User Principal Names identified by the Certificate.

interface GetKeyVaultAccessPolicy

interface GetKeyVaultAccessPolicy

property applicationId

applicationId: string;

The Object ID of a Azure Active Directory Application.

property certificatePermissions

certificatePermissions: string[];

A list of certificate permissions applicable to this Access Policy.

property keyPermissions

keyPermissions: string[];

A list of key permissions applicable to this Access Policy.

property objectId

objectId: string;

An Object ID of a User, Service Principal or Security Group.

property secretPermissions

secretPermissions: string[];

A list of secret permissions applicable to this Access Policy.

property storagePermissions

storagePermissions: string[];

A list of storage permissions applicable to this Access Policy.

property tenantId

tenantId: string;

The Azure Active Directory Tenant ID used to authenticate requests for this Key Vault.

interface GetKeyVaultNetworkAcl

interface GetKeyVaultNetworkAcl

property bypass

bypass: string;

property defaultAction

defaultAction: string;

property ipRules

ipRules: string[];

property virtualNetworkSubnetIds

virtualNetworkSubnetIds: string[];

interface KeyVaultAccessPolicy

interface KeyVaultAccessPolicy

property applicationId

applicationId?: undefined | string;

The object ID of an Application in Azure Active Directory.

property certificatePermissions

certificatePermissions?: string[];

List of certificate permissions, must be one or more from the following: backup, create, delete, deleteissuers, get, getissuers, import, list, listissuers, managecontacts, manageissuers, purge, recover, restore, setissuers and update.

property keyPermissions

keyPermissions?: string[];

List of key permissions, must be one or more from the following: backup, create, decrypt, delete, encrypt, get, import, list, purge, recover, restore, sign, unwrapKey, update, verify and wrapKey.

property objectId

objectId: string;

The object ID of a user, service principal or security group in the Azure Active Directory tenant for the vault. The object ID must be unique for the list of access policies.

property secretPermissions

secretPermissions?: string[];

List of secret permissions, must be one or more from the following: backup, delete, get, list, purge, recover, restore and set.

property storagePermissions

storagePermissions?: string[];

List of storage permissions, must be one or more from the following: backup, delete, deletesas, get, getsas, list, listsas, purge, recover, regeneratekey, restore, set, setsas and update.

property tenantId

tenantId: string;

The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault. Must match the tenantId used above.

interface KeyVaultNetworkAcls

interface KeyVaultNetworkAcls

property bypass

bypass: string;

Specifies which traffic can bypass the network rules. Possible values are AzureServices and None.

property defaultAction

defaultAction: string;

The Default Action to use when no rules match from ipRules / virtualNetworkSubnetIds. Possible values are Allow and Deny.

property ipRules

ipRules?: string[];

One or more IP Addresses, or CIDR Blocks which should be able to access the Key Vault.

property virtualNetworkSubnetIds

virtualNetworkSubnetIds?: string[];

One or more Subnet ID’s which should be able to access this Key Vault.

namespace kusto

interface ClusterSku

interface ClusterSku

property capacity

capacity: number;

Specifies the node count for the cluster. Boundaries depend on the sku name.

property name

name: string;

The name of the SKU. Valid values are: Dev(No SLA)_Standard_D11_v2, Standard_D11_v2, Standard_D12_v2, Standard_D13_v2, Standard_D14_v2, Standard_DS13_v2+1TB_PS, Standard_DS13_v2+2TB_PS, Standard_DS14_v2+3TB_PS, Standard_DS14_v2+4TB_PS, Standard_L16s, Standard_L4s and Standard_L8s

namespace lb

interface GetBackendAddressPoolBackendIpConfiguration

interface GetBackendAddressPoolBackendIpConfiguration

property id

id: string;

The ID of the Backend Address Pool.

interface GetLBFrontendIpConfiguration

interface GetLBFrontendIpConfiguration

property id

id: string;

The id of the Frontend IP Configuration.

property name

name: string;

Specifies the name of the Load Balancer.

property privateIpAddress

privateIpAddress: string;

Private IP Address to assign to the Load Balancer.

property privateIpAddressAllocation

privateIpAddressAllocation: string;

The allocation method for the Private IP Address used by this Load Balancer.

property privateIpAddressVersion

privateIpAddressVersion: string;

The Private IP Address Version, either IPv4 or IPv6.

property publicIpAddressId

publicIpAddressId: string;

The ID of a Public IP Address which is associated with this Load Balancer.

property subnetId

subnetId: string;

The ID of the Subnet which is associated with the IP Configuration.

property zones

zones: string[];

A list of Availability Zones which the Load Balancer’s IP Addresses should be created in.

interface LoadBalancerFrontendIpConfiguration

interface LoadBalancerFrontendIpConfiguration

property id

id: string;

The id of the Frontend IP Configuration.

property inboundNatRules

inboundNatRules: string[];

The list of IDs of inbound rules that use this frontend IP.

property loadBalancerRules

loadBalancerRules: string[];

The list of IDs of load balancing rules that use this frontend IP.

property name

name: string;

Specifies the name of the frontend ip configuration.

property outboundRules

outboundRules: string[];

The list of IDs outbound rules that use this frontend IP.

property privateIpAddress

privateIpAddress: string;

Private IP Address to assign to the Load Balancer. The last one and first four IPs in any range are reserved and cannot be manually assigned.

property privateIpAddressAllocation

privateIpAddressAllocation: string;

The allocation method for the Private IP Address used by this Load Balancer. Possible values as Dynamic and Static.

property privateIpAddressVersion

privateIpAddressVersion?: undefined | string;

The version of IP that the Private IP Address is. Possible values are IPv4 or IPv6.

property publicIpAddressId

publicIpAddressId: string;

The ID of a Public IP Address which should be associated with the Load Balancer.

property publicIpPrefixId

publicIpPrefixId: string;

The ID of a Public IP Prefix which should be associated with the Load Balancer. Public IP Prefix can only be used with outbound rules.

property subnetId

subnetId: string;

The ID of the Subnet which should be associated with the IP Configuration.

property zones

zones?: undefined | string;

A list of Availability Zones which the Load Balancer’s IP Addresses should be created in.

interface OutboundRuleFrontendIpConfiguration

interface OutboundRuleFrontendIpConfiguration

property id

id: string;

The ID of the Load Balancer Outbound Rule.

property name

name: string;

The name of the Frontend IP Configuration.

namespace logicapps

interface ActionHttpRunAfter

interface ActionHttpRunAfter

property actionName

actionName: string;

Specifies the name of the precedent HTTP Action.

property actionResult

actionResult: string;

Specifies the expected result of the precedent HTTP Action, only after which the current HTTP Action will be triggered.

namespace machinelearning

interface WorkspaceIdentity

interface WorkspaceIdentity

property principalId

principalId: string;

The (Client) ID of the Service Principal.

property tenantId

tenantId: string;

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

property type

type: string;

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

namespace managedapplication

interface ApplicationPlan

interface ApplicationPlan

property name

name: string;

Specifies the name of the plan from the marketplace.

property product

product: string;

Specifies the product of the plan from the marketplace.

property promotionCode

promotionCode?: undefined | string;

Specifies the promotion code to use with the plan.

property publisher

publisher: string;

Specifies the publisher of the plan.

property version

version: string;

Specifies the version of the plan from the marketplace.

interface DefinitionAuthorization

interface DefinitionAuthorization

property roleDefinitionId

roleDefinitionId: string;

Specifies a role definition identifier for the provider. This role will define all the permissions that the provider must have on the managed application’s container resource group. This role definition cannot have permission to delete the resource group.

property servicePrincipalId

servicePrincipalId: string;

Specifies a service principal identifier for the provider. This is the identity that the provider will use to call ARM to manage the managed application resources.

namespace mariadb

interface GetMariaDbServerStorageProfile

interface GetMariaDbServerStorageProfile

property autoGrow

autoGrow: string;

Whether autogrow is enabled or disabled for the storage.

property backupRetentionDays

backupRetentionDays: number;

Backup retention days for the server.

property geoRedundantBackup

geoRedundantBackup: string;

Whether Geo-redundant is enabled or not for server backup.

property storageMb

storageMb: number;

The max storage allowed for a server.

interface ServerStorageProfile

interface ServerStorageProfile

property autoGrow

DEPRECATED this has been moved to the top level boolean attribute `auto_grow_enabled` and will be removed in version 3.0 of the provider.
autoGrow: string;

property backupRetentionDays

DEPRECATED this has been moved to the top level and will be removed in version 3.0 of the provider.
backupRetentionDays: number;

Backup retention days for the server, supported values are between 7 and 35 days.

property geoRedundantBackup

DEPRECATED this has been moved to the top level boolean attribute geo_redundant_backup_enabled and will be removed in version 3.0 of the provider.
geoRedundantBackup: string;

property storageMb

DEPRECATED this has been moved to the top level and will be removed in version 3.0 of the provider.
storageMb?: undefined | number;

Max storage allowed for a server. Possible values are between 5120 MB (5GB) and 1024000MB (1TB) for the Basic SKU and between 5120 MB (5GB) and 4096000 MB (4TB) for General Purpose/Memory Optimized SKUs. For more information see the product documentation.

namespace mediaservices

interface AccountStorageAccount

interface AccountStorageAccount

property id

id: string;

Specifies the ID of the Storage Account that will be associated with the Media Services instance.

property isPrimary

isPrimary?: undefined | false | true;

Specifies whether the storage account should be the primary account or not. Defaults to false.

namespace monitoring

interface ActionGroupArmRoleReceiver

interface ActionGroupArmRoleReceiver

property name

name: string;

The name of the ARM role receiver.

property roleId

roleId: string;

The arm role id.

property useCommonAlertSchema

useCommonAlertSchema?: undefined | false | true;

Enables or disables the common alert schema.

interface ActionGroupAutomationRunbookReceiver

interface ActionGroupAutomationRunbookReceiver

property automationAccountId

automationAccountId: string;

The automation account ID which holds this runbook and authenticates to Azure resources.

property isGlobalRunbook

isGlobalRunbook: boolean;

Indicates whether this instance is global runbook.

property name

name: string;

The name of the automation runbook receiver.

property runbookName

runbookName: string;

The name for this runbook.

property serviceUri

serviceUri: string;

The URI where webhooks should be sent.

property useCommonAlertSchema

useCommonAlertSchema?: undefined | false | true;

Enables or disables the common alert schema.

property webhookResourceId

webhookResourceId: string;

The resource id for webhook linked to this runbook.

interface ActionGroupAzureAppPushReceiver

interface ActionGroupAzureAppPushReceiver

property emailAddress

emailAddress: string;

The email address of the user signed into the mobile app who will receive push notifications from this receiver.

property name

name: string;

The name of the Azure app push receiver.

interface ActionGroupAzureFunctionReceiver

interface ActionGroupAzureFunctionReceiver

property functionAppResourceId

functionAppResourceId: string;

The Azure resource ID of the function app.

property functionName

functionName: string;

The function name in the function app.

property httpTriggerUrl

httpTriggerUrl: string;

The http trigger url where http request sent to.

property name

name: string;

The name of the Azure Function receiver.

property useCommonAlertSchema

useCommonAlertSchema?: undefined | false | true;

Enables or disables the common alert schema.

interface ActionGroupEmailReceiver

interface ActionGroupEmailReceiver

property emailAddress

emailAddress: string;

The email address of this receiver.

property name

name: string;

The name of the email receiver. Names must be unique (case-insensitive) across all receivers within an action group.

property useCommonAlertSchema

useCommonAlertSchema?: undefined | false | true;

Enables or disables the common alert schema.

interface ActionGroupItsmReceiver

interface ActionGroupItsmReceiver

property connectionId

connectionId: string;

The unique connection identifier of the ITSM connection.

property name

name: string;

The name of the ITSM receiver.

property region

region: string;

The region of the workspace.

property ticketConfiguration

ticketConfiguration: string;

A JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.

property workspaceId

workspaceId: string;

The Azure Log Analytics workspace ID where this connection is defined.

interface ActionGroupLogicAppReceiver

interface ActionGroupLogicAppReceiver

property callbackUrl

callbackUrl: string;

The callback url where http request sent to.

property name

name: string;

The name of the logic app receiver.

property resourceId

resourceId: string;

The Azure resource ID of the logic app.

property useCommonAlertSchema

useCommonAlertSchema?: undefined | false | true;

Enables or disables the common alert schema.

interface ActionGroupSmsReceiver

interface ActionGroupSmsReceiver

property countryCode

countryCode: string;

The country code of the SMS receiver.

property name

name: string;

The name of the SMS receiver. Names must be unique (case-insensitive) across all receivers within an action group.

property phoneNumber

phoneNumber: string;

The phone number of the SMS receiver.

interface ActionGroupVoiceReceiver

interface ActionGroupVoiceReceiver

property countryCode

countryCode: string;

The country code of the voice receiver.

property name

name: string;

The name of the voice receiver.

property phoneNumber

phoneNumber: string;

The phone number of the voice receiver.

interface ActionGroupWebhookReceiver

interface ActionGroupWebhookReceiver

property name

name: string;

The name of the webhook receiver. Names must be unique (case-insensitive) across all receivers within an action group.

property serviceUri

serviceUri: string;

The URI where webhooks should be sent.

property useCommonAlertSchema

useCommonAlertSchema?: undefined | false | true;

Enables or disables the common alert schema.

interface ActionRuleActionGroupCondition

interface ActionRuleActionGroupCondition

property alertContext

alertContext?: outputs.monitoring.ActionRuleActionGroupConditionAlertContext;

A alertContext block as defined below.

property alertRuleId

alertRuleId?: outputs.monitoring.ActionRuleActionGroupConditionAlertRuleId;

A alertRuleId block as defined below.

property description

description?: outputs.monitoring.ActionRuleActionGroupConditionDescription;

A description block as defined below.

property monitor

monitor?: outputs.monitoring.ActionRuleActionGroupConditionMonitor;

A monitor block as defined below.

property monitorService

monitorService?: outputs.monitoring.ActionRuleActionGroupConditionMonitorService;

A monitorService as block defined below.

property severity

severity?: outputs.monitoring.ActionRuleActionGroupConditionSeverity;

A severity block as defined below.

property targetResourceType

targetResourceType?: outputs.monitoring.ActionRuleActionGroupConditionTargetResourceType;

A targetResourceType block as defined below.

interface ActionRuleActionGroupConditionAlertContext

interface ActionRuleActionGroupConditionAlertContext

property operator

operator: string;

The operator for a given condition. Possible values are Equals, NotEquals, Contains, and DoesNotContain.

property values

values: string[];

A list of values to match for a given condition.

interface ActionRuleActionGroupConditionAlertRuleId

interface ActionRuleActionGroupConditionAlertRuleId

property operator

operator: string;

The operator for a given condition. Possible values are Equals, NotEquals, Contains, and DoesNotContain.

property values

values: string[];

A list of values to match for a given condition.

interface ActionRuleActionGroupConditionDescription

interface ActionRuleActionGroupConditionDescription

property operator

operator: string;

The operator for a given condition. Possible values are Equals, NotEquals, Contains, and DoesNotContain.

property values

values: string[];

A list of values to match for a given condition.

interface ActionRuleActionGroupConditionMonitor

interface ActionRuleActionGroupConditionMonitor

property operator

operator: string;

The operator for a given condition. Possible values are Equals and NotEquals.

property values

values: string[];

A list of values to match for a given condition. Possible values are Fired and Resolved.

interface ActionRuleActionGroupConditionMonitorService

interface ActionRuleActionGroupConditionMonitorService

property operator

operator: string;

The operator for a given condition. Possible values are Equals and NotEquals.

property values

values: string[];

A list of values to match for a given condition. Possible values are ActivityLog Administrative, ActivityLog Autoscale, ActivityLog Policy, ActivityLog Recommendation, ActivityLog Security, Application Insights, Azure Backup, Data Box Edge, Data Box Gateway, Health Platform, Log Analytics, Platform, and Resource Health.

interface ActionRuleActionGroupConditionSeverity

interface ActionRuleActionGroupConditionSeverity

property operator

operator: string;

The operator for a given condition. Possible values are Equalsand NotEquals.

property values

values: string[];

A list of values to match for a given condition. Possible values are Sev0, Sev1, Sev2, Sev3, and Sev4.

interface ActionRuleActionGroupConditionTargetResourceType

interface ActionRuleActionGroupConditionTargetResourceType

property operator

operator: string;

The operator for a given condition. Possible values are Equals and NotEquals.

property values

values: string[];

A list of values to match for a given condition. The values should be valid resource types.

interface ActionRuleActionGroupScope

interface ActionRuleActionGroupScope

property resourceIds

resourceIds: string[];

A list of resource IDs of the given scope type which will be the target of action rule.

property type

type: string;

Specifies the type of target scope. Possible values are ResourceGroup and Resource.

interface ActionRuleSuppressionCondition

interface ActionRuleSuppressionCondition

property alertContext

alertContext?: outputs.monitoring.ActionRuleSuppressionConditionAlertContext;

A alertContext block as defined below.

property alertRuleId

alertRuleId?: outputs.monitoring.ActionRuleSuppressionConditionAlertRuleId;

A alertRuleId block as defined below.

property description

description?: outputs.monitoring.ActionRuleSuppressionConditionDescription;

A description block as defined below.

property monitor

monitor?: outputs.monitoring.ActionRuleSuppressionConditionMonitor;

A monitor block as defined below.

property monitorService

monitorService?: outputs.monitoring.ActionRuleSuppressionConditionMonitorService;

A monitorService as block defined below.

property severity

severity?: outputs.monitoring.ActionRuleSuppressionConditionSeverity;

A severity block as defined below.

property targetResourceType

targetResourceType?: outputs.monitoring.ActionRuleSuppressionConditionTargetResourceType;

A targetResourceType block as defined below.

interface ActionRuleSuppressionConditionAlertContext

interface ActionRuleSuppressionConditionAlertContext

property operator

operator: string;

The operator for a given condition. Possible values are Equals, NotEquals, Contains, and DoesNotContain.

property values

values: string[];

A list of values to match for a given condition.

interface ActionRuleSuppressionConditionAlertRuleId

interface ActionRuleSuppressionConditionAlertRuleId

property operator

operator: string;

The operator for a given condition. Possible values are Equals, NotEquals, Contains, and DoesNotContain.

property values

values: string[];

A list of values to match for a given condition.

interface ActionRuleSuppressionConditionDescription

interface ActionRuleSuppressionConditionDescription

property operator

operator: string;

The operator for a given condition. Possible values are Equals, NotEquals, Contains, and DoesNotContain.

property values

values: string[];

A list of values to match for a given condition.

interface ActionRuleSuppressionConditionMonitor

interface ActionRuleSuppressionConditionMonitor

property operator

operator: string;

The operator for a given condition. Possible values are Equals and NotEquals.

property values

values: string[];

A list of values to match for a given condition. Possible values are Fired and Resolved.

interface ActionRuleSuppressionConditionMonitorService

interface ActionRuleSuppressionConditionMonitorService

property operator

operator: string;

The operator for a given condition. Possible values are Equals and NotEquals.

property values

values: string[];

A list of values to match for a given condition. Possible values are ActivityLog Administrative, ActivityLog Autoscale, ActivityLog Policy, ActivityLog Recommendation, ActivityLog Security, Application Insights, Azure Backup, Data Box Edge, Data Box Gateway, Health Platform, Log Analytics, Platform, and Resource Health.

interface ActionRuleSuppressionConditionSeverity

interface ActionRuleSuppressionConditionSeverity

property operator

operator: string;

The operator for a given condition. Possible values are Equalsand NotEquals.

property values

values: string[];

A list of values to match for a given condition. Possible values are Sev0, Sev1, Sev2, Sev3, and Sev4.

interface ActionRuleSuppressionConditionTargetResourceType

interface ActionRuleSuppressionConditionTargetResourceType

property operator

operator: string;

The operator for a given condition. Possible values are Equals and NotEquals.

property values

values: string[];

A list of values to match for a given condition. The values should be valid resource types.

interface ActionRuleSuppressionScope

interface ActionRuleSuppressionScope

property resourceIds

resourceIds: string[];

A list of resource IDs of the given scope type which will be the target of action rule.

property type

type: string;

Specifies the type of target scope. Possible values are ResourceGroup and Resource.

interface ActionRuleSuppressionSuppression

interface ActionRuleSuppressionSuppression

property recurrenceType

recurrenceType: string;

Specifies the type of suppression. Possible values are Always, Daily, Monthly, Once, and Weekly.

property schedule

schedule?: outputs.monitoring.ActionRuleSuppressionSuppressionSchedule;

A schedule block as defined below. Required if recurrenceType is Daily, Monthly, Once or Weekly.

interface ActionRuleSuppressionSuppressionSchedule

interface ActionRuleSuppressionSuppressionSchedule

property endDateUtc

endDateUtc: string;

specifies the recurrence UTC end datetime (Y-m-d’T’H:M:S’Z’).

property recurrenceMonthlies

recurrenceMonthlies?: number[];

specifies the list of dayOfMonth to recurrence. Possible values are between 1 - 31. Required if recurrenceType is Monthly.

property recurrenceWeeklies

recurrenceWeeklies?: string[];

specifies the list of dayOfWeek to recurrence. Possible values are Sunday, Monday, Tuesday, Wednesday, Thursday, Friday and Saturday.

property startDateUtc

startDateUtc: string;

specifies the recurrence UTC start datetime (Y-m-d’T’H:M:S’Z’).

interface ActivityLogAlertAction

interface ActivityLogAlertAction

property actionGroupId

actionGroupId: string;

The ID of the Action Group can be sourced from the azure.monitoring.ActionGroup resource.

property webhookProperties

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

The map of custom string properties to include with the post operation. These data are appended to the webhook payload.

interface ActivityLogAlertCriteria

interface ActivityLogAlertCriteria

property caller

caller?: undefined | string;

The email address or Azure Active Directory identifier of the user who performed the operation.

property category

category: string;

The category of the operation. Possible values are Administrative, Autoscale, Policy, Recommendation, ResourceHealth, Security and ServiceHealth.

property level

level?: undefined | string;

The severity level of the event. Possible values are Verbose, Informational, Warning, Error, and Critical.

property operationName

operationName?: undefined | string;

The Resource Manager Role-Based Access Control operation name. Supported operation should be of the form: <resourceProvider>/<resourceType>/<operation>.

property resourceGroup

resourceGroup?: undefined | string;

The name of resource group monitored by the activity log alert.

property resourceId

resourceId?: undefined | string;

The specific resource monitored by the activity log alert. It should be within one of the scopes.

property resourceProvider

resourceProvider?: undefined | string;

The name of the resource provider monitored by the activity log alert.

property resourceType

resourceType?: undefined | string;

The resource type monitored by the activity log alert.

property status

status?: undefined | string;

The status of the event. For example, Started, Failed, or Succeeded.

property subStatus

subStatus?: undefined | string;

The sub status of the event.

interface AutoscaleSettingNotification

interface AutoscaleSettingNotification

property email

email?: outputs.monitoring.AutoscaleSettingNotificationEmail;

A email block as defined below.

property webhooks

webhooks?: AutoscaleSettingNotificationWebhook[];

One or more webhook blocks as defined below.

interface AutoscaleSettingNotificationEmail

interface AutoscaleSettingNotificationEmail

property customEmails

customEmails?: string[];

Specifies a list of custom email addresses to which the email notifications will be sent.

property sendToSubscriptionAdministrator

sendToSubscriptionAdministrator?: undefined | false | true;

Should email notifications be sent to the subscription administrator? Defaults to false.

property sendToSubscriptionCoAdministrator

sendToSubscriptionCoAdministrator?: undefined | false | true;

Should email notifications be sent to the subscription co-administrator? Defaults to false.

interface AutoscaleSettingNotificationWebhook

interface AutoscaleSettingNotificationWebhook

property properties

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

A map of settings.

property serviceUri

serviceUri: string;

The HTTPS URI which should receive scale notifications.

interface AutoscaleSettingProfile

interface AutoscaleSettingProfile

property capacity

capacity: AutoscaleSettingProfileCapacity;

A capacity block as defined below.

property fixedDate

fixedDate?: outputs.monitoring.AutoscaleSettingProfileFixedDate;

A fixedDate block as defined below. This cannot be specified if a recurrence block is specified.

property name

name: string;

Specifies the name of the profile.

property recurrence

recurrence?: outputs.monitoring.AutoscaleSettingProfileRecurrence;

A recurrence block as defined below. This cannot be specified if a fixedDate block is specified.

property rules

rules?: AutoscaleSettingProfileRule[];

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

interface AutoscaleSettingProfileCapacity

interface AutoscaleSettingProfileCapacity

property default

default: number;

The number of instances that are available for scaling if metrics are not available for evaluation. The default is only used if the current instance count is lower than the default. Valid values are between 0 and 1000.

property maximum

maximum: number;

The maximum number of instances for this resource. Valid values are between 0 and 1000.

property minimum

minimum: number;

The minimum number of instances for this resource. Valid values are between 0 and 1000.

interface AutoscaleSettingProfileFixedDate

interface AutoscaleSettingProfileFixedDate

property end

end: string;

Specifies the end date for the profile, formatted as an RFC3339 date string.

property start

start: string;

Specifies the start date for the profile, formatted as an RFC3339 date string.

property timezone

timezone?: undefined | string;

The Time Zone of the start and end times. A list of possible values can be found here. Defaults to UTC.

interface AutoscaleSettingProfileRecurrence

interface AutoscaleSettingProfileRecurrence

property days

days: string[];

A list of days that this profile takes effect on. Possible values include Monday, Tuesday, Wednesday, Thursday, Friday, Saturday and Sunday.

property hours

hours: number;

A list containing a single item, which specifies the Hour interval at which this recurrence should be triggered (in 24-hour time). Possible values are from 0 to 23.

property minutes

minutes: number;

A list containing a single item which specifies the Minute interval at which this recurrence should be triggered.

property timezone

timezone?: undefined | string;

The Time Zone used for the hours field. A list of possible values can be found here. Defaults to UTC.

interface AutoscaleSettingProfileRule

interface AutoscaleSettingProfileRule

property metricTrigger

metricTrigger: AutoscaleSettingProfileRuleMetricTrigger;

A metricTrigger block as defined below.

property scaleAction

scaleAction: AutoscaleSettingProfileRuleScaleAction;

A scaleAction block as defined below.

interface AutoscaleSettingProfileRuleMetricTrigger

interface AutoscaleSettingProfileRuleMetricTrigger

property metricName

metricName: string;

The name of the metric that defines what the rule monitors, such as Percentage CPU for Virtual Machine Scale Sets and CpuPercentage for App Service Plan.

property metricResourceId

metricResourceId: string;

The ID of the Resource which the Rule monitors.

property operator

operator: string;

Specifies the operator used to compare the metric data and threshold. Possible values are: Equals, NotEquals, GreaterThan, GreaterThanOrEqual, LessThan, LessThanOrEqual.

property statistic

statistic: string;

Specifies how the metrics from multiple instances are combined. Possible values are Average, Min and Max.

property threshold

threshold: number;

Specifies the threshold of the metric that triggers the scale action.

property timeAggregation

timeAggregation: string;

Specifies how the data that’s collected should be combined over time. Possible values include Average, Count, Maximum, Minimum, Last and Total. Defaults to Average.

property timeGrain

timeGrain: string;

Specifies the granularity of metrics that the rule monitors, which must be one of the pre-defined values returned from the metric definitions for the metric. This value must be between 1 minute and 12 hours an be formatted as an ISO 8601 string.

property timeWindow

timeWindow: string;

Specifies the time range for which data is collected, which must be greater than the delay in metric collection (which varies from resource to resource). This value must be between 5 minutes and 12 hours and be formatted as an ISO 8601 string.

interface AutoscaleSettingProfileRuleScaleAction

interface AutoscaleSettingProfileRuleScaleAction

property cooldown

cooldown: string;

The amount of time to wait since the last scaling action before this action occurs. Must be between 1 minute and 1 week and formatted as a ISO 8601 string.

property direction

direction: string;

The scale direction. Possible values are Increase and Decrease.

property type

type: string;

The type of action that should occur. Possible values are ChangeCount, ExactCount and PercentChangeCount.

property value

value: number;

The number of instances involved in the scaling action. Defaults to 1.

interface DiagnosticSettingLog

interface DiagnosticSettingLog

property category

category: string;

The name of a Diagnostic Log Category for this Resource.

property enabled

enabled?: undefined | false | true;

Is this Diagnostic Log enabled? Defaults to true.

property retentionPolicy

retentionPolicy?: outputs.monitoring.DiagnosticSettingLogRetentionPolicy;

A retentionPolicy block as defined below.

interface DiagnosticSettingLogRetentionPolicy

interface DiagnosticSettingLogRetentionPolicy

property days

days?: undefined | number;

The number of days for which this Retention Policy should apply.

property enabled

enabled: boolean;

Is this Retention Policy enabled?

interface DiagnosticSettingMetric

interface DiagnosticSettingMetric

property category

category: string;

The name of a Diagnostic Metric Category for this Resource.

property enabled

enabled?: undefined | false | true;

Is this Diagnostic Metric enabled? Defaults to true.

property retentionPolicy

retentionPolicy?: outputs.monitoring.DiagnosticSettingMetricRetentionPolicy;

A retentionPolicy block as defined below.

interface DiagnosticSettingMetricRetentionPolicy

interface DiagnosticSettingMetricRetentionPolicy

property days

days?: undefined | number;

The number of days for which this Retention Policy should apply.

property enabled

enabled: boolean;

Is this Retention Policy enabled?

interface GetActionGroupArmRoleReceiver

interface GetActionGroupArmRoleReceiver

property name

name: string;

Specifies the name of the Action Group.

property roleId

roleId: string;

The arm role id.

property useCommonAlertSchema

useCommonAlertSchema: boolean;

Indicates whether to use common alert schema.

interface GetActionGroupAutomationRunbookReceiver

interface GetActionGroupAutomationRunbookReceiver

property automationAccountId

automationAccountId: string;

The automation account ID which holds this runbook and authenticates to Azure resources.

property isGlobalRunbook

isGlobalRunbook: boolean;

Indicates whether this instance is global runbook.

property name

name: string;

Specifies the name of the Action Group.

property runbookName

runbookName: string;

The name for this runbook.

property serviceUri

serviceUri: string;

The URI where webhooks should be sent.

property useCommonAlertSchema

useCommonAlertSchema: boolean;

Indicates whether to use common alert schema.

property webhookResourceId

webhookResourceId: string;

The resource id for webhook linked to this runbook.

interface GetActionGroupAzureAppPushReceiver

interface GetActionGroupAzureAppPushReceiver

property emailAddress

emailAddress: string;

The email address of this receiver.

property name

name: string;

Specifies the name of the Action Group.

interface GetActionGroupAzureFunctionReceiver

interface GetActionGroupAzureFunctionReceiver

property functionAppResourceId

functionAppResourceId: string;

property functionName

functionName: string;

The function name in the function app.

property httpTriggerUrl

httpTriggerUrl: string;

The http trigger url where http request sent to.

property name

name: string;

Specifies the name of the Action Group.

property useCommonAlertSchema

useCommonAlertSchema: boolean;

Indicates whether to use common alert schema.

interface GetActionGroupEmailReceiver

interface GetActionGroupEmailReceiver

property emailAddress

emailAddress: string;

The email address of this receiver.

property name

name: string;

Specifies the name of the Action Group.

property useCommonAlertSchema

useCommonAlertSchema: boolean;

Indicates whether to use common alert schema.

interface GetActionGroupItsmReceiver

interface GetActionGroupItsmReceiver

property connectionId

connectionId: string;

The unique connection identifier of the ITSM connection.

property name

name: string;

Specifies the name of the Action Group.

property region

region: string;

The region of the workspace.

property ticketConfiguration

ticketConfiguration: string;

A JSON blob for the configurations of the ITSM action. CreateMultipleWorkItems option will be part of this blob as well.

property workspaceId

workspaceId: string;

The Azure Log Analytics workspace ID where this connection is defined.

interface GetActionGroupLogicAppReceiver

interface GetActionGroupLogicAppReceiver

property callbackUrl

callbackUrl: string;

The callback url where http request sent to.

property name

name: string;

Specifies the name of the Action Group.

property resourceId

resourceId: string;

The Azure resource ID of the logic app.

property useCommonAlertSchema

useCommonAlertSchema: boolean;

Indicates whether to use common alert schema.

interface GetActionGroupSmsReceiver

interface GetActionGroupSmsReceiver

property countryCode

countryCode: string;

The country code of the voice receiver.

property name

name: string;

Specifies the name of the Action Group.

property phoneNumber

phoneNumber: string;

The phone number of the voice receiver.

interface GetActionGroupVoiceReceiver

interface GetActionGroupVoiceReceiver

property countryCode

countryCode: string;

The country code of the voice receiver.

property name

name: string;

Specifies the name of the Action Group.

property phoneNumber

phoneNumber: string;

The phone number of the voice receiver.

interface GetActionGroupWebhookReceiver

interface GetActionGroupWebhookReceiver

property name

name: string;

Specifies the name of the Action Group.

property serviceUri

serviceUri: string;

The URI where webhooks should be sent.

property useCommonAlertSchema

useCommonAlertSchema?: undefined | false | true;

Indicates whether to use common alert schema.

interface GetLogProfileRetentionPolicy

interface GetLogProfileRetentionPolicy

property days

days: number;

The number of days for the retention policy.

property enabled

enabled: boolean;

A boolean value indicating whether the retention policy is enabled.

interface GetScheduledQueryRulesAlertAction

interface GetScheduledQueryRulesAlertAction

property actionGroups

actionGroups: string[];

List of action group reference resource IDs.

property customWebhookPayload

customWebhookPayload: string;

Custom payload to be sent for all webhook URI in Azure action group.

property emailSubject

emailSubject: string;

Custom subject override for all email IDs in Azure action group.

interface GetScheduledQueryRulesAlertTrigger

interface GetScheduledQueryRulesAlertTrigger

property metricTriggers

metricTriggers: GetScheduledQueryRulesAlertTriggerMetricTrigger[];

property operator

operator: string;

Evaluation operation for rule.

property threshold

threshold: number;

Result or count threshold based on which rule should be triggered.

interface GetScheduledQueryRulesAlertTriggerMetricTrigger

interface GetScheduledQueryRulesAlertTriggerMetricTrigger

property metricColumn

metricColumn: string;

property metricTriggerType

metricTriggerType: string;

property operator

operator: string;

Evaluation operation for rule.

property threshold

threshold: number;

Result or count threshold based on which rule should be triggered.

interface GetScheduledQueryRulesLogCriteria

interface GetScheduledQueryRulesLogCriteria

property dimensions

dimensions: GetScheduledQueryRulesLogCriteriaDimension[];

A dimension block as defined below.

property metricName

metricName: string;

Name of the metric.

interface GetScheduledQueryRulesLogCriteriaDimension

interface GetScheduledQueryRulesLogCriteriaDimension

property name

name: string;

Specifies the name of the scheduled query rule.

property operator

operator: string;

Operator for dimension values.

property values

values: string[];

List of dimension values.

interface LogProfileRetentionPolicy

interface LogProfileRetentionPolicy

property days

days?: undefined | number;

The number of days for the retention policy. Defaults to 0.

property enabled

enabled: boolean;

A boolean value to indicate whether the retention policy is enabled.

interface MetricAlertAction

interface MetricAlertAction

property actionGroupId

actionGroupId: string;

The ID of the Action Group can be sourced from the azure.monitoring.ActionGroup resource

property webhookProperties

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

The map of custom string properties to include with the post operation. These data are appended to the webhook payload.

interface MetricAlertCriteria

interface MetricAlertCriteria

property aggregation

aggregation: string;

The statistic that runs over the metric values. Possible values are Average, Count, Minimum, Maximum and Total.

property dimensions

dimensions?: MetricAlertCriteriaDimension[];

One or more dimension blocks as defined below.

property metricName

metricName: string;

One of the metric names to be monitored.

property metricNamespace

metricNamespace: string;

One of the metric namespaces to be monitored.

property operator

operator: string;

The criteria operator. Possible values are Equals, NotEquals, GreaterThan, GreaterThanOrEqual, LessThan and LessThanOrEqual.

property threshold

threshold: number;

The criteria threshold value that activates the alert.

interface MetricAlertCriteriaDimension

interface MetricAlertCriteriaDimension

property name

name: string;

One of the dimension names.

property operator

operator: string;

The dimension operator. Possible values are Include and Exclude.

property values

values: string[];

The list of dimension values.

interface ScheduledQueryRulesAlertAction

interface ScheduledQueryRulesAlertAction

property actionGroups

actionGroups: string[];

List of action group reference resource IDs.

property customWebhookPayload

customWebhookPayload?: undefined | string;

Custom payload to be sent for all webhook payloads in alerting action.

property emailSubject

emailSubject?: undefined | string;

Custom subject override for all email ids in Azure action group.

interface ScheduledQueryRulesAlertTrigger

interface ScheduledQueryRulesAlertTrigger

property metricTrigger

metricTrigger?: outputs.monitoring.ScheduledQueryRulesAlertTriggerMetricTrigger;

property operator

operator: string;

Evaluation operation for rule - ‘Equal’, ‘GreaterThan’ or ‘LessThan’.

property threshold

threshold: number;

Result or count threshold based on which rule should be triggered. Values must be between 0 and 10000 inclusive.

interface ScheduledQueryRulesAlertTriggerMetricTrigger

interface ScheduledQueryRulesAlertTriggerMetricTrigger

property metricColumn

metricColumn: string;

property metricTriggerType

metricTriggerType: string;

property operator

operator: string;

Evaluation operation for rule - ‘Equal’, ‘GreaterThan’ or ‘LessThan’.

property threshold

threshold: number;

The threshold of the metric trigger. Values must be between 0 and 10000 inclusive.

interface ScheduledQueryRulesLogCriteria

interface ScheduledQueryRulesLogCriteria

property dimensions

dimensions: ScheduledQueryRulesLogCriteriaDimension[];

A dimension block as defined below.

property metricName

metricName: string;

Name of the metric. Supported metrics are listed in the Azure Monitor Microsoft.OperationalInsights/workspaces metrics namespace.

interface ScheduledQueryRulesLogCriteriaDimension

interface ScheduledQueryRulesLogCriteriaDimension

property name

name: string;

Name of the dimension.

property operator

operator?: undefined | string;

Operator for dimension values, - ‘Include’.

property values

values: string[];

List of dimension values.

namespace mssql

interface DatabaseExtendedAuditingPolicy

interface DatabaseExtendedAuditingPolicy

property retentionInDays

retentionInDays?: undefined | number;

Specifies the number of days to retain logs for in the storage account.

property storageAccountAccessKey

storageAccountAccessKey: string;

Specifies the access key to use for the auditing storage account.

property storageAccountAccessKeyIsSecondary

storageAccountAccessKeyIsSecondary?: undefined | false | true;

Specifies whether storageAccountAccessKey value is the storage’s secondary key.

property storageEndpoint

storageEndpoint: string;

Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net).

interface DatabaseThreatDetectionPolicy

interface DatabaseThreatDetectionPolicy

property disabledAlerts

disabledAlerts?: string[];

Specifies a list of alerts which should be disabled. Possible values include Access_Anomaly, Sql_Injection and Sql_Injection_Vulnerability.

property emailAccountAdmins

emailAccountAdmins?: undefined | string;

Should the account administrators be emailed when this alert is triggered?

property emailAddresses

emailAddresses?: string[];

A list of email addresses which alerts should be sent to.

property retentionDays

retentionDays?: undefined | number;

Specifies the number of days to keep in the Threat Detection audit logs.

property state

state?: undefined | string;

The State of the Policy. Possible values are Enabled, Disabled or New.

property storageAccountAccessKey

storageAccountAccessKey?: undefined | string;

Specifies the identifier key of the Threat Detection audit storage account. Required if state is Enabled.

property storageEndpoint

storageEndpoint?: undefined | string;

Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. Required if state is Enabled.

property useServerDefault

useServerDefault?: undefined | string;

Should the default server policy be used? Defaults to Disabled.

interface DatabaseVulnerabilityAssessmentRuleBaselineBaselineResult

interface DatabaseVulnerabilityAssessmentRuleBaselineBaselineResult

property results

results: string[];

A list representing a result of the baseline.

interface ElasticPoolPerDatabaseSettings

interface ElasticPoolPerDatabaseSettings

property maxCapacity

maxCapacity: number;

The maximum capacity any one database can consume.

property minCapacity

minCapacity: number;

The minimum capacity all databases are guaranteed.

interface ElasticPoolSku

interface ElasticPoolSku

property capacity

capacity: number;

The scale up/out capacity, representing server’s compute units. For more information see the documentation for your Elasticpool configuration: vCore-based or DTU-based.

property family

family?: undefined | string;

The family of hardware Gen4 or Gen5.

property name

name: string;

Specifies the SKU Name for this Elasticpool. The name of the SKU, will be either vCore based tier + family pattern (e.g. GP_Gen4, BC_Gen5) or the DTU based BasicPool, StandardPool, or PremiumPool pattern.

property tier

tier: string;

The tier of the particular SKU. Possible values are GeneralPurpose, BusinessCritical, Basic, Standard, or Premium. For more information see the documentation for your Elasticpool configuration: vCore-based or DTU-based.

interface ServerAzureadAdministrator

interface ServerAzureadAdministrator

property loginUsername

loginUsername: string;

(Required) The login username of the Azure AD Administrator of this SQL Server.

property objectId

objectId: string;

(Required) The object id of the Azure AD Administrator of this SQL Server.

property tenantId

tenantId: string;

(Optional) The tenant id of the Azure AD Administrator of this SQL Server.

interface ServerExtendedAuditingPolicy

interface ServerExtendedAuditingPolicy

property retentionInDays

retentionInDays?: undefined | number;

(Optional) Specifies the number of days to retain logs for in the storage account.

property storageAccountAccessKey

storageAccountAccessKey: string;

(Required) Specifies the access key to use for the auditing storage account.

property storageAccountAccessKeyIsSecondary

storageAccountAccessKeyIsSecondary?: undefined | false | true;

(Optional) Specifies whether storageAccountAccessKey value is the storage’s secondary key.

property storageEndpoint

storageEndpoint: string;

(Required) Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net).

interface ServerIdentity

interface ServerIdentity

property principalId

principalId: string;

The Principal ID for the Service Principal associated with the Identity of this SQL Server.

property tenantId

tenantId: string;

(Optional) The tenant id of the Azure AD Administrator of this SQL Server.

property type

type: string;

Specifies the identity type of the Microsoft SQL Server. At this time the only allowed value is SystemAssigned.

interface ServerVulnerabilityAssessmentRecurringScans

interface ServerVulnerabilityAssessmentRecurringScans

property emailSubscriptionAdmins

emailSubscriptionAdmins?: undefined | false | true;

Boolean flag which specifies if the schedule scan notification will be sent to the subscription administrators. Defaults to false.

property emails

emails?: string[];

Specifies an array of e-mail addresses to which the scan notification is sent.

property enabled

enabled?: undefined | false | true;

Boolean flag which specifies if recurring scans is enabled or disabled. Defaults to false.

interface VirtualMachineAutoPatching

interface VirtualMachineAutoPatching

property dayOfWeek

dayOfWeek: string;

The day of week to apply the patch on.

property maintenanceWindowDurationInMinutes

maintenanceWindowDurationInMinutes: number;

The size of the Maintenance Window in minutes.

property maintenanceWindowStartingHour

maintenanceWindowStartingHour: number;

The Hour, in the Virtual Machine Time-Zone when the patching maintenance window should begin.

interface VirtualMachineKeyVaultCredential

interface VirtualMachineKeyVaultCredential

property keyVaultUrl

keyVaultUrl: string;

The azure Key Vault url. Changing this forces a new resource to be created.

property name

name: string;

The credential name.

property servicePrincipalName

servicePrincipalName: string;

The service principal name to access key vault. Changing this forces a new resource to be created.

property servicePrincipalSecret

servicePrincipalSecret: string;

The service principal name secret to access key vault. Changing this forces a new resource to be created.

namespace mysql

interface ServerStorageProfile

interface ServerStorageProfile

property autoGrow

DEPRECATED this has been moved to the top level boolean attribute `auto_grow_enabled` and will be removed in version 3.0 of the provider.
autoGrow: string;

property backupRetentionDays

DEPRECATED this has been moved to the top level and will be removed in version 3.0 of the provider.
backupRetentionDays: number;

Backup retention days for the server, supported values are between 7 and 35 days.

property geoRedundantBackup

DEPRECATED this has been moved to the top level boolean attribute geo_redundant_backup_enabled and will be removed in version 3.0 of the provider.
geoRedundantBackup: string;

property storageMb

DEPRECATED this has been moved to the top level and will be removed in version 3.0 of the provider.
storageMb?: undefined | number;

Max storage allowed for a server. Possible values are between 5120 MB(5GB) and 1048576 MB(1TB) for the Basic SKU and between 5120 MB(5GB) and 4194304 MB(4TB) for General Purpose/Memory Optimized SKUs. For more information see the product documentation.

namespace netapp

interface AccountActiveDirectory

interface AccountActiveDirectory

property dnsServers

dnsServers: string[];

A list of DNS server IP addresses for the Active Directory domain. Only allows IPv4 address.

property domain

domain: string;

The name of the Active Directory domain.

property organizationalUnit

organizationalUnit?: undefined | string;

The Organizational Unit (OU) within the Active Directory Domain.

property password

password: string;

The password associated with the username.

property smbServerName

smbServerName: string;

The NetBIOS name which should be used for the NetApp SMB Server, which will be registered as a computer account in the AD and used to mount volumes.

property username

username: string;

The Username of Active Directory Domain Administrator.

interface VolumeExportPolicyRule

interface VolumeExportPolicyRule

property allowedClients

allowedClients: string[];

A list of allowed clients IPv4 addresses.

property cifsEnabled

DEPRECATED Deprecated in favour of protocols_enabled
cifsEnabled: boolean;

Is the CIFS protocol allowed?

property nfsv3Enabled

DEPRECATED Deprecated in favour of protocols_enabled
nfsv3Enabled: boolean;

Is the NFSv3 protocol allowed?

property nfsv4Enabled

DEPRECATED Deprecated in favour of protocols_enabled
nfsv4Enabled: boolean;

Is the NFSv4 protocol allowed?

property protocolsEnabled

protocolsEnabled: string;

A list of allowed protocols. Valid values include CIFS, NFSv3, or NFSv4.1. Only one value is supported at this time. This replaces the previous arguments: cifsEnabled, nfsv3Enabled and nfsv4Enabled.

property ruleIndex

ruleIndex: number;

The index number of the rule.

property unixReadOnly

unixReadOnly?: undefined | false | true;

Is the file system on unix read only?

property unixReadWrite

unixReadWrite?: undefined | false | true;

Is the file system on unix read and write?

namespace network

interface ApplicationGatewayAuthenticationCertificate

interface ApplicationGatewayAuthenticationCertificate

property data

data: string;

The contents of the Authentication Certificate which should be used.

property id

id: string;

The ID of the Rewrite Rule Set

property name

name: string;

The name of the Authentication Certificate.

interface ApplicationGatewayAutoscaleConfiguration

interface ApplicationGatewayAutoscaleConfiguration

property maxCapacity

maxCapacity?: undefined | number;

Maximum capacity for autoscaling. Accepted values are in the range 2 to 125.

property minCapacity

minCapacity: number;

Minimum capacity for autoscaling. Accepted values are in the range 0 to 100.

interface ApplicationGatewayBackendAddressPool

interface ApplicationGatewayBackendAddressPool

property fqdns

fqdns?: string[];

A list of FQDN’s which should be part of the Backend Address Pool.

property id

id: string;

The ID of the Rewrite Rule Set

property ipAddresses

ipAddresses?: string[];

A list of IP Addresses which should be part of the Backend Address Pool.

property name

name: string;

The name of the Backend Address Pool.

interface ApplicationGatewayBackendHttpSetting

interface ApplicationGatewayBackendHttpSetting

property affinityCookieName

affinityCookieName?: undefined | string;

The name of the affinity cookie.

property authenticationCertificates

authenticationCertificates?: ApplicationGatewayBackendHttpSettingAuthenticationCertificate[];

One or more authenticationCertificate blocks.

property connectionDraining

connectionDraining?: outputs.network.ApplicationGatewayBackendHttpSettingConnectionDraining;

A connectionDraining block as defined below.

property cookieBasedAffinity

cookieBasedAffinity: string;

Is Cookie-Based Affinity enabled? Possible values are Enabled and Disabled.

property hostName

hostName?: undefined | string;

Host header to be sent to the backend servers. Cannot be set if pickHostNameFromBackendAddress is set to true.

property id

id: string;

The ID of the Rewrite Rule Set

property name

name: string;

The name of the Backend HTTP Settings Collection.

property path

path?: undefined | string;

The Path which should be used as a prefix for all HTTP requests.

property pickHostNameFromBackendAddress

pickHostNameFromBackendAddress?: undefined | false | true;

Whether host header should be picked from the host name of the backend server. Defaults to false.

property port

port: number;

The port which should be used for this Backend HTTP Settings Collection.

property probeId

probeId: string;

The ID of the associated Probe.

property probeName

probeName?: undefined | string;

The name of an associated HTTP Probe.

property protocol

protocol: string;

The Protocol which should be used. Possible values are Http and Https.

property requestTimeout

requestTimeout?: undefined | number;

The request timeout in seconds, which must be between 1 and 86400 seconds.

property trustedRootCertificateNames

trustedRootCertificateNames?: string[];

A list of trustedRootCertificate names.

interface ApplicationGatewayBackendHttpSettingAuthenticationCertificate

interface ApplicationGatewayBackendHttpSettingAuthenticationCertificate

property id

id: string;

The ID of the Rewrite Rule Set

property name

name: string;

The name of the Authentication Certificate.

interface ApplicationGatewayBackendHttpSettingConnectionDraining

interface ApplicationGatewayBackendHttpSettingConnectionDraining

property drainTimeoutSec

drainTimeoutSec: number;

The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds.

property enabled

enabled: boolean;

If connection draining is enabled or not.

interface ApplicationGatewayCustomErrorConfiguration

interface ApplicationGatewayCustomErrorConfiguration

property customErrorPageUrl

customErrorPageUrl: string;

Error page URL of the application gateway customer error.

property id

id: string;

The ID of the Rewrite Rule Set

property statusCode

statusCode: string;

Status code of the application gateway customer error. Possible values are HttpStatus403 and HttpStatus502

interface ApplicationGatewayFrontendIpConfiguration

interface ApplicationGatewayFrontendIpConfiguration

property id

id: string;

The ID of the Rewrite Rule Set

property name

name: string;

The name of the Frontend IP Configuration.

property privateIpAddress

privateIpAddress: string;

The Private IP Address to use for the Application Gateway.

property privateIpAddressAllocation

privateIpAddressAllocation: string;

The Allocation Method for the Private IP Address. Possible values are Dynamic and Static.

property publicIpAddressId

publicIpAddressId: string;

The ID of a Public IP Address which the Application Gateway should use.

property subnetId

subnetId: string;

The ID of the Subnet.

interface ApplicationGatewayFrontendPort

interface ApplicationGatewayFrontendPort

property id

id: string;

The ID of the Rewrite Rule Set

property name

name: string;

The name of the Frontend Port.

property port

port: number;

The port used for this Frontend Port.

interface ApplicationGatewayGatewayIpConfiguration

interface ApplicationGatewayGatewayIpConfiguration

property id

id: string;

The ID of the Rewrite Rule Set

property name

name: string;

The Name of this Gateway IP Configuration.

property subnetId

subnetId: string;

The ID of the Subnet which the Application Gateway should be connected to.

interface ApplicationGatewayHttpListener

interface ApplicationGatewayHttpListener

property customErrorConfigurations

customErrorConfigurations?: ApplicationGatewayHttpListenerCustomErrorConfiguration[];

One or more customErrorConfiguration blocks as defined below.

property frontendIpConfigurationId

frontendIpConfigurationId: string;

The ID of the associated Frontend Configuration.

property frontendIpConfigurationName

frontendIpConfigurationName: string;

The Name of the Frontend IP Configuration used for this HTTP Listener.

property frontendPortId

frontendPortId: string;

The ID of the associated Frontend Port.

property frontendPortName

frontendPortName: string;

The Name of the Frontend Port use for this HTTP Listener.

property hostName

hostName?: undefined | string;

The Hostname which should be used for this HTTP Listener.

property hostNames

hostNames?: string[];

A list of Hostname(s) should be used for this HTTP Listener. It allows special wildcard characters.

property id

id: string;

The ID of the Rewrite Rule Set

property name

name: string;

The Name of the HTTP Listener.

property protocol

protocol: string;

The Protocol to use for this HTTP Listener. Possible values are Http and Https.

property requireSni

requireSni?: undefined | false | true;

Should Server Name Indication be Required? Defaults to false.

property sslCertificateId

sslCertificateId: string;

The ID of the associated SSL Certificate.

property sslCertificateName

sslCertificateName?: undefined | string;

The name of the associated SSL Certificate which should be used for this HTTP Listener.

interface ApplicationGatewayHttpListenerCustomErrorConfiguration

interface ApplicationGatewayHttpListenerCustomErrorConfiguration

property customErrorPageUrl

customErrorPageUrl: string;

Error page URL of the application gateway customer error.

property id

id: string;

The ID of the Rewrite Rule Set

property statusCode

statusCode: string;

Status code of the application gateway customer error. Possible values are HttpStatus403 and HttpStatus502

interface ApplicationGatewayIdentity

interface ApplicationGatewayIdentity

property identityIds

identityIds: string;

Specifies a list with a single user managed identity id to be assigned to the Application Gateway.

property type

type?: undefined | string;

The Managed Service Identity Type of this Application Gateway. The only possible value is UserAssigned. Defaults to UserAssigned.

interface ApplicationGatewayProbe

interface ApplicationGatewayProbe

property host

host?: undefined | string;

The Hostname used for this Probe. If the Application Gateway is configured for a single site, by default the Host name should be specified as ‘127.0.0.1’, unless otherwise configured in custom probe. Cannot be set if pickHostNameFromBackendHttpSettings is set to true.

property id

id: string;

The ID of the Rewrite Rule Set

property interval

interval: number;

The Interval between two consecutive probes in seconds. Possible values range from 1 second to a maximum of 86,400 seconds.

property match

match: ApplicationGatewayProbeMatch;

A match block as defined above.

property minimumServers

minimumServers?: undefined | number;

The minimum number of servers that are always marked as healthy. Defaults to 0.

property name

name: string;

The Name of the Probe.

property path

path: string;

The Path used for this Probe.

property pickHostNameFromBackendHttpSettings

pickHostNameFromBackendHttpSettings?: undefined | false | true;

Whether the host header should be picked from the backend http settings. Defaults to false.

property protocol

protocol: string;

The Protocol used for this Probe. Possible values are Http and Https.

property timeout

timeout: number;

The Timeout used for this Probe, which indicates when a probe becomes unhealthy. Possible values range from 1 second to a maximum of 86,400 seconds.

property unhealthyThreshold

unhealthyThreshold: number;

The Unhealthy Threshold for this Probe, which indicates the amount of retries which should be attempted before a node is deemed unhealthy. Possible values are from 1 - 20 seconds.

interface ApplicationGatewayProbeMatch

interface ApplicationGatewayProbeMatch

property body

body?: undefined | string;

A snippet from the Response Body which must be present in the Response..

property statusCodes

statusCodes?: string[];

A list of allowed status codes for this Health Probe.

interface ApplicationGatewayRedirectConfiguration

interface ApplicationGatewayRedirectConfiguration

property id

id: string;

The ID of the Rewrite Rule Set

property includePath

includePath?: undefined | false | true;

Whether or not to include the path in the redirected Url. Defaults to false

property includeQueryString

includeQueryString?: undefined | false | true;

Whether or not to include the query string in the redirected Url. Default to false

property name

name: string;

Unique name of the redirect configuration block

property redirectType

redirectType: string;

The type of redirect. Possible values are Permanent, Temporary, Found and SeeOther

property targetListenerId

targetListenerId: string;

property targetListenerName

targetListenerName?: undefined | string;

The name of the listener to redirect to. Cannot be set if targetUrl is set.

property targetUrl

targetUrl?: undefined | string;

The Url to redirect the request to. Cannot be set if targetListenerName is set.

interface ApplicationGatewayRequestRoutingRule

interface ApplicationGatewayRequestRoutingRule

property backendAddressPoolId

backendAddressPoolId: string;

The ID of the associated Backend Address Pool.

property backendAddressPoolName

backendAddressPoolName?: undefined | string;

The Name of the Backend Address Pool which should be used for this Routing Rule. Cannot be set if redirectConfigurationName is set.

property backendHttpSettingsId

backendHttpSettingsId: string;

The ID of the associated Backend HTTP Settings Configuration.

property backendHttpSettingsName

backendHttpSettingsName?: undefined | string;

The Name of the Backend HTTP Settings Collection which should be used for this Routing Rule. Cannot be set if redirectConfigurationName is set.

property httpListenerId

httpListenerId: string;

The ID of the associated HTTP Listener.

property httpListenerName

httpListenerName: string;

The Name of the HTTP Listener which should be used for this Routing Rule.

property id

id: string;

The ID of the Rewrite Rule Set

property name

name: string;

The Name of this Request Routing Rule.

property redirectConfigurationId

redirectConfigurationId: string;

The ID of the associated Redirect Configuration.

property redirectConfigurationName

redirectConfigurationName?: undefined | string;

The Name of the Redirect Configuration which should be used for this Routing Rule. Cannot be set if either backendAddressPoolName or backendHttpSettingsName is set.

property rewriteRuleSetId

rewriteRuleSetId: string;

The ID of the associated Rewrite Rule Set.

property rewriteRuleSetName

rewriteRuleSetName?: undefined | string;

The Name of the Rewrite Rule Set which should be used for this Routing Rule. Only valid for v2 SKUs.

property ruleType

ruleType: string;

The Type of Routing that should be used for this Rule. Possible values are Basic and PathBasedRouting.

property urlPathMapId

urlPathMapId: string;

The ID of the associated URL Path Map.

property urlPathMapName

urlPathMapName?: undefined | string;

The Name of the URL Path Map which should be associated with this Routing Rule.

interface ApplicationGatewayRewriteRuleSet

interface ApplicationGatewayRewriteRuleSet

property id

id: string;

The ID of the Rewrite Rule Set

property name

name: string;

Unique name of the rewrite rule set block

property rewriteRules

rewriteRules?: ApplicationGatewayRewriteRuleSetRewriteRule[];

One or more rewriteRule blocks as defined above.

interface ApplicationGatewayRewriteRuleSetRewriteRule

interface ApplicationGatewayRewriteRuleSetRewriteRule

property conditions

conditions?: ApplicationGatewayRewriteRuleSetRewriteRuleCondition[];

One or more condition blocks as defined above.

property name

name: string;

Unique name of the rewrite rule block

property requestHeaderConfigurations

requestHeaderConfigurations?: ApplicationGatewayRewriteRuleSetRewriteRuleRequestHeaderConfiguration[];

One or more requestHeaderConfiguration blocks as defined above.

property responseHeaderConfigurations

responseHeaderConfigurations?: ApplicationGatewayRewriteRuleSetRewriteRuleResponseHeaderConfiguration[];

One or more responseHeaderConfiguration blocks as defined above.

property ruleSequence

ruleSequence: number;

Rule sequence of the rewrite rule that determines the order of execution in a set.

interface ApplicationGatewayRewriteRuleSetRewriteRuleCondition

interface ApplicationGatewayRewriteRuleSetRewriteRuleCondition

property ignoreCase

ignoreCase?: undefined | false | true;

Perform a case in-sensitive comparison. Defaults to false

property negate

negate?: undefined | false | true;

Negate the result of the condition evaluation. Defaults to false

property pattern

pattern: string;

The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition.

property variable

variable: string;

The variable of the condition.

interface ApplicationGatewayRewriteRuleSetRewriteRuleRequestHeaderConfiguration

interface ApplicationGatewayRewriteRuleSetRewriteRuleRequestHeaderConfiguration

property headerName

headerName: string;

Header name of the header configuration.

property headerValue

headerValue: string;

Header value of the header configuration. To delete a request header set this property to an empty string.

interface ApplicationGatewayRewriteRuleSetRewriteRuleResponseHeaderConfiguration

interface ApplicationGatewayRewriteRuleSetRewriteRuleResponseHeaderConfiguration

property headerName

headerName: string;

Header name of the header configuration.

property headerValue

headerValue: string;

Header value of the header configuration. To delete a response header set this property to an empty string.

interface ApplicationGatewaySku

interface ApplicationGatewaySku

property capacity

capacity?: undefined | number;

The Capacity of the SKU to use for this Application Gateway. When using a V1 SKU this value must be between 1 and 32, and 1 to 125 for a V2 SKU. This property is optional if autoscaleConfiguration is set.

property name

name: string;

The Name of the SKU to use for this Application Gateway. Possible values are Standard_Small, Standard_Medium, Standard_Large, Standard_v2, WAF_Medium, WAF_Large, and WAF_v2.

property tier

tier: string;

The Tier of the SKU to use for this Application Gateway. Possible values are Standard, Standard_v2, WAF and WAF_v2.

interface ApplicationGatewaySslCertificate

interface ApplicationGatewaySslCertificate

property data

data?: undefined | string;

PFX certificate. Required if keyVaultSecretId is not set.

property id

id: string;

The ID of the Rewrite Rule Set

property keyVaultSecretId

keyVaultSecretId?: undefined | string;

Secret Id of (base-64 encoded unencrypted pfx) Secret or Certificate object stored in Azure KeyVault. You need to enable soft delete for keyvault to use this feature. Required if data is not set.

property name

name: string;

The Name of the SSL certificate that is unique within this Application Gateway

property password

password?: undefined | string;

Password for the pfx file specified in data. Required if data is set.

property publicCertData

publicCertData: string;

The Public Certificate Data associated with the SSL Certificate.

interface ApplicationGatewaySslPolicy

interface ApplicationGatewaySslPolicy

property cipherSuites

cipherSuites?: string[];

A List of accepted cipher suites. Possible values are: TLS_DHE_DSS_WITH_AES_128_CBC_SHA, TLS_DHE_DSS_WITH_AES_128_CBC_SHA256, TLS_DHE_DSS_WITH_AES_256_CBC_SHA, TLS_DHE_DSS_WITH_AES_256_CBC_SHA256, TLS_DHE_RSA_WITH_AES_128_CBC_SHA, TLS_DHE_RSA_WITH_AES_128_GCM_SHA256, TLS_DHE_RSA_WITH_AES_256_CBC_SHA, TLS_DHE_RSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384, TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA, TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384, TLS_RSA_WITH_3DES_EDE_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA, TLS_RSA_WITH_AES_128_CBC_SHA256, TLS_RSA_WITH_AES_128_GCM_SHA256, TLS_RSA_WITH_AES_256_CBC_SHA, TLS_RSA_WITH_AES_256_CBC_SHA256 and TLS_RSA_WITH_AES_256_GCM_SHA384.

property disabledProtocols

disabledProtocols?: string[];

A list of SSL Protocols which should be disabled on this Application Gateway. Possible values are TLSv1_0, TLSv1_1 and TLSv1_2.

property minProtocolVersion

minProtocolVersion?: undefined | string;

The minimal TLS version. Possible values are TLSv1_0, TLSv1_1 and TLSv1_2.

property policyName

policyName?: undefined | string;

The Name of the Policy e.g AppGwSslPolicy20170401S. Required if policyType is set to Predefined. Possible values can change over time and are published here https://docs.microsoft.com/en-us/azure/application-gateway/application-gateway-ssl-policy-overview. Not compatible with disabledProtocols.

property policyType

policyType?: undefined | string;

The Type of the Policy. Possible values are Predefined and Custom.

interface ApplicationGatewayTrustedRootCertificate

interface ApplicationGatewayTrustedRootCertificate

property data

data: string;

The contents of the Trusted Root Certificate which should be used.

property id

id: string;

The ID of the Rewrite Rule Set

property name

name: string;

The Name of the Trusted Root Certificate to use.

interface ApplicationGatewayUrlPathMap

interface ApplicationGatewayUrlPathMap

property defaultBackendAddressPoolId

defaultBackendAddressPoolId: string;

The ID of the Default Backend Address Pool.

property defaultBackendAddressPoolName

defaultBackendAddressPoolName?: undefined | string;

The Name of the Default Backend Address Pool which should be used for this URL Path Map. Cannot be set if defaultRedirectConfigurationName is set.

property defaultBackendHttpSettingsId

defaultBackendHttpSettingsId: string;

The ID of the Default Backend HTTP Settings Collection.

property defaultBackendHttpSettingsName

defaultBackendHttpSettingsName?: undefined | string;

The Name of the Default Backend HTTP Settings Collection which should be used for this URL Path Map. Cannot be set if defaultRedirectConfigurationName is set.

property defaultRedirectConfigurationId

defaultRedirectConfigurationId: string;

The ID of the Default Redirect Configuration.

property defaultRedirectConfigurationName

defaultRedirectConfigurationName?: undefined | string;

The Name of the Default Redirect Configuration which should be used for this URL Path Map. Cannot be set if either defaultBackendAddressPoolName or defaultBackendHttpSettingsName is set.

property defaultRewriteRuleSetId

defaultRewriteRuleSetId: string;

property defaultRewriteRuleSetName

defaultRewriteRuleSetName?: undefined | string;

The Name of the Default Rewrite Rule Set which should be used for this URL Path Map. Only valid for v2 SKUs.

property id

id: string;

The ID of the Rewrite Rule Set

property name

name: string;

The Name of the URL Path Map.

property pathRules

pathRules: ApplicationGatewayUrlPathMapPathRule[];

One or more pathRule blocks as defined above.

interface ApplicationGatewayUrlPathMapPathRule

interface ApplicationGatewayUrlPathMapPathRule

property backendAddressPoolId

backendAddressPoolId: string;

The ID of the associated Backend Address Pool.

property backendAddressPoolName

backendAddressPoolName?: undefined | string;

The Name of the Backend Address Pool to use for this Path Rule. Cannot be set if redirectConfigurationName is set.

property backendHttpSettingsId

backendHttpSettingsId: string;

The ID of the associated Backend HTTP Settings Configuration.

property backendHttpSettingsName

backendHttpSettingsName?: undefined | string;

The Name of the Backend HTTP Settings Collection to use for this Path Rule. Cannot be set if redirectConfigurationName is set.

property id

id: string;

The ID of the Rewrite Rule Set

property name

name: string;

The Name of the Path Rule.

property paths

paths: string[];

A list of Paths used in this Path Rule.

property redirectConfigurationId

redirectConfigurationId: string;

The ID of the associated Redirect Configuration.

property redirectConfigurationName

redirectConfigurationName?: undefined | string;

The Name of a Redirect Configuration to use for this Path Rule. Cannot be set if backendAddressPoolName or backendHttpSettingsName is set.

property rewriteRuleSetId

rewriteRuleSetId: string;

The ID of the associated Rewrite Rule Set.

property rewriteRuleSetName

rewriteRuleSetName?: undefined | string;

The Name of the Rewrite Rule Set which should be used for this URL Path Map. Only valid for v2 SKUs.

interface ApplicationGatewayWafConfiguration

interface ApplicationGatewayWafConfiguration

property disabledRuleGroups

disabledRuleGroups?: ApplicationGatewayWafConfigurationDisabledRuleGroup[];

one or more disabledRuleGroup blocks as defined below.

property enabled

enabled: boolean;

Is the Web Application Firewall be enabled?

property exclusions

exclusions?: ApplicationGatewayWafConfigurationExclusion[];

one or more exclusion blocks as defined below.

property fileUploadLimitMb

fileUploadLimitMb?: undefined | number;

The File Upload Limit in MB. Accepted values are in the range 1MB to 500MB. Defaults to 100MB.

property firewallMode

firewallMode: string;

The Web Application Firewall Mode. Possible values are Detection and Prevention.

property maxRequestBodySizeKb

maxRequestBodySizeKb?: undefined | number;

The Maximum Request Body Size in KB. Accepted values are in the range 1KB to 128KB. Defaults to 128KB.

property requestBodyCheck

requestBodyCheck?: undefined | false | true;

Is Request Body Inspection enabled? Defaults to true.

property ruleSetType

ruleSetType?: undefined | string;

The Type of the Rule Set used for this Web Application Firewall. Currently, only OWASP is supported.

property ruleSetVersion

ruleSetVersion: string;

The Version of the Rule Set used for this Web Application Firewall. Possible values are 2.2.9, 3.0, and 3.1.

interface ApplicationGatewayWafConfigurationDisabledRuleGroup

interface ApplicationGatewayWafConfigurationDisabledRuleGroup

property ruleGroupName

ruleGroupName: string;

The rule group where specific rules should be disabled. Accepted values are: crs20ProtocolViolations, crs21ProtocolAnomalies, crs23RequestLimits, crs30HttpPolicy, crs35BadRobots, crs40GenericAttacks, crs41SqlInjectionAttacks, crs41XssAttacks, crs42TightSecurity, crs45Trojans, General, REQUEST-911-METHOD-ENFORCEMENT, REQUEST-913-SCANNER-DETECTION, REQUEST-920-PROTOCOL-ENFORCEMENT, REQUEST-921-PROTOCOL-ATTACK, REQUEST-930-APPLICATION-ATTACK-LFI, REQUEST-931-APPLICATION-ATTACK-RFI, REQUEST-932-APPLICATION-ATTACK-RCE, REQUEST-933-APPLICATION-ATTACK-PHP, REQUEST-941-APPLICATION-ATTACK-XSS, REQUEST-942-APPLICATION-ATTACK-SQLI, REQUEST-943-APPLICATION-ATTACK-SESSION-FIXATION

property rules

rules?: number[];

A list of rules which should be disabled in that group. Disables all rules in the specified group if rules is not specified.

interface ApplicationGatewayWafConfigurationExclusion

interface ApplicationGatewayWafConfigurationExclusion

property matchVariable

matchVariable: string;

Match variable of the exclusion rule to exclude header, cookie or GET arguments. Possible values are RequestHeaderNames, RequestArgNames and RequestCookieNames

property selector

selector?: undefined | string;

String value which will be used for the filter operation. If empty will exclude all traffic on this matchVariable

property selectorMatchOperator

selectorMatchOperator?: undefined | string;

Operator which will be used to search in the variable content. Possible values are Equals, StartsWith, EndsWith, Contains. If empty will exclude all traffic on this matchVariable

interface ExpressRouteCircuitPeeringMicrosoftPeeringConfig

interface ExpressRouteCircuitPeeringMicrosoftPeeringConfig

property advertisedPublicPrefixes

advertisedPublicPrefixes: string[];

A list of Advertised Public Prefixes

property customerAsn

customerAsn?: undefined | number;

The CustomerASN of the peering

property routingRegistryName

routingRegistryName?: undefined | string;

The RoutingRegistryName of the configuration

interface ExpressRouteCircuitSku

interface ExpressRouteCircuitSku

property family

family: string;

The billing mode for bandwidth. Possible values are MeteredData or UnlimitedData.

property tier

tier: string;

The service tier. Possible values are Basic, Local, Standard or Premium.

interface FirewallApplicationRuleCollectionRule

interface FirewallApplicationRuleCollectionRule

property description

description?: undefined | string;

Specifies a description for the rule.

property fqdnTags

fqdnTags?: string[];

A list of FQDN tags. Possible values are AppServiceEnvironment, AzureBackup, MicrosoftActiveProtectionService, WindowsDiagnostics and WindowsUpdate

property name

name: string;

Specifies the name of the rule.

property protocols

protocols?: FirewallApplicationRuleCollectionRuleProtocol[];

One or more protocol blocks as defined below.

property sourceAddresses

sourceAddresses: string[];

A list of source IP addresses and/or IP ranges.

property targetFqdns

targetFqdns?: string[];

A list of FQDNs.

interface FirewallApplicationRuleCollectionRuleProtocol

interface FirewallApplicationRuleCollectionRuleProtocol

property port

port?: undefined | number;

Specify a port for the connection.

property type

type: string;

Specifies the type of connection. Possible values are Http, Https and Mssql.

interface FirewallIpConfiguration

interface FirewallIpConfiguration

property name

name: string;

Specifies the name of the IP Configuration.

property privateIpAddress

privateIpAddress: string;

The private IP address of the Azure Firewall.

property publicIpAddressId

publicIpAddressId: string;

The Resource ID of the Public IP Address associated with the firewall.

property subnetId

subnetId?: undefined | string;

Reference to the subnet associated with the IP Configuration.

interface FirewallNatRuleCollectionRule

interface FirewallNatRuleCollectionRule

property description

description?: undefined | string;

Specifies a description for the rule.

property destinationAddresses

destinationAddresses: string[];

A list of destination IP addresses and/or IP ranges.

property destinationPorts

destinationPorts: string[];

A list of destination ports.

property name

name: string;

Specifies the name of the rule.

property protocols

protocols: string[];

A list of protocols. Possible values are Any, ICMP, TCP and UDP. If action is Dnat, protocols can only be TCP and UDP.

property sourceAddresses

sourceAddresses: string[];

A list of source IP addresses and/or IP ranges.

property translatedAddress

translatedAddress: string;

The address of the service behind the Firewall.

property translatedPort

translatedPort: string;

The port of the service behind the Firewall.

interface FirewallNetworkRuleCollectionRule

interface FirewallNetworkRuleCollectionRule

property description

description?: undefined | string;

Specifies a description for the rule.

property destinationAddresses

destinationAddresses: string[];

A list of destination IP addresses and/or IP ranges.

property destinationPorts

destinationPorts: string[];

A list of destination ports.

property name

name: string;

Specifies the name of the rule.

property protocols

protocols: string[];

A list of protocols. Possible values are Any, ICMP, TCP and UDP.

property sourceAddresses

sourceAddresses: string[];

A list of source IP addresses and/or IP ranges.

interface GetExpressRouteCircuitPeering

interface GetExpressRouteCircuitPeering

property azureAsn

azureAsn: number;

The Either a 16-bit or a 32-bit ASN for Azure.

property peerAsn

peerAsn: number;

The Either a 16-bit or a 32-bit ASN. Can either be public or private.

property peeringType

peeringType: string;

The type of the ExpressRoute Circuit Peering. Acceptable values include AzurePrivatePeering, AzurePublicPeering and MicrosoftPeering. Changing this forces a new resource to be created.

property primaryPeerAddressPrefix

primaryPeerAddressPrefix: string;

A /30 subnet for the primary link.

property secondaryPeerAddressPrefix

secondaryPeerAddressPrefix: string;

A /30 subnet for the secondary link.

property sharedKey

sharedKey: string;

The shared key. Can be a maximum of 25 characters.

property vlanId

vlanId: number;

A valid VLAN ID to establish this peering on.

interface GetExpressRouteCircuitServiceProviderProperty

interface GetExpressRouteCircuitServiceProviderProperty

property bandwidthInMbps

bandwidthInMbps: number;

The bandwidth in Mbps of the ExpressRoute circuit.

property peeringLocation

peeringLocation: string;

The name of the peering location and not the Azure resource location.

property serviceProviderName

serviceProviderName: string;

The name of the ExpressRoute Service Provider.

interface GetExpressRouteCircuitSku

interface GetExpressRouteCircuitSku

property family

family: string;

The billing mode for bandwidth. Possible values are MeteredData or UnlimitedData.

property tier

tier: string;

The service tier. Possible values are Basic, Local, Standard or Premium.

interface GetFirewallIpConfiguration

interface GetFirewallIpConfiguration

property internalPublicIpAddressId

internalPublicIpAddressId: string;

property name

name: string;

The name of the Azure Firewall.

property privateIpAddress

privateIpAddress: string;

The private IP address of the Azure Firewall.

property publicIpAddressId

publicIpAddressId: string;

property subnetId

subnetId: string;

The Resource ID of the subnet where the Azure Firewall is deployed.

interface GetGatewayConnectionIpsecPolicy

interface GetGatewayConnectionIpsecPolicy

property dhGroup

dhGroup: string;

The DH group used in IKE phase 1 for initial SA. Valid options are DHGroup1, DHGroup14, DHGroup2, DHGroup2048, DHGroup24, ECP256, ECP384, or None.

property ikeEncryption

ikeEncryption: string;

The IKE encryption algorithm. Valid options are AES128, AES192, AES256, DES, or DES3.

property ikeIntegrity

ikeIntegrity: string;

The IKE integrity algorithm. Valid options are MD5, SHA1, SHA256, or SHA384.

property ipsecEncryption

ipsecEncryption: string;

The IPSec encryption algorithm. Valid options are AES128, AES192, AES256, DES, DES3, GCMAES128, GCMAES192, GCMAES256, or None.

property ipsecIntegrity

ipsecIntegrity: string;

The IPSec integrity algorithm. Valid options are GCMAES128, GCMAES192, GCMAES256, MD5, SHA1, or SHA256.

property pfsGroup

pfsGroup: string;

The DH group used in IKE phase 2 for new child SA. Valid options are ECP256, ECP384, PFS1, PFS2, PFS2048, PFS24, or None.

property saDatasize

saDatasize: number;

The IPSec SA payload size in KB. Must be at least 1024 KB.

property saLifetime

saLifetime: number;

The IPSec SA lifetime in seconds. Must be at least 300 seconds.

interface GetNetworkInterfaceIpConfiguration

interface GetNetworkInterfaceIpConfiguration

property applicationGatewayBackendAddressPoolsIds

applicationGatewayBackendAddressPoolsIds: string[];

A list of Backend Address Pool ID’s within a Application Gateway that this Network Interface is connected to.

property applicationSecurityGroupIds

applicationSecurityGroupIds: string[];

property loadBalancerBackendAddressPoolsIds

loadBalancerBackendAddressPoolsIds: string[];

A list of Backend Address Pool ID’s within a Load Balancer that this Network Interface is connected to.

property loadBalancerInboundNatRulesIds

loadBalancerInboundNatRulesIds: string[];

A list of Inbound NAT Rule ID’s within a Load Balancer that this Network Interface is connected to.

property name

name: string;

Specifies the name of the Network Interface.

property primary

primary: boolean;

is this the Primary IP Configuration for this Network Interface?

property privateIpAddress

privateIpAddress: string;

The Private IP Address assigned to this Network Interface.

property privateIpAddressAllocation

privateIpAddressAllocation: string;

The IP Address allocation type for the Private address, such as Dynamic or Static.

property privateIpAddressVersion

privateIpAddressVersion: string;

property publicIpAddressId

publicIpAddressId: string;

The ID of the Public IP Address which is connected to this Network Interface.

property subnetId

subnetId: string;

The ID of the Subnet which the Network Interface is connected to.

interface GetNetworkSecurityGroupSecurityRule

interface GetNetworkSecurityGroupSecurityRule

property access

access: string;

Is network traffic is allowed or denied?

property description

description: string;

The description for this rule.

property destinationAddressPrefix

destinationAddressPrefix: string;

CIDR or destination IP range or * to match any IP.

property destinationAddressPrefixes

destinationAddressPrefixes: string[];

A list of CIDRs or destination IP ranges.

property destinationApplicationSecurityGroupIds

destinationApplicationSecurityGroupIds?: string[];

A List of destination Application Security Group ID’s

property destinationPortRange

destinationPortRange: string;

The Destination Port or Range.

property destinationPortRanges

destinationPortRanges: string[];

property direction

direction: string;

The direction specifies if rule will be evaluated on incoming or outgoing traffic.

property name

name: string;

Specifies the Name of the Network Security Group.

property priority

priority: number;

The priority of the rule

property protocol

protocol: string;

The network protocol this rule applies to.

property sourceAddressPrefix

sourceAddressPrefix: string;

CIDR or source IP range or * to match any IP.

property sourceAddressPrefixes

sourceAddressPrefixes: string[];

A list of CIDRs or source IP ranges.

property sourceApplicationSecurityGroupIds

sourceApplicationSecurityGroupIds?: string[];

A List of source Application Security Group ID’s

property sourcePortRange

sourcePortRange: string;

The Source Port or Range.

property sourcePortRanges

sourcePortRanges: string[];

interface GetPublicIPsPublicIp

interface GetPublicIPsPublicIp

property domainNameLabel

domainNameLabel: string;

The Domain Name Label of the Public IP Address

property fqdn

fqdn: string;

The FQDN of the Public IP Address

property id

id: string;

The ID of the Public IP Address

property ipAddress

ipAddress: string;

property name

name: string;

The Name of the Public IP Address

interface GetRouteTableRoute

interface GetRouteTableRoute

property addressPrefix

addressPrefix: string;

The destination CIDR to which the route applies.

property name

name: string;

The name of the Route Table.

property nextHopInIpAddress

nextHopInIpAddress: string;

Contains the IP address packets should be forwarded to.

property nextHopType

nextHopType: string;

The type of Azure hop the packet should be sent to.

interface GetVirtualNetworkGatewayBgpSetting

interface GetVirtualNetworkGatewayBgpSetting

property asn

asn: number;

The Autonomous System Number (ASN) to use as part of the BGP.

property peerWeight

peerWeight: number;

The weight added to routes which have been learned through BGP peering.

property peeringAddress

peeringAddress: string;

The BGP peer IP address of the virtual network gateway. This address is needed to configure the created gateway as a BGP Peer on the on-premises VPN devices.

interface GetVirtualNetworkGatewayIpConfiguration

interface GetVirtualNetworkGatewayIpConfiguration

property name

name: string;

Specifies the name of the Virtual Network Gateway.

property privateIpAddressAllocation

privateIpAddressAllocation: string;

Defines how the private IP address of the gateways virtual interface is assigned.

property publicIpAddressId

publicIpAddressId: string;

The ID of the Public IP Address associated with the Virtual Network Gateway.

property subnetId

subnetId: string;

The ID of the gateway subnet of a virtual network in which the virtual network gateway will be created. It is mandatory that the associated subnet is named GatewaySubnet. Therefore, each virtual network can contain at most a single Virtual Network Gateway.

interface GetVirtualNetworkGatewayVpnClientConfiguration

interface GetVirtualNetworkGatewayVpnClientConfiguration

property addressSpaces

addressSpaces: string[];

The address space out of which ip addresses for vpn clients will be taken. You can provide more than one address space, e.g. in CIDR notation.

property radiusServerAddress

radiusServerAddress: string;

The address of the Radius server. This setting is incompatible with the use of rootCertificate and revokedCertificate.

property radiusServerSecret

radiusServerSecret: string;

The secret used by the Radius server. This setting is incompatible with the use of rootCertificate and revokedCertificate.

property revokedCertificates

revokedCertificates: GetVirtualNetworkGatewayVpnClientConfigurationRevokedCertificate[];

One or more revokedCertificate blocks which are defined below.

property rootCertificates

rootCertificates: GetVirtualNetworkGatewayVpnClientConfigurationRootCertificate[];

One or more rootCertificate blocks which are defined below. These root certificates are used to sign the client certificate used by the VPN clients to connect to the gateway.

property vpnClientProtocols

vpnClientProtocols: string[];

List of the protocols supported by the vpn client. The supported values are SSTP, IkeV2 and OpenVPN.

interface GetVirtualNetworkGatewayVpnClientConfigurationRevokedCertificate

interface GetVirtualNetworkGatewayVpnClientConfigurationRevokedCertificate

property name

name: string;

Specifies the name of the Virtual Network Gateway.

property thumbprint

thumbprint: string;

interface GetVirtualNetworkGatewayVpnClientConfigurationRootCertificate

interface GetVirtualNetworkGatewayVpnClientConfigurationRootCertificate

property name

name: string;

Specifies the name of the Virtual Network Gateway.

property publicCertData

publicCertData: string;

The SHA1 thumbprint of the certificate to be revoked.

interface LocalNetworkGatewayBgpSettings

interface LocalNetworkGatewayBgpSettings

property asn

asn: number;

The BGP speaker’s ASN.

property bgpPeeringAddress

bgpPeeringAddress: string;

The BGP peering address and BGP identifier of this BGP speaker.

property peerWeight

peerWeight: number;

The weight added to routes learned from this BGP speaker.

interface NetworkConnectionMonitorDestination

interface NetworkConnectionMonitorDestination

property address

address?: undefined | string;

IP address or domain name to monitor connectivity to.

property port

port: number;

The port on the destination to monitor connectivity to.

property virtualMachineId

virtualMachineId?: undefined | string;

The ID of the Virtual Machine to monitor connectivity to.

interface NetworkConnectionMonitorSource

interface NetworkConnectionMonitorSource

property port

port?: undefined | number;

The port on the destination to monitor connectivity to.

property virtualMachineId

virtualMachineId: string;

The ID of the Virtual Machine to monitor connectivity to.

interface NetworkInterfaceIpConfiguration

interface NetworkInterfaceIpConfiguration

property name

name: string;

A name used for this IP Configuration.

property primary

primary: boolean;

Is this the Primary IP Configuration? Must be true for the first ipConfiguration when multiple are specified. Defaults to false.

property privateIpAddress

privateIpAddress: string;

The Static IP Address which should be used.

property privateIpAddressAllocation

privateIpAddressAllocation: string;

The allocation method used for the Private IP Address. Possible values are Dynamic and Static.

property privateIpAddressVersion

privateIpAddressVersion?: undefined | string;

The IP Version to use. Possible values are IPv4 or IPv6. Defaults to IPv4.

property publicIpAddressId

publicIpAddressId?: undefined | string;

Reference to a Public IP Address to associate with this NIC

property subnetId

subnetId?: undefined | string;

The ID of the Subnet where this Network Interface should be located in.

interface NetworkPacketCaptureFilter

interface NetworkPacketCaptureFilter

property localIpAddress

localIpAddress?: undefined | string;

The local IP Address to be filtered on. Notation: “127.0.0.1” for single address entry. “127.0.0.1-127.0.0.255” for range. “127.0.0.1;127.0.0.5” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Changing this forces a new resource to be created.

property localPort

localPort?: undefined | string;

The local port to be filtered on. Notation: “80” for single port entry.“80-85” for range. “80;443;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Changing this forces a new resource to be created.

property protocol

protocol: string;

The Protocol to be filtered on. Possible values include Any, TCP and UDP. Changing this forces a new resource to be created.

property remoteIpAddress

remoteIpAddress?: undefined | string;

The remote IP Address to be filtered on. Notation: “127.0.0.1” for single address entry. “127.0.0.1-127.0.0.255” for range. “127.0.0.1;127.0.0.5;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported.. Changing this forces a new resource to be created.

property remotePort

remotePort?: undefined | string;

The remote port to be filtered on. Notation: “80” for single port entry.“80-85” for range. “80;443;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Changing this forces a new resource to be created.

interface NetworkPacketCaptureStorageLocation

interface NetworkPacketCaptureStorageLocation

property filePath

filePath?: undefined | string;

A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures.

property storageAccountId

storageAccountId?: undefined | string;

The ID of the storage account to save the packet capture session

property storagePath

storagePath: string;

The URI of the storage path to save the packet capture.

interface NetworkSecurityGroupSecurityRule

interface NetworkSecurityGroupSecurityRule

property access

access: string;

Specifies whether network traffic is allowed or denied. Possible values are Allow and Deny.

property description

description?: undefined | string;

A description for this rule. Restricted to 140 characters.

property destinationAddressPrefix

destinationAddressPrefix?: undefined | string;

CIDR or destination IP range or * to match any IP. Tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. This is required if destinationAddressPrefixes is not specified.

property destinationAddressPrefixes

destinationAddressPrefixes?: string[];

List of destination address prefixes. Tags may not be used. This is required if destinationAddressPrefix is not specified.

property destinationApplicationSecurityGroupIds

destinationApplicationSecurityGroupIds?: string[];

A List of destination Application Security Group ID’s

property destinationPortRange

destinationPortRange?: undefined | string;

Destination Port or Range. Integer or range between 0 and 65535 or * to match any. This is required if destinationPortRanges is not specified.

property destinationPortRanges

destinationPortRanges?: string[];

List of destination ports or port ranges. This is required if destinationPortRange is not specified.

property direction

direction: string;

The direction specifies if rule will be evaluated on incoming or outgoing traffic. Possible values are Inbound and Outbound.

property name

name: string;

The name of the security rule.

property priority

priority: number;

Specifies the priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule.

property protocol

protocol: string;

Network protocol this rule applies to. Can be Tcp, Udp, Icmp, or * to match all.

property sourceAddressPrefix

sourceAddressPrefix?: undefined | string;

CIDR or source IP range or * to match any IP. Tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. This is required if sourceAddressPrefixes is not specified.

property sourceAddressPrefixes

sourceAddressPrefixes?: string[];

List of source address prefixes. Tags may not be used. This is required if sourceAddressPrefix is not specified.

property sourceApplicationSecurityGroupIds

sourceApplicationSecurityGroupIds?: string[];

A List of source Application Security Group ID’s

property sourcePortRange

sourcePortRange?: undefined | string;

Source Port or Range. Integer or range between 0 and 65535 or * to match any. This is required if sourcePortRanges is not specified.

property sourcePortRanges

sourcePortRanges?: string[];

List of source ports or port ranges. This is required if sourcePortRange is not specified.

interface NetworkWatcherFlowLogRetentionPolicy

interface NetworkWatcherFlowLogRetentionPolicy

property days

days: number;

The number of days to retain flow log records.

property enabled

enabled: boolean;

Boolean flag to enable/disable traffic analytics.

interface NetworkWatcherFlowLogTrafficAnalytics

interface NetworkWatcherFlowLogTrafficAnalytics

property enabled

enabled: boolean;

Boolean flag to enable/disable traffic analytics.

property intervalInMinutes

intervalInMinutes?: undefined | number;

How frequently service should do flow analytics in minutes.

property workspaceId

workspaceId: string;

The resource guid of the attached workspace.

property workspaceRegion

workspaceRegion: string;

The location of the attached workspace.

property workspaceResourceId

workspaceResourceId: string;

The resource ID of the attached workspace.

interface PacketCaptureFilter

interface PacketCaptureFilter

property localIpAddress

localIpAddress?: undefined | string;

The local IP Address to be filtered on. Notation: “127.0.0.1” for single address entry. “127.0.0.1-127.0.0.255” for range. “127.0.0.1;127.0.0.5” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Changing this forces a new resource to be created.

property localPort

localPort?: undefined | string;

The local port to be filtered on. Notation: “80” for single port entry.“80-85” for range. “80;443;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Changing this forces a new resource to be created.

property protocol

protocol: string;

The Protocol to be filtered on. Possible values include Any, TCP and UDP. Changing this forces a new resource to be created.

property remoteIpAddress

remoteIpAddress?: undefined | string;

The remote IP Address to be filtered on. Notation: “127.0.0.1” for single address entry. “127.0.0.1-127.0.0.255” for range. “127.0.0.1;127.0.0.5;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported.. Changing this forces a new resource to be created.

property remotePort

remotePort?: undefined | string;

The remote port to be filtered on. Notation: “80” for single port entry.“80-85” for range. “80;443;” for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Changing this forces a new resource to be created.

interface PacketCaptureStorageLocation

interface PacketCaptureStorageLocation

property filePath

filePath?: undefined | string;

A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures.

property storageAccountId

storageAccountId?: undefined | string;

The ID of the storage account to save the packet capture session

property storagePath

storagePath: string;

The URI of the storage path to save the packet capture.

interface PointToPointVpnGatewayConnectionConfiguration

interface PointToPointVpnGatewayConnectionConfiguration

property name

name: string;

The Name which should be used for this Connection Configuration.

property vpnClientAddressPool

vpnClientAddressPool: PointToPointVpnGatewayConnectionConfigurationVpnClientAddressPool;

A vpnClientAddressPool block as defined below.

interface PointToPointVpnGatewayConnectionConfigurationVpnClientAddressPool

interface PointToPointVpnGatewayConnectionConfigurationVpnClientAddressPool

property addressPrefixes

addressPrefixes: string[];

A list of CIDR Ranges which should be used as Address Prefixes.

interface ProfileContainerNetworkInterface

interface ProfileContainerNetworkInterface

property ipConfigurations

ipConfigurations: ProfileContainerNetworkInterfaceIpConfiguration[];

One or more ipConfiguration blocks as documented below.

property name

name: string;

Specifies the name of the IP Configuration.

interface ProfileContainerNetworkInterfaceIpConfiguration

interface ProfileContainerNetworkInterfaceIpConfiguration

property name

name: string;

Specifies the name of the IP Configuration.

property subnetId

subnetId: string;

Reference to the subnet associated with the IP Configuration.

interface RouteTableRoute

interface RouteTableRoute

property addressPrefix

addressPrefix: string;

The destination CIDR to which the route applies, such as 10.1.0.0/16

property name

name: string;

The name of the route.

property nextHopInIpAddress

nextHopInIpAddress?: undefined | string;

Contains the IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.

property nextHopType

nextHopType: string;

The type of Azure hop the packet should be sent to. Possible values are VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance and None.

interface SubnetDelegation

interface SubnetDelegation

property name

name: string;

A name for this delegation.

property serviceDelegation

serviceDelegation: SubnetDelegationServiceDelegation;

A serviceDelegation block as defined below.

interface SubnetDelegationServiceDelegation

interface SubnetDelegationServiceDelegation

property actions

actions?: string[];

A list of Actions which should be delegated. This list is specific to the service to delegate to. Possible values include Microsoft.Network/networkinterfaces/*, Microsoft.Network/virtualNetworks/subnets/action, Microsoft.Network/virtualNetworks/subnets/join/action, Microsoft.Network/virtualNetworks/subnets/prepareNetworkPolicies/action and Microsoft.Network/virtualNetworks/subnets/unprepareNetworkPolicies/action.

property name

name: string;

The name of service to delegate to. Possible values include Microsoft.BareMetal/AzureVMware, Microsoft.BareMetal/CrayServers, Microsoft.Batch/batchAccounts, Microsoft.ContainerInstance/containerGroups, Microsoft.Databricks/workspaces, Microsoft.DBforPostgreSQL/serversv2, Microsoft.HardwareSecurityModules/dedicatedHSMs, Microsoft.Logic/integrationServiceEnvironments, Microsoft.Netapp/volumes, Microsoft.ServiceFabricMesh/networks, Microsoft.Sql/managedInstances, Microsoft.Sql/servers, Microsoft.StreamAnalytics/streamingJobs, Microsoft.Web/hostingEnvironments and Microsoft.Web/serverFarms.

interface TrafficManagerEndpointCustomHeader

interface TrafficManagerEndpointCustomHeader

property name

name: string;

The name of the custom header.

property value

value: string;

The value of custom header. Applicable for Http and Https protocol.

interface TrafficManagerEndpointSubnet

interface TrafficManagerEndpointSubnet

property first

first: string;

The First IP….

property last

last?: undefined | string;

The Last IP…

property scope

scope?: undefined | number;

The Scope…

interface TrafficManagerProfileDnsConfig

interface TrafficManagerProfileDnsConfig

property relativeName

relativeName: string;

The relative domain name, this is combined with the domain name used by Traffic Manager to form the FQDN which is exported as documented below. Changing this forces a new resource to be created.

property ttl

ttl: number;

The TTL value of the Profile used by Local DNS resolvers and clients.

interface TrafficManagerProfileMonitorConfig

interface TrafficManagerProfileMonitorConfig

property customHeaders

customHeaders?: TrafficManagerProfileMonitorConfigCustomHeader[];

One or more customHeader blocks as defined below.

property expectedStatusCodeRanges

expectedStatusCodeRanges?: string[];

A list of status code ranges in the format of 100-101.

property intervalInSeconds

intervalInSeconds?: undefined | number;

The interval used to check the endpoint health from a Traffic Manager probing agent. You can specify two values here: 30 (normal probing) and 10 (fast probing). The default value is 30.

property path

path?: undefined | string;

The path used by the monitoring checks. Required when protocol is set to HTTP or HTTPS - cannot be set when protocol is set to TCP.

property port

port: number;

The port number used by the monitoring checks.

property protocol

protocol: string;

The protocol used by the monitoring checks, supported values are HTTP, HTTPS and TCP.

property timeoutInSeconds

timeoutInSeconds?: undefined | number;

The amount of time the Traffic Manager probing agent should wait before considering that check a failure when a health check probe is sent to the endpoint. If intervalInSeconds is set to 30, then timeoutInSeconds can be between 5 and 10. The default value is 10. If intervalInSeconds is set to 10, then valid values are between 5 and 9 and timeoutInSeconds is required.

property toleratedNumberOfFailures

toleratedNumberOfFailures?: undefined | number;

The number of failures a Traffic Manager probing agent tolerates before marking that endpoint as unhealthy. Valid values are between 0 and 9. The default value is 3

interface TrafficManagerProfileMonitorConfigCustomHeader

interface TrafficManagerProfileMonitorConfigCustomHeader

property name

name: string;

The name of the custom header.

property value

value: string;

The value of custom header. Applicable for Http and Https protocol.

interface VirtualHubRoute

interface VirtualHubRoute

property addressPrefixes

addressPrefixes: string[];

A list of Address Prefixes.

property nextHopIpAddress

nextHopIpAddress: string;

The IP Address that Packets should be forwarded to as the Next Hop.

interface VirtualNetworkDdosProtectionPlan

interface VirtualNetworkDdosProtectionPlan

property enable

enable: boolean;

Enable/disable DDoS Protection Plan on Virtual Network.

property id

id: string;

The Resource ID of DDoS Protection Plan.

interface VirtualNetworkGatewayBgpSettings

interface VirtualNetworkGatewayBgpSettings

property asn

asn?: undefined | number;

The Autonomous System Number (ASN) to use as part of the BGP.

property peerWeight

peerWeight?: undefined | number;

The weight added to routes which have been learned through BGP peering. Valid values can be between 0 and 100.

property peeringAddress

peeringAddress: string;

The BGP peer IP address of the virtual network gateway. This address is needed to configure the created gateway as a BGP Peer on the on-premises VPN devices. The IP address must be part of the subnet of the Virtual Network Gateway. Changing this forces a new resource to be created.

interface VirtualNetworkGatewayConnectionIpsecPolicy

interface VirtualNetworkGatewayConnectionIpsecPolicy

property dhGroup

dhGroup: string;

The DH group used in IKE phase 1 for initial SA. Valid options are DHGroup1, DHGroup14, DHGroup2, DHGroup2048, DHGroup24, ECP256, ECP384, or None.

property ikeEncryption

ikeEncryption: string;

The IKE encryption algorithm. Valid options are AES128, AES192, AES256, DES, or DES3.

property ikeIntegrity

ikeIntegrity: string;

The IKE integrity algorithm. Valid options are MD5, SHA1, SHA256, or SHA384.

property ipsecEncryption

ipsecEncryption: string;

The IPSec encryption algorithm. Valid options are AES128, AES192, AES256, DES, DES3, GCMAES128, GCMAES192, GCMAES256, or None.

property ipsecIntegrity

ipsecIntegrity: string;

The IPSec integrity algorithm. Valid options are GCMAES128, GCMAES192, GCMAES256, MD5, SHA1, or SHA256.

property pfsGroup

pfsGroup: string;

The DH group used in IKE phase 2 for new child SA. Valid options are ECP256, ECP384, PFS1, PFS2, PFS2048, PFS24, or None.

property saDatasize

saDatasize: number;

The IPSec SA payload size in KB. Must be at least 1024 KB. Defaults to 102400000 KB.

property saLifetime

saLifetime: number;

The IPSec SA lifetime in seconds. Must be at least 300 seconds. Defaults to 27000 seconds.

interface VirtualNetworkGatewayIpConfiguration

interface VirtualNetworkGatewayIpConfiguration

property name

name?: undefined | string;

A user-defined name of the revoked certificate.

property privateIpAddressAllocation

privateIpAddressAllocation?: undefined | string;

Defines how the private IP address of the gateways virtual interface is assigned. Valid options are Static or Dynamic. Defaults to Dynamic.

property publicIpAddressId

publicIpAddressId: string;

The ID of the public ip address to associate with the Virtual Network Gateway.

property subnetId

subnetId: string;

The ID of the gateway subnet of a virtual network in which the virtual network gateway will be created. It is mandatory that the associated subnet is named GatewaySubnet. Therefore, each virtual network can contain at most a single Virtual Network Gateway.

interface VirtualNetworkGatewayVpnClientConfiguration

interface VirtualNetworkGatewayVpnClientConfiguration

property addressSpaces

addressSpaces: string[];

The address space out of which ip addresses for vpn clients will be taken. You can provide more than one address space, e.g. in CIDR notation.

property radiusServerAddress

radiusServerAddress?: undefined | string;

The address of the Radius server. This setting is incompatible with the use of rootCertificate and revokedCertificate.

property radiusServerSecret

radiusServerSecret?: undefined | string;

The secret used by the Radius server. This setting is incompatible with the use of rootCertificate and revokedCertificate.

property revokedCertificates

revokedCertificates?: VirtualNetworkGatewayVpnClientConfigurationRevokedCertificate[];

One or more revokedCertificate blocks which are defined below. This setting is incompatible with the use of radiusServerAddress and radiusServerSecret.

property rootCertificates

rootCertificates?: VirtualNetworkGatewayVpnClientConfigurationRootCertificate[];

One or more rootCertificate blocks which are defined below. These root certificates are used to sign the client certificate used by the VPN clients to connect to the gateway. This setting is incompatible with the use of radiusServerAddress and radiusServerSecret.

property vpnClientProtocols

vpnClientProtocols: string[];

List of the protocols supported by the vpn client. The supported values are SSTP, IkeV2 and OpenVPN.

interface VirtualNetworkGatewayVpnClientConfigurationRevokedCertificate

interface VirtualNetworkGatewayVpnClientConfigurationRevokedCertificate

property name

name: string;

A user-defined name of the revoked certificate.

property thumbprint

thumbprint: string;

interface VirtualNetworkGatewayVpnClientConfigurationRootCertificate

interface VirtualNetworkGatewayVpnClientConfigurationRootCertificate

property name

name: string;

A user-defined name of the revoked certificate.

property publicCertData

publicCertData: string;

The SHA1 thumbprint of the certificate to be revoked.

interface VirtualNetworkSubnet

interface VirtualNetworkSubnet

property addressPrefix

addressPrefix: string;

The address prefix to use for the subnet.

property id

id: string;

The Resource ID of DDoS Protection Plan.

property name

name: string;

The name of the virtual network. Changing this forces a new resource to be created.

property securityGroup

securityGroup?: undefined | string;

The Network Security Group to associate with the subnet. (Referenced by id, ie. azurerm_network_security_group.example.id)

interface VpnGatewayBgpSetting

interface VpnGatewayBgpSetting

property asn

asn: number;

The ASN of the BGP Speaker. Changing this forces a new resource to be created.

property bgpPeeringAddress

bgpPeeringAddress: string;

The Address which should be used for the BGP Peering.

property peerWeight

peerWeight: number;

The weight added to Routes learned from this BGP Speaker. Changing this forces a new resource to be created.

interface VpnServerConfigurationAzureActiveDirectoryAuthentication

interface VpnServerConfigurationAzureActiveDirectoryAuthentication

property audience

audience: string;

The Audience which should be used for authentication.

property issuer

issuer: string;

The Issuer which should be used for authentication.

property tenant

tenant: string;

The Tenant which should be used for authentication.

interface VpnServerConfigurationClientRevokedCertificate

interface VpnServerConfigurationClientRevokedCertificate

property name

name: string;

A name used to uniquely identify this certificate.

property thumbprint

thumbprint: string;

The Thumbprint of the Certificate.

interface VpnServerConfigurationClientRootCertificate

interface VpnServerConfigurationClientRootCertificate

property name

name: string;

A name used to uniquely identify this certificate.

property publicCertData

publicCertData: string;

The Public Key Data associated with the Certificate.

interface VpnServerConfigurationIpsecPolicy

interface VpnServerConfigurationIpsecPolicy

property dhGroup

dhGroup: string;

The DH Group, used in IKE Phase 1. Possible values include DHGroup1, DHGroup2, DHGroup14, DHGroup24, DHGroup2048, ECP256, ECP384 and None.

property ikeEncryption

ikeEncryption: string;

The IKE encryption algorithm, used for IKE Phase 2. Possible values include AES128, AES192, AES256, DES, DES3, GCMAES128 and GCMAES256.

property ikeIntegrity

ikeIntegrity: string;

The IKE encryption integrity algorithm, used for IKE Phase 2. Possible values include GCMAES128, GCMAES256, MD5, SHA1, SHA256 and SHA384.

property ipsecEncryption

ipsecEncryption: string;

The IPSec encryption algorithm, used for IKE phase 1. Possible values include AES128, AES192, AES256, DES, DES3, GCMAES128, GCMAES192, GCMAES256 and None.

property ipsecIntegrity

ipsecIntegrity: string;

The IPSec integrity algorithm, used for IKE phase 1. Possible values include GCMAES128, GCMAES192, GCMAES256, MD5, SHA1 and SHA256.

property pfsGroup

pfsGroup: string;

The Pfs Group, used in IKE Phase 2. Possible values include ECP256, ECP384, PFS1, PFS2, PFS14, PFS24, PFS2048, PFSMM and None.

property saDataSizeKilobytes

saDataSizeKilobytes: number;

The IPSec Security Association payload size in KB for a Site-to-Site VPN tunnel.

property saLifetimeSeconds

saLifetimeSeconds: number;

The IPSec Security Association lifetime in seconds for a Site-to-Site VPN tunnel.

interface VpnServerConfigurationRadiusServer

interface VpnServerConfigurationRadiusServer

property address

address: string;

The Address of the Radius Server.

property clientRootCertificates

clientRootCertificates?: VpnServerConfigurationRadiusServerClientRootCertificate[];

One or more clientRootCertificate blocks as defined above.

property secret

secret: string;

The Secret used to communicate with the Radius Server.

property serverRootCertificates

serverRootCertificates: VpnServerConfigurationRadiusServerServerRootCertificate[];

One or more serverRootCertificate blocks as defined below.

interface VpnServerConfigurationRadiusServerClientRootCertificate

interface VpnServerConfigurationRadiusServerClientRootCertificate

property name

name: string;

A name used to uniquely identify this certificate.

property thumbprint

thumbprint: string;

The Thumbprint of the Certificate.

interface VpnServerConfigurationRadiusServerServerRootCertificate

interface VpnServerConfigurationRadiusServerServerRootCertificate

property name

name: string;

A name used to uniquely identify this certificate.

property publicCertData

publicCertData: string;

The Public Key Data associated with the Certificate.

namespace notificationhub

interface GetHubApnsCredential

interface GetHubApnsCredential

property applicationMode

applicationMode: string;

The Application Mode which defines which server the APNS Messages should be sent to. Possible values are Production and Sandbox.

property bundleId

bundleId: string;

The Bundle ID of the iOS/macOS application to send push notifications for, such as com.org.example.

property keyId

keyId: string;

The Apple Push Notifications Service (APNS) Key.

property teamId

teamId: string;

The ID of the team the Token.

property token

token: string;

The Push Token associated with the Apple Developer Account.

interface GetHubGcmCredential

interface GetHubGcmCredential

property apiKey

apiKey: string;

The API Key associated with the Google Cloud Messaging service.

interface GetNamespaceSku

interface GetNamespaceSku

property name

name: string;

Specifies the Name of the Notification Hub Namespace.

interface HubApnsCredential

interface HubApnsCredential

property applicationMode

applicationMode: string;

The Application Mode which defines which server the APNS Messages should be sent to. Possible values are Production and Sandbox.

property bundleId

bundleId: string;

The Bundle ID of the iOS/macOS application to send push notifications for, such as com.org.example.

property keyId

keyId: string;

The Apple Push Notifications Service (APNS) Key.

property teamId

teamId: string;

The ID of the team the Token.

property token

token: string;

The Push Token associated with the Apple Developer Account. This is the contents of the key downloaded from the Apple Developer Portal between the -----BEGIN PRIVATE KEY----- and -----END PRIVATE KEY----- blocks.

interface HubGcmCredential

interface HubGcmCredential

property apiKey

apiKey: string;

The API Key associated with the Google Cloud Messaging service.

namespace operationalinsights

interface AnalyticsSolutionPlan

interface AnalyticsSolutionPlan

property name

name: string;

property product

product: string;

The product name of the solution. For example OMSGallery/Containers. Changing this forces a new resource to be created.

property promotionCode

promotionCode?: undefined | string;

A promotion code to be used with the solution.

property publisher

publisher: string;

The publisher of the solution. For example Microsoft. Changing this forces a new resource to be created.

namespace policy

interface AssignmentIdentity

interface AssignmentIdentity

property principalId

principalId: string;

The Principal ID of this Policy Assignment if type is SystemAssigned.

property tenantId

tenantId: string;

The Tenant ID of this Policy Assignment if type is SystemAssigned.

property type

type?: undefined | string;

The Managed Service Identity Type of this Policy Assignment. Possible values are SystemAssigned (where Azure will generate a Service Principal for you), or None (no use of a Managed Service Identity).

namespace postgresql

interface ServerStorageProfile

interface ServerStorageProfile

property autoGrow

DEPRECATED this has been moved to the top level and will be removed in version 3.0 of the provider.
autoGrow: string;

property backupRetentionDays

DEPRECATED this has been moved to the top level and will be removed in version 3.0 of the provider.
backupRetentionDays?: undefined | number;

Backup retention days for the server, supported values are between 7 and 35 days.

property geoRedundantBackup

DEPRECATED this has been moved to the top level and will be removed in version 3.0 of the provider.
geoRedundantBackup: string;

property storageMb

DEPRECATED this has been moved to the top level and will be removed in version 3.0 of the provider.
storageMb?: undefined | number;

Max storage allowed for a server. Possible values are between 5120 MB(5GB) and 1048576 MB(1TB) for the Basic SKU and between 5120 MB(5GB) and 4194304 MB(4TB) for General Purpose/Memory Optimized SKUs. For more information see the product documentation.

interface ServerThreatDetectionPolicy

interface ServerThreatDetectionPolicy

property disabledAlerts

disabledAlerts?: string[];

Specifies a list of alerts which should be disabled. Possible values include Access_Anomaly, Sql_Injection and Sql_Injection_Vulnerability.

property emailAccountAdmins

emailAccountAdmins?: undefined | false | true;

Should the account administrators be emailed when this alert is triggered?

property emailAddresses

emailAddresses?: string[];

A list of email addresses which alerts should be sent to.

property enabled

enabled?: undefined | false | true;

Is the policy enabled?

property retentionDays

retentionDays?: undefined | number;

Specifies the number of days to keep in the Threat Detection audit logs.

property storageAccountAccessKey

storageAccountAccessKey?: undefined | string;

Specifies the identifier key of the Threat Detection audit storage account.

property storageEndpoint

storageEndpoint?: undefined | string;

Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.

namespace privatedns

interface LinkServiceNatIpConfiguration

interface LinkServiceNatIpConfiguration

property name

name: string;

Specifies the name which should be used for the NAT IP Configuration. Changing this forces a new resource to be created.

property primary

primary: boolean;

Is this is the Primary IP Configuration? Changing this forces a new resource to be created.

property privateIpAddress

privateIpAddress?: undefined | string;

Specifies a Private Static IP Address for this IP Configuration.

property privateIpAddressVersion

privateIpAddressVersion?: undefined | string;

The version of the IP Protocol which should be used. At this time the only supported value is IPv4. Defaults to IPv4.

property subnetId

subnetId: string;

Specifies the ID of the Subnet which should be used for the Private Link Service.

interface MxRecordRecord

interface MxRecordRecord

property exchange

exchange: string;

The FQDN of the exchange to MX record points to.

property preference

preference: number;

The preference of the MX record.

interface SRVRecordRecord

interface SRVRecordRecord

property port

port: number;

The Port the service is listening on.

property priority

priority: number;

The priority of the SRV record.

property target

target: string;

The FQDN of the service.

property weight

weight: number;

The Weight of the SRV record.

interface TxtRecordRecord

interface TxtRecordRecord

property value

value: string;

The value of the TXT record. Max length: 1024 characters

interface EndpointPrivateServiceConnection

interface EndpointPrivateServiceConnection

property isManualConnection

isManualConnection: boolean;

Does the Private Endpoint require Manual Approval from the remote resource owner? Changing this forces a new resource to be created.

property name

name: string;

Specifies the Name of the Private Service Connection. Changing this forces a new resource to be created.

property privateConnectionResourceId

privateConnectionResourceId: string;

The ID of the Private Link Enabled Remote Resource which this Private Endpoint should be connected to. Changing this forces a new resource to be created.

property privateIpAddress

privateIpAddress: string;

The private IP address associated with the private endpoint, note that you will have a private IP address assigned to the private endpoint even if the connection request was Rejected.

property requestMessage

requestMessage?: undefined | string;

A message passed to the owner of the remote resource when the private endpoint attempts to establish the connection to the remote resource. The request message can be a maximum of 140 characters in length. Only valid if isManualConnection is set to true.

property subresourceNames

subresourceNames?: string[];

A list of subresource names which the Private Endpoint is able to connect to. subresourceNames corresponds to groupId. Changing this forces a new resource to be created.

interface GetEndpointConnectionPrivateServiceConnection

interface GetEndpointConnectionPrivateServiceConnection

property name

name: string;

Specifies the Name of the private endpoint.

property privateIpAddress

privateIpAddress: string;

The private IP address associated with the private endpoint, note that you will have a private IP address assigned to the private endpoint even if the connection request was Rejected.

property requestResponse

requestResponse: string;

Possible values are as follows: Value | Meaning – | – Auto-Approved | The remote resource owner has added you to the Auto-Approved RBAC permission list for the remote resource, all private endpoint connection requests will be automatically Approved. Deleted state | The resource owner has Rejected the private endpoint connection request and has removed your private endpoint request from the remote resource. request/response message | If you submitted a manual private endpoint connection request, while in the Pending status the requestResponse will display the same text from your requestMessage in the privateServiceConnection block above. If the private endpoint connection request was Rejected by the owner of the remote resource, the text for the rejection will be displayed as the requestResponse text, if the private endpoint connection request was Approved by the owner of the remote resource, the text for the approval will be displayed as the requestResponse text

property status

status: string;

The current status of the private endpoint request, possible values will be Pending, Approved, Rejected, or Disconnected.

interface GetServiceEndpointConnectionsPrivateEndpointConnection

interface GetServiceEndpointConnectionsPrivateEndpointConnection

property actionRequired

actionRequired: string;

A message indicating if changes on the service provider require any updates or not.

property connectionId

connectionId: string;

The resource id of the private link service connection between the private link service and the private link endpoint.

property connectionName

connectionName: string;

The name of the connection between the private link service and the private link endpoint.

property description

description: string;

The request for approval message or the reason for rejection message.

property privateEndpointId

privateEndpointId: string;

The resource id of the private link endpoint.

property privateEndpointName

privateEndpointName: string;

The name of the private link endpoint.

property status

status: string;

Indicates the state of the connection between the private link service and the private link endpoint, possible values are Pending, Approved or Rejected.

interface GetServiceNatIpConfiguration

interface GetServiceNatIpConfiguration

property name

name: string;

The name of the private link service.

property primary

primary: boolean;

Value that indicates if the IP configuration is the primary configuration or not.

property privateIpAddress

privateIpAddress: string;

The private IP address of the NAT IP configuration.

property privateIpAddressVersion

privateIpAddressVersion: string;

The version of the IP Protocol.

property subnetId

subnetId: string;

The ID of the subnet to be used by the service.

namespace redis

interface CachePatchSchedule

interface CachePatchSchedule

property dayOfWeek

dayOfWeek: string;

property startHourUtc

startHourUtc?: undefined | number;

interface CacheRedisConfiguration

interface CacheRedisConfiguration

property aofBackupEnabled

aofBackupEnabled?: undefined | false | true;

property aofStorageConnectionString0

aofStorageConnectionString0?: undefined | string;

property aofStorageConnectionString1

aofStorageConnectionString1?: undefined | string;

property enableAuthentication

enableAuthentication?: undefined | false | true;

If set to false, the Redis instance will be accessible without authentication. Defaults to true.

property maxclients

maxclients: number;

Returns the max number of connected clients at the same time.

property maxfragmentationmemoryReserved

maxfragmentationmemoryReserved: number;

Value in megabytes reserved to accommodate for memory fragmentation. Defaults are shown below.

property maxmemoryDelta

maxmemoryDelta: number;

The max-memory delta for this Redis instance. Defaults are shown below.

property maxmemoryPolicy

maxmemoryPolicy?: undefined | string;

How Redis will select what to remove when maxmemory is reached. Defaults are shown below.

property maxmemoryReserved

maxmemoryReserved: number;

Value in megabytes reserved for non-cache usage e.g. failover. Defaults are shown below.

property notifyKeyspaceEvents

notifyKeyspaceEvents?: undefined | string;

Keyspace notifications allows clients to subscribe to Pub/Sub channels in order to receive events affecting the Redis data set in some way. Reference

property rdbBackupEnabled

rdbBackupEnabled?: undefined | false | true;

Is Backup Enabled? Only supported on Premium SKU’s.

property rdbBackupFrequency

rdbBackupFrequency?: undefined | number;

The Backup Frequency in Minutes. Only supported on Premium SKU’s. Possible values are: 15, 30, 60, 360, 720 and 1440.

property rdbBackupMaxSnapshotCount

rdbBackupMaxSnapshotCount?: undefined | number;

The maximum number of snapshots to create as a backup. Only supported for Premium SKU’s.

property rdbStorageConnectionString

rdbStorageConnectionString?: undefined | string;

The Connection String to the Storage Account. Only supported for Premium SKU’s. In the format: DefaultEndpointsProtocol=https;BlobEndpoint=${azurerm_storage_account.example.primary_blob_endpoint};AccountName=${azurerm_storage_account.example.name};AccountKey=${azurerm_storage_account.example.primary_access_key}.

interface GetCachePatchSchedule

interface GetCachePatchSchedule

property dayOfWeek

dayOfWeek: string;

the Weekday name for the patch item

property startHourUtc

startHourUtc: number;

The Start Hour for maintenance in UTC

interface GetCacheRedisConfiguration

interface GetCacheRedisConfiguration

property aofBackupEnabled

aofBackupEnabled: boolean;

property aofStorageConnectionString0

aofStorageConnectionString0: string;

property aofStorageConnectionString1

aofStorageConnectionString1: string;

property enableAuthentication

enableAuthentication: boolean;

Specifies if authentication is enabled

property maxclients

maxclients: number;

property maxfragmentationmemoryReserved

maxfragmentationmemoryReserved: number;

Value in megabytes reserved to accommodate for memory fragmentation.

property maxmemoryDelta

maxmemoryDelta: number;

The max-memory delta for this Redis instance.

property maxmemoryPolicy

maxmemoryPolicy: string;

How Redis will select what to remove when maxmemory is reached.

property maxmemoryReserved

maxmemoryReserved: number;

The value in megabytes reserved for non-cache usage e.g. failover

property notifyKeyspaceEvents

notifyKeyspaceEvents: string;

property rdbBackupEnabled

rdbBackupEnabled: boolean;

Is Backup Enabled? Only supported on Premium SKU’s.

property rdbBackupFrequency

rdbBackupFrequency: number;

The Backup Frequency in Minutes. Only supported on Premium SKU’s.

property rdbBackupMaxSnapshotCount

rdbBackupMaxSnapshotCount: number;

The maximum number of snapshots that can be created as a backup.

property rdbStorageConnectionString

rdbStorageConnectionString: string;

The Connection String to the Storage Account. Only supported for Premium SKU’s.

namespace role

interface DefinitionPermission

interface DefinitionPermission

property actions

actions?: 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?: 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?: 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?: string[];

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

interface GetRoleDefinitionPermission

interface GetRoleDefinitionPermission

property actions

actions: string[];

property dataActions

dataActions?: string[];

property notActions

notActions: string[];

property notDataActions

notDataActions?: string[];

interface ServiceQueryKey

interface ServiceQueryKey

property key

key: string;

The value of this Query Key.

property name

name: string;

The Name which should be used for this Search Service. Changing this forces a new Search Service to be created.

namespace servicebus

interface NamespaceNetworkRuleSetNetworkRule

interface NamespaceNetworkRuleSetNetworkRule

property ignoreMissingVnetServiceEndpoint

ignoreMissingVnetServiceEndpoint?: undefined | false | true;

Should the ServiceBus Namespace Network Rule Set ignore missing Virtual Network Service Endpoint option in the Subnet? Defaults to false.

property subnetId

subnetId: string;

The Subnet ID which should be able to access this ServiceBus Namespace.

interface SubscriptionRuleCorrelationFilter

interface SubscriptionRuleCorrelationFilter

property contentType

contentType?: undefined | string;

Content type of the message.

property correlationId

correlationId?: undefined | string;

Identifier of the correlation.

property label

label?: undefined | string;

Application specific label.

property messageId

messageId?: undefined | string;

Identifier of the message.

property replyTo

replyTo?: undefined | string;

Address of the queue to reply to.

property replyToSessionId

replyToSessionId?: undefined | string;

Session identifier to reply to.

property sessionId

sessionId?: undefined | string;

Session identifier.

property to

to?: undefined | string;

Address to send to.

namespace servicefabric

interface ClusterAzureActiveDirectory

interface ClusterAzureActiveDirectory

property clientApplicationId

clientApplicationId: string;

The Azure Active Directory Client ID which should be used for the Client Application.

property clusterApplicationId

clusterApplicationId: string;

The Azure Active Directory Cluster Application ID.

property tenantId

tenantId: string;

The Azure Active Directory Tenant ID.

interface ClusterCertificate

interface ClusterCertificate

property thumbprint

thumbprint: string;

The Thumbprint of the Certificate.

property thumbprintSecondary

thumbprintSecondary?: undefined | string;

The Secondary Thumbprint of the Certificate.

property x509StoreName

x509StoreName: string;

The X509 Store where the Certificate Exists, such as My.

interface ClusterCertificateCommonNames

interface ClusterCertificateCommonNames

property commonNames

commonNames: ClusterCertificateCommonNamesCommonName[];

A commonNames block as defined below.

property x509StoreName

x509StoreName: string;

The X509 Store where the Certificate Exists, such as My.

interface ClusterCertificateCommonNamesCommonName

interface ClusterCertificateCommonNamesCommonName

property certificateCommonName

certificateCommonName: string;

The common or subject name of the certificate.

property certificateIssuerThumbprint

certificateIssuerThumbprint?: undefined | string;

The Issuer Thumbprint of the Certificate.

interface ClusterClientCertificateCommonName

interface ClusterClientCertificateCommonName

property commonName

commonName: string;

property isAdmin

isAdmin: boolean;

Does the Client Certificate have Admin Access to the cluster? Non-admin clients can only perform read only operations on the cluster.

property issuerThumbprint

issuerThumbprint?: undefined | string;

interface ClusterClientCertificateThumbprint

interface ClusterClientCertificateThumbprint

property isAdmin

isAdmin: boolean;

Does the Client Certificate have Admin Access to the cluster? Non-admin clients can only perform read only operations on the cluster.

property thumbprint

thumbprint: string;

The Thumbprint associated with the Client Certificate.

interface ClusterDiagnosticsConfig

interface ClusterDiagnosticsConfig

property blobEndpoint

blobEndpoint: string;

The Blob Endpoint of the Storage Account.

property protectedAccountKeyName

protectedAccountKeyName: string;

The protected diagnostics storage key name, such as StorageAccountKey1.

property queueEndpoint

queueEndpoint: string;

The Queue Endpoint of the Storage Account.

property storageAccountName

storageAccountName: string;

The name of the Storage Account where the Diagnostics should be sent to.

property tableEndpoint

tableEndpoint: string;

The Table Endpoint of the Storage Account.

interface ClusterFabricSetting

interface ClusterFabricSetting

property name

name: string;

The name of the Fabric Setting, such as Security or Federation.

property parameters

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

A map containing settings for the specified Fabric Setting.

interface ClusterNodeType

interface ClusterNodeType

property applicationPorts

applicationPorts: ClusterNodeTypeApplicationPorts;

A applicationPorts block as defined below.

property capacities

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

The capacity tags applied to the nodes in the node type, the cluster resource manager uses these tags to understand how much resource a node has.

property clientEndpointPort

clientEndpointPort: number;

The Port used for the Client Endpoint for this Node Type. Changing this forces a new resource to be created.

property durabilityLevel

durabilityLevel?: undefined | string;

The Durability Level for this Node Type. Possible values include Bronze, Gold and Silver. Defaults to Bronze. Changing this forces a new resource to be created.

property ephemeralPorts

ephemeralPorts: ClusterNodeTypeEphemeralPorts;

A ephemeralPorts block as defined below.

property httpEndpointPort

httpEndpointPort: number;

The Port used for the HTTP Endpoint for this Node Type. Changing this forces a new resource to be created.

property instanceCount

instanceCount: number;

The number of nodes for this Node Type.

property isPrimary

isPrimary: boolean;

Is this the Primary Node Type? Changing this forces a new resource to be created.

property name

name: string;

The name of the Node Type. Changing this forces a new resource to be created.

property placementProperties

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

The placement tags applied to nodes in the node type, which can be used to indicate where certain services (workload) should run.

property reverseProxyEndpointPort

reverseProxyEndpointPort?: undefined | number;

The Port used for the Reverse Proxy Endpoint for this Node Type. Changing this will upgrade the cluster.

interface ClusterNodeTypeApplicationPorts

interface ClusterNodeTypeApplicationPorts

property endPort

endPort: number;

The end of the Application Port Range on this Node Type.

property startPort

startPort: number;

The start of the Application Port Range on this Node Type.

interface ClusterNodeTypeEphemeralPorts

interface ClusterNodeTypeEphemeralPorts

property endPort

endPort: number;

The end of the Ephemeral Port Range on this Node Type.

property startPort

startPort: number;

The start of the Ephemeral Port Range on this Node Type.

interface ClusterReverseProxyCertificate

interface ClusterReverseProxyCertificate

property thumbprint

thumbprint: string;

The Thumbprint of the Certificate.

property thumbprintSecondary

thumbprintSecondary?: undefined | string;

The Secondary Thumbprint of the Certificate.

property x509StoreName

x509StoreName: string;

The X509 Store where the Certificate Exists, such as My.

namespace signalr

interface ServiceCor

interface ServiceCor

property allowedOrigins

allowedOrigins: string[];

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

interface ServiceFeature

interface ServiceFeature

property flag

flag: string;

The kind of Feature. Possible values are EnableConnectivityLogs, EnableMessagingLogs, and ServiceMode.

property value

value: string;

A value of a feature flag. Possible values are Classic, Default and Serverless.

interface ServiceSku

interface ServiceSku

property capacity

capacity: number;

Specifies the number of units associated with this SignalR service. Valid values are 1, 2, 5, 10, 20, 50 and 100.

property name

name: string;

Specifies which tier to use. Valid values are Free_F1 and Standard_S1.

namespace siterecovery

interface ReplicatedVMManagedDisk

interface ReplicatedVMManagedDisk

property diskId

diskId: string;

Id of disk that should be replicated.

property stagingStorageAccountId

stagingStorageAccountId: string;

Storage account that should be used for caching.

property targetDiskType

targetDiskType: string;

What type should the disk be when a failover is done.

property targetReplicaDiskType

targetReplicaDiskType: string;

What type should the disk be that holds the replication data.

property targetResourceGroupId

targetResourceGroupId: string;

Resource group disk should belong to when a failover is done.

namespace sql

interface DatabaseExtendedAuditingPolicy

interface DatabaseExtendedAuditingPolicy

property retentionInDays

retentionInDays?: undefined | number;

Specifies the number of days to retain logs for in the storage account.

property storageAccountAccessKey

storageAccountAccessKey: string;

Specifies the access key to use for the auditing storage account.

property storageAccountAccessKeyIsSecondary

storageAccountAccessKeyIsSecondary?: undefined | false | true;

Specifies whether storageAccountAccessKey value is the storage’s secondary key.

property storageEndpoint

storageEndpoint: string;

Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net).

interface DatabaseImport

interface DatabaseImport

property administratorLogin

administratorLogin: string;

Specifies the name of the SQL administrator.

property administratorLoginPassword

administratorLoginPassword: string;

Specifies the password of the SQL administrator.

property authenticationType

authenticationType: string;

Specifies the type of authentication used to access the server. Valid values are SQL or ADPassword.

property operationMode

operationMode?: undefined | string;

Specifies the type of import operation being performed. The only allowable value is Import.

property storageKey

storageKey: string;

Specifies the access key for the storage account.

property storageKeyType

storageKeyType: string;

Specifies the type of access key for the storage account. Valid values are StorageAccessKey or SharedAccessKey.

property storageUri

storageUri: string;

Specifies the blob URI of the .bacpac file.

interface DatabaseThreatDetectionPolicy

interface DatabaseThreatDetectionPolicy

property disabledAlerts

disabledAlerts?: string[];

Specifies a list of alerts which should be disabled. Possible values include Access_Anomaly, Sql_Injection and Sql_Injection_Vulnerability.

property emailAccountAdmins

emailAccountAdmins?: undefined | string;

Should the account administrators be emailed when this alert is triggered?

property emailAddresses

emailAddresses?: string[];

A list of email addresses which alerts should be sent to.

property retentionDays

retentionDays?: undefined | number;

Specifies the number of days to keep in the Threat Detection audit logs.

property state

state?: undefined | string;

The State of the Policy. Possible values are Enabled, Disabled or New.

property storageAccountAccessKey

storageAccountAccessKey?: undefined | string;

Specifies the identifier key of the Threat Detection audit storage account. Required if state is Enabled.

property storageEndpoint

storageEndpoint?: undefined | string;

Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs. Required if state is Enabled.

property useServerDefault

useServerDefault?: undefined | string;

Should the default server policy be used? Defaults to Disabled.

interface FailoverGroupPartnerServer

interface FailoverGroupPartnerServer

property id

id: string;

the SQL server ID

property location

location: string;

the location of the failover group.

property role

role: string;

local replication role of the failover group instance.

interface FailoverGroupReadonlyEndpointFailoverPolicy

interface FailoverGroupReadonlyEndpointFailoverPolicy

property mode

mode: string;

Failover policy for the read-only endpoint. Possible values are Enabled, and Disabled

interface FailoverGroupReadWriteEndpointFailoverPolicy

interface FailoverGroupReadWriteEndpointFailoverPolicy

property graceMinutes

graceMinutes?: undefined | number;

Applies only if mode is Automatic. The grace period in minutes before failover with data loss is attempted

property mode

mode: string;

the failover mode. Possible values are Manual, Automatic

interface GetServerIdentity

interface GetServerIdentity

property principalId

principalId: string;

The ID of the Principal (Client) in Azure Active Directory.

property tenantId

tenantId: string;

The ID of the Azure Active Directory Tenant.

property type

type: string;

The identity type of the SQL Server.

interface SqlServerExtendedAuditingPolicy

interface SqlServerExtendedAuditingPolicy

property retentionInDays

retentionInDays?: undefined | number;

(Optional) Specifies the number of days to retain logs for in the storage account.

property storageAccountAccessKey

storageAccountAccessKey: string;

(Required) Specifies the access key to use for the auditing storage account.

property storageAccountAccessKeyIsSecondary

storageAccountAccessKeyIsSecondary?: undefined | false | true;

(Optional) Specifies whether storageAccountAccessKey value is the storage’s secondary key.

property storageEndpoint

storageEndpoint: string;

(Required) Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net).

interface SqlServerIdentity

interface SqlServerIdentity

property principalId

principalId: string;

The Principal ID for the Service Principal associated with the Identity of this SQL Server.

property tenantId

tenantId: string;

The Tenant ID for the Service Principal associated with the Identity of this SQL Server.

property type

type: string;

Specifies the identity type of the Microsoft SQL Server. At this time the only allowed value is SystemAssigned.

namespace storage

interface AccountBlobProperties

interface AccountBlobProperties

property corsRules

corsRules?: AccountBlobPropertiesCorsRule[];

A corsRule block as defined below.

property deleteRetentionPolicy

deleteRetentionPolicy?: outputs.storage.AccountBlobPropertiesDeleteRetentionPolicy;

A deleteRetentionPolicy block as defined below.

interface AccountBlobPropertiesCorsRule

interface AccountBlobPropertiesCorsRule

property allowedHeaders

allowedHeaders: string[];

A list of headers that are allowed to be a part of the cross-origin request.

property allowedMethods

allowedMethods: string[];

A list of http headers that are allowed to be executed by the origin. Valid options are DELETE, GET, HEAD, MERGE, POST, OPTIONS, PUT or PATCH.

property allowedOrigins

allowedOrigins: string[];

A list of origin domains that will be allowed by CORS.

property exposedHeaders

exposedHeaders: string[];

A list of response headers that are exposed to CORS clients.

property maxAgeInSeconds

maxAgeInSeconds: number;

The number of seconds the client should cache a preflight response.

interface AccountBlobPropertiesDeleteRetentionPolicy

interface AccountBlobPropertiesDeleteRetentionPolicy

property days

days?: undefined | number;

Specifies the number of days that the blob should be retained, between 1 and 365 days. Defaults to 7.

interface AccountCustomDomain

interface AccountCustomDomain

property name

name: string;

The Custom Domain Name to use for the Storage Account, which will be validated by Azure.

property useSubdomain

useSubdomain?: undefined | false | true;

Should the Custom Domain Name be validated by using indirect CNAME validation?

interface AccountIdentity

interface AccountIdentity

property principalId

principalId: string;

The Principal ID for the Service Principal associated with the Identity of this Storage Account.

property tenantId

tenantId: string;

The Tenant ID for the Service Principal associated with the Identity of this Storage Account.

property type

type: string;

Specifies the identity type of the Storage Account. At this time the only allowed value is SystemAssigned.

interface AccountNetworkRules

interface AccountNetworkRules

property bypasses

bypasses: string[];

Specifies whether traffic is bypassed for Logging/Metrics/AzureServices. Valid options are any combination of Logging, Metrics, AzureServices, or None.

property defaultAction

defaultAction: string;

Specifies the default action of allow or deny when no other rules match. Valid options are Deny or Allow.

property ipRules

ipRules: string[];

List of public IP or IP ranges in CIDR Format. Only IPV4 addresses are allowed. Private IP address ranges (as defined in RFC 1918) are not allowed.

property virtualNetworkSubnetIds

virtualNetworkSubnetIds: string[];

A list of resource ids for subnets.

interface AccountQueueProperties

interface AccountQueueProperties

property corsRules

corsRules?: AccountQueuePropertiesCorsRule[];

A corsRule block as defined above.

property hourMetrics

hourMetrics?: outputs.storage.AccountQueuePropertiesHourMetrics;

A hourMetrics block as defined below.

property logging

logging?: outputs.storage.AccountQueuePropertiesLogging;

A logging block as defined below.

property minuteMetrics

minuteMetrics?: outputs.storage.AccountQueuePropertiesMinuteMetrics;

A minuteMetrics block as defined below.

interface AccountQueuePropertiesCorsRule

interface AccountQueuePropertiesCorsRule

property allowedHeaders

allowedHeaders: string[];

A list of headers that are allowed to be a part of the cross-origin request.

property allowedMethods

allowedMethods: string[];

A list of http headers that are allowed to be executed by the origin. Valid options are DELETE, GET, HEAD, MERGE, POST, OPTIONS, PUT or PATCH.

property allowedOrigins

allowedOrigins: string[];

A list of origin domains that will be allowed by CORS.

property exposedHeaders

exposedHeaders: string[];

A list of response headers that are exposed to CORS clients.

property maxAgeInSeconds

maxAgeInSeconds: number;

The number of seconds the client should cache a preflight response.

interface AccountQueuePropertiesHourMetrics

interface AccountQueuePropertiesHourMetrics

property enabled

enabled: boolean;

Indicates whether hour metrics are enabled for the Queue service. Changing this forces a new resource.

property includeApis

includeApis?: undefined | false | true;

Indicates whether metrics should generate summary statistics for called API operations.

property retentionPolicyDays

retentionPolicyDays?: undefined | number;

Specifies the number of days that logs will be retained. Changing this forces a new resource.

property version

version: string;

The version of storage analytics to configure. Changing this forces a new resource.

interface AccountQueuePropertiesLogging

interface AccountQueuePropertiesLogging

property delete

delete: boolean;

Indicates whether all delete requests should be logged. Changing this forces a new resource.

property read

read: boolean;

Indicates whether all read requests should be logged. Changing this forces a new resource.

property retentionPolicyDays

retentionPolicyDays?: undefined | number;

Specifies the number of days that logs will be retained. Changing this forces a new resource.

property version

version: string;

The version of storage analytics to configure. Changing this forces a new resource.

property write

write: boolean;

Indicates whether all write requests should be logged. Changing this forces a new resource.

interface AccountQueuePropertiesMinuteMetrics

interface AccountQueuePropertiesMinuteMetrics

property enabled

enabled: boolean;

Indicates whether minute metrics are enabled for the Queue service. Changing this forces a new resource.

property includeApis

includeApis?: undefined | false | true;

Indicates whether metrics should generate summary statistics for called API operations.

property retentionPolicyDays

retentionPolicyDays?: undefined | number;

Specifies the number of days that logs will be retained. Changing this forces a new resource.

property version

version: string;

The version of storage analytics to configure. Changing this forces a new resource.

interface AccountStaticWebsite

interface AccountStaticWebsite

property error404Document

error404Document?: undefined | string;

The absolute path to a custom webpage that should be used when a request is made which does not correspond to an existing file.

property indexDocument

indexDocument?: undefined | string;

The webpage that Azure Storage serves for requests to the root of a website or any subfolder. For example, index.html. The value is case-sensitive.

interface GetAccountBlobContainerSASPermissions

interface GetAccountBlobContainerSASPermissions

property add

add: boolean;

Should Add permissions be enabled for this SAS?

property create

create: boolean;

Should Create permissions be enabled for this SAS?

property delete

delete: boolean;

Should Delete permissions be enabled for this SAS?

property list

list: boolean;

Should List permissions be enabled for this SAS?

property read

read: boolean;

Should Read permissions be enabled for this SAS?

property write

write: boolean;

Should Write permissions be enabled for this SAS?

interface GetAccountCustomDomain

interface GetAccountCustomDomain

property name

name: string;

Specifies the name of the Storage Account

interface GetAccountSASPermissions

interface GetAccountSASPermissions

property add

add: boolean;

Should Add permissions be enabled for this SAS?

property create

create: boolean;

Should Create permissions be enabled for this SAS?

property delete

delete: boolean;

Should Delete permissions be enabled for this SAS?

property list

list: boolean;

Should List permissions be enabled for this SAS?

property process

process: boolean;

Should Process permissions be enabled for this SAS?

property read

read: boolean;

Should Read permissions be enabled for this SAS?

property update

update: boolean;

Should Update permissions be enabled for this SAS?

property write

write: boolean;

Should Write permissions be enabled for this SAS?

interface GetAccountSASResourceTypes

interface GetAccountSASResourceTypes

property container

container: boolean;

Should permission be granted to the container?

property object

object: boolean;

Should permission be granted only to a specific object?

property service

service: boolean;

Should permission be granted to the entire service?

interface GetAccountSASServices

interface GetAccountSASServices

property blob

blob: boolean;

Should permission be granted to blob services within this storage account?

property file

file: boolean;

Should permission be granted to file services within this storage account?

property queue

queue: boolean;

Should permission be granted to queue services within this storage account?

property table

table: boolean;

Should permission be granted to table services within this storage account?

interface GetPolicyRule

interface GetPolicyRule

property actions

actions: GetPolicyRuleAction[];

An actions block as documented below.

property enabled

enabled: boolean;

Boolean to specify whether the rule is enabled.

property filters

filters: GetPolicyRuleFilter[];

A filter block as documented below.

property name

name: string;

A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy.

interface GetPolicyRuleAction

interface GetPolicyRuleAction

property baseBlobs

baseBlobs: GetPolicyRuleActionBaseBlob[];

A baseBlob block as documented below.

property snapshots

snapshots: GetPolicyRuleActionSnapshot[];

A snapshot block as documented below.

interface GetPolicyRuleActionBaseBlob

interface GetPolicyRuleActionBaseBlob

property deleteAfterDaysSinceModificationGreaterThan

deleteAfterDaysSinceModificationGreaterThan: number;

The age in days after last modification to delete the blob.

property tierToArchiveAfterDaysSinceModificationGreaterThan

tierToArchiveAfterDaysSinceModificationGreaterThan: number;

The age in days after last modification to tier blobs to archive storage. Supports blob currently at Hot or Cool tier.

property tierToCoolAfterDaysSinceModificationGreaterThan

tierToCoolAfterDaysSinceModificationGreaterThan: number;

The age in days after last modification to tier blobs to cool storage. Supports blob currently at Hot tier.

interface GetPolicyRuleActionSnapshot

interface GetPolicyRuleActionSnapshot

property deleteAfterDaysSinceCreationGreaterThan

deleteAfterDaysSinceCreationGreaterThan: number;

The age in days after create to delete the snaphot.

interface GetPolicyRuleFilter

interface GetPolicyRuleFilter

property blobTypes

blobTypes: string[];

An array of predefined values. Only blockBlob is supported.

property prefixMatches

prefixMatches: string[];

An array of strings for prefixes to be matched.

interface ManagementPolicyRule

interface ManagementPolicyRule

property actions

actions: ManagementPolicyRuleActions;

An actions block as documented below.

property enabled

enabled: boolean;

Boolean to specify whether the rule is enabled.

property filters

filters?: outputs.storage.ManagementPolicyRuleFilters;

A filter block as documented below.

property name

name: string;

A rule name can contain any combination of alpha numeric characters. Rule name is case-sensitive. It must be unique within a policy.

interface ManagementPolicyRuleActions

interface ManagementPolicyRuleActions

property baseBlob

baseBlob?: outputs.storage.ManagementPolicyRuleActionsBaseBlob;

A baseBlob block as documented below.

property snapshot

snapshot?: outputs.storage.ManagementPolicyRuleActionsSnapshot;

A snapshot block as documented below.

interface ManagementPolicyRuleActionsBaseBlob

interface ManagementPolicyRuleActionsBaseBlob

property deleteAfterDaysSinceModificationGreaterThan

deleteAfterDaysSinceModificationGreaterThan?: undefined | number;

The age in days after last modification to delete the blob. Must be at least 0.

property tierToArchiveAfterDaysSinceModificationGreaterThan

tierToArchiveAfterDaysSinceModificationGreaterThan?: undefined | number;

The age in days after last modification to tier blobs to archive storage. Supports blob currently at Hot or Cool tier. Must be at least 0.

property tierToCoolAfterDaysSinceModificationGreaterThan

tierToCoolAfterDaysSinceModificationGreaterThan?: undefined | number;

The age in days after last modification to tier blobs to cool storage. Supports blob currently at Hot tier. Must be at least 0.

interface ManagementPolicyRuleActionsSnapshot

interface ManagementPolicyRuleActionsSnapshot

property deleteAfterDaysSinceCreationGreaterThan

deleteAfterDaysSinceCreationGreaterThan?: undefined | number;

The age in days after create to delete the snaphot. Must be at least 0.

interface ManagementPolicyRuleFilters

interface ManagementPolicyRuleFilters

property blobTypes

blobTypes?: string[];

An array of predefined values. Only blockBlob is supported.

property prefixMatches

prefixMatches?: string[];

An array of strings for prefixes to be matched.

interface ShareAcl

interface ShareAcl

property accessPolicies

accessPolicies?: ShareAclAccessPolicy[];

An accessPolicy block as defined below.

property id

id: string;

The ID which should be used for this Shared Identifier.

interface ShareAclAccessPolicy

interface ShareAclAccessPolicy

property expiry

expiry: string;

The time at which this Access Policy should be valid until, in ISO8601 format.

property permissions

permissions: string;

The permissions which should be associated with this Shared Identifier. Possible value is combination of d (delete), l (list), r (read) and w (write).

property start

start: string;

The time at which this Access Policy should be valid from, in ISO8601 format.

interface TableAcl

interface TableAcl

property accessPolicies

accessPolicies?: TableAclAccessPolicy[];

An accessPolicy block as defined below.

property id

id: string;

The ID which should be used for this Shared Identifier.

interface TableAclAccessPolicy

interface TableAclAccessPolicy

property expiry

expiry: string;

The ISO8061 UTC time at which this Access Policy should be valid until.

property permissions

permissions: string;

The permissions which should associated with this Shared Identifier.

property start

start: string;

The ISO8061 UTC time at which this Access Policy should be valid from.

namespace streamanalytics

interface FunctionJavaScriptUDFInput

interface FunctionJavaScriptUDFInput

property type

type: string;

The Data Type for the Input Argument of this JavaScript Function. Possible values include array, any, bigint, datetime, float, nvarchar(max) and record.

interface FunctionJavaScriptUDFOutput

interface FunctionJavaScriptUDFOutput

property type

type: string;

The Data Type output from this JavaScript Function. Possible values include array, any, bigint, datetime, float, nvarchar(max) and record.

interface OutputBlobSerialization

interface OutputBlobSerialization

property encoding

encoding?: undefined | string;

The encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. It currently can only be set to UTF8.

property fieldDelimiter

fieldDelimiter?: undefined | string;

The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are (space), , (comma), (tab), | (pipe) and ;.

property format

format?: undefined | string;

Specifies the format of the JSON the output will be written in. Possible values are Array and LineSeparated.

property type

type: string;

The serialization format used for outgoing data streams. Possible values are Avro, Csv and Json.

interface OutputEventHubSerialization

interface OutputEventHubSerialization

property encoding

encoding?: undefined | string;

The encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. It currently can only be set to UTF8.

property fieldDelimiter

fieldDelimiter?: undefined | string;

The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are (space), , (comma), (tab), | (pipe) and ;.

property format

format?: undefined | string;

Specifies the format of the JSON the output will be written in. Possible values are Array and LineSeparated.

property type

type: string;

The serialization format used for outgoing data streams. Possible values are Avro, Csv and Json.

interface OutputServiceBusQueueSerialization

interface OutputServiceBusQueueSerialization

property encoding

encoding?: undefined | string;

The encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. It currently can only be set to UTF8.

property fieldDelimiter

fieldDelimiter?: undefined | string;

The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are (space), , (comma), (tab), | (pipe) and ;.

property format

format?: undefined | string;

Specifies the format of the JSON the output will be written in. Possible values are Array and LineSeparated.

property type

type: string;

The serialization format used for outgoing data streams. Possible values are Avro, Csv and Json.

interface OutputServicebusTopicSerialization

interface OutputServicebusTopicSerialization

property encoding

encoding?: undefined | string;

The encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. It currently can only be set to UTF8.

property fieldDelimiter

fieldDelimiter?: undefined | string;

The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are (space), , (comma), (tab), | (pipe) and ;.

property format

format?: undefined | string;

Specifies the format of the JSON the output will be written in. Possible values are Array and LineSeparated.

property type

type: string;

The serialization format used for outgoing data streams. Possible values are Avro, Csv and Json.

interface ReferenceInputBlobSerialization

interface ReferenceInputBlobSerialization

property encoding

encoding?: undefined | string;

The encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. It currently can only be set to UTF8.

property fieldDelimiter

fieldDelimiter?: undefined | string;

The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are (space), , (comma), (tab), | (pipe) and ;.

property type

type: string;

The serialization format used for the reference data. Possible values are Avro, Csv and Json.

interface StreamInputBlobSerialization

interface StreamInputBlobSerialization

property encoding

encoding?: undefined | string;

The encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. It currently can only be set to UTF8.

property fieldDelimiter

fieldDelimiter?: undefined | string;

The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are (space), , (comma), (tab), | (pipe) and ;.

property type

type: string;

The serialization format used for incoming data streams. Possible values are Avro, Csv and Json.

interface StreamInputEventHubSerialization

interface StreamInputEventHubSerialization

property encoding

encoding?: undefined | string;

The encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. It currently can only be set to UTF8.

property fieldDelimiter

fieldDelimiter?: undefined | string;

The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are (space), , (comma), (tab), | (pipe) and ;.

property type

type: string;

The serialization format used for incoming data streams. Possible values are Avro, Csv and Json.

interface StreamInputIotHubSerialization

interface StreamInputIotHubSerialization

property encoding

encoding?: undefined | string;

The encoding of the incoming data in the case of input and the encoding of outgoing data in the case of output. It currently can only be set to UTF8.

property fieldDelimiter

fieldDelimiter?: undefined | string;

The delimiter that will be used to separate comma-separated value (CSV) records. Possible values are (space), , (comma), (tab), | (pipe) and ;.

property type

type: string;

The serialization format used for incoming data streams. Possible values are Avro, Csv and Json.

namespace trafficmanager

interface EndpointCustomHeader

interface EndpointCustomHeader

property name

name: string;

The name of the custom header.

property value

value: string;

The value of custom header. Applicable for Http and Https protocol.

interface EndpointSubnet

interface EndpointSubnet

property first

first: string;

The First IP….

property last

last?: undefined | string;

The Last IP…

property scope

scope?: undefined | number;

The Scope…

interface ProfileDnsConfig

interface ProfileDnsConfig

property relativeName

relativeName: string;

The relative domain name, this is combined with the domain name used by Traffic Manager to form the FQDN which is exported as documented below. Changing this forces a new resource to be created.

property ttl

ttl: number;

The TTL value of the Profile used by Local DNS resolvers and clients.

interface ProfileMonitorConfig

interface ProfileMonitorConfig

property customHeaders

customHeaders?: ProfileMonitorConfigCustomHeader[];

One or more customHeader blocks as defined below.

property expectedStatusCodeRanges

expectedStatusCodeRanges?: string[];

A list of status code ranges in the format of 100-101.

property intervalInSeconds

intervalInSeconds?: undefined | number;

The interval used to check the endpoint health from a Traffic Manager probing agent. You can specify two values here: 30 (normal probing) and 10 (fast probing). The default value is 30.

property path

path?: undefined | string;

The path used by the monitoring checks. Required when protocol is set to HTTP or HTTPS - cannot be set when protocol is set to TCP.

property port

port: number;

The port number used by the monitoring checks.

property protocol

protocol: string;

The protocol used by the monitoring checks, supported values are HTTP, HTTPS and TCP.

property timeoutInSeconds

timeoutInSeconds?: undefined | number;

The amount of time the Traffic Manager probing agent should wait before considering that check a failure when a health check probe is sent to the endpoint. If intervalInSeconds is set to 30, then timeoutInSeconds can be between 5 and 10. The default value is 10. If intervalInSeconds is set to 10, then valid values are between 5 and 9 and timeoutInSeconds is required.

property toleratedNumberOfFailures

toleratedNumberOfFailures?: undefined | number;

The number of failures a Traffic Manager probing agent tolerates before marking that endpoint as unhealthy. Valid values are between 0 and 9. The default value is 3

interface ProfileMonitorConfigCustomHeader

interface ProfileMonitorConfigCustomHeader

property name

name: string;

The name of the custom header.

property value

value: string;

The value of custom header. Applicable for Http and Https protocol.

namespace waf

interface PolicyCustomRule

interface PolicyCustomRule

property action

action: string;

Type of action.

property matchConditions

matchConditions: PolicyCustomRuleMatchCondition[];

One or more matchConditions blocks as defined below.

property name

name?: undefined | string;

Gets name of the resource that is unique within a policy. This name can be used to access the resource.

property priority

priority: number;

Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.

property ruleType

ruleType: string;

Describes the type of rule.

interface PolicyCustomRuleMatchCondition

interface PolicyCustomRuleMatchCondition

property matchValues

matchValues: string[];

A list of match values.

property matchVariables

matchVariables: PolicyCustomRuleMatchConditionMatchVariable[];

One or more matchVariables blocks as defined below.

property negationCondition

negationCondition?: undefined | false | true;

Describes if this is negate condition or not

property operator

operator: string;

Describes operator to be matched.

interface PolicyCustomRuleMatchConditionMatchVariable

interface PolicyCustomRuleMatchConditionMatchVariable

property selector

selector?: undefined | string;

Describes field of the matchVariable collection

property variableName

variableName: string;

The name of the Match Variable

interface PolicyManagedRules

interface PolicyManagedRules

property exclusions

exclusions?: PolicyManagedRulesExclusion[];

One or more exclusion block defined below.

property managedRuleSets

managedRuleSets: PolicyManagedRulesManagedRuleSet[];

One or more managedRuleSet block defined below.

interface PolicyManagedRulesExclusion

interface PolicyManagedRulesExclusion

property matchVariable

matchVariable: string;

property selector

selector: string;

Describes field of the matchVariable collection.

property selectorMatchOperator

selectorMatchOperator: string;

Describes operator to be matched. Possible values: Contains, EndsWith, Equals, EqualsAny, StartsWith.

interface PolicyManagedRulesManagedRuleSet

interface PolicyManagedRulesManagedRuleSet

property ruleGroupOverrides

ruleGroupOverrides?: PolicyManagedRulesManagedRuleSetRuleGroupOverride[];

One or more ruleGroupOverride block defined below.

property type

type?: undefined | string;

The rule set type.

property version

version: string;

The rule set version.

interface PolicyManagedRulesManagedRuleSetRuleGroupOverride

interface PolicyManagedRulesManagedRuleSetRuleGroupOverride

property disabledRules

disabledRules: string[];

One or more Rule ID’s

property ruleGroupName

ruleGroupName: string;

The name of the Rule Group

interface PolicyPolicySettings

interface PolicyPolicySettings

property enabled

enabled?: undefined | false | true;

Describes if the policy is in enabled state or disabled state Defaults to Enabled.

property mode

mode?: undefined | string;

Describes if it is in detection mode or prevention mode at the policy level Defaults to Prevention.

APIs

interface ProviderFeatures

interface ProviderFeatures

property keyVault

keyVault?: outputs.ProviderFeaturesKeyVault;

property virtualMachine

virtualMachine?: outputs.ProviderFeaturesVirtualMachine;

property virtualMachineScaleSet

virtualMachineScaleSet?: outputs.ProviderFeaturesVirtualMachineScaleSet;

interface ProviderFeaturesKeyVault

interface ProviderFeaturesKeyVault

property purgeSoftDeleteOnDestroy

purgeSoftDeleteOnDestroy?: undefined | false | true;

property recoverSoftDeletedKeyVaults

recoverSoftDeletedKeyVaults?: undefined | false | true;

interface ProviderFeaturesVirtualMachine

interface ProviderFeaturesVirtualMachine

property deleteOsDiskOnDeletion

deleteOsDiskOnDeletion?: undefined | false | true;

interface ProviderFeaturesVirtualMachineScaleSet

interface ProviderFeaturesVirtualMachineScaleSet

property rollInstancesWhenRequired

rollInstancesWhenRequired?: undefined | false | true;