CI Reference

Configuration Item Overview

Deployables

CI	Description
azure.AppServicePlanSpec	Create an AppServicePlan in the Resource Group. (deployable)
azure.ArtifactPackageSpec	Uploads an artifact to the specified artifact feed. (deployable)
azure.ArtifactsFeedSpec	Creates an Artifact Feed in the given Cloud organization. (deployable)
azure.AvailabilitySetSpec	Availability Set resource
azure.CertificateFile	Certificate/CA Bundle file to be used for verification
azure.CloudServiceSpec	Creates a Cloud Service in the Resource Group. (deployable)
azure.ContainerAppSpec	Creates a ContainerApp in the Resource Group. (deployable)
azure.ContainerGroupSpec	Container Group resource
azure.ContinuousWebJobSpec	Creates a Continuous Web Job in the resource group. (deployable)
azure.FunctionAppCodeSpec	Uploads FunctionAppCode to the Resource Group. (deployable)
azure.FunctionAppContainerSpec	Creates a Function App as a custom Docker Container in the Resource Group. (deployable)
azure.FunctionAppSlotSpec	Creates a Function App Deployment Slot in the resource group. (deployable)
azure.FunctionAppZip	Creates a Function App in the Resource Group. (deployable)
azure.KeyVaultSpec	A key vault storage within resource group
azure.LoadBalancerSpec	Load Balancer resource
azure.NetworkInterfaceSpec	A network interface in a resource group
azure.NetworkSecurityGroupSpec	Specification for Network Security Group.
azure.PublicIpAddressSpec	Specification for an Azure Public Ip Address.
azure.ResourceGroupSpec	Specification for an Azure Resource Group.
azure.RouteTableSpec	RouteTable resource
azure.StaticWebAppCodeSpec	Uploads StaticWebAppCode to the Resource Group. (deployable)
azure.StaticWebAppSpec	Creates a Static Webapp in the Resource Group. (deployable)
azure.StorageAccountSpec	Specification for an Azure Storage Account.
azure.TriggeredWebJobSpec	Creates a Triggered Web Job in the resource group. (deployable)
azure.VirtualMachineSpec	Describes a Virtual Machine.
azure.VirtualNetworkSpec	Virtual Network resource
azure.WebAppCodeSpec	Uploads WebAppCode to the Resource Group. (deployable)
azure.WebAppExtensionSpec	Creates a Webapp Extension in the Resource group. (deployable)
azure.WebAppLoggingSpec	Creates Webapp logging in the resource group. (deployable)
azure.WebAppSlotSpec	Creates a Webapp Slot in the resource group. (deployable)
azure.WebAppSpec	Creates a Webapp in the Resource Group. (deployable)

Deployeds

CI	Description
azure.AppServicePlan	Create an AppServicePlan in the Resource Group.
azure.ArtifactPackage	Uploads an artifact to the specified artifact feed.
azure.ArtifactsFeed	Creates an Artifact Feed in the given Cloud organization.
azure.AvailabilitySet	Creates an Availability Set resource in the Resource Group.
azure.BaseWebAppExtension	Base Webapp Extension task which can be extended.
azure.BaseWebAppLogging	Base Webapp Logging task which can be extended.
azure.BaseWebAppSlot	Base Webapp Slot taks which can be extended.
azure.BaseWebJob	Base Webjob task which can be extended by related types.
azure.CloudService	Creates a Cloud Service in the Resource Group.
azure.ContainerApp	Creates a ContainerApp in the Resource Group.
azure.ContainerGroup	Creates a Container Group resource in the Resource Group.
azure.ContinuousWebJob	Creates a Continuous Web Job in the resource group.
azure.FunctionApp	Creates a Function App in the Resource Group.
azure.FunctionAppCode	Uploads FunctionAppCode to the Resource Group.
azure.FunctionAppContainer	Creates a Function App as a custom Docker Container in the Resource Group.
azure.FunctionAppSlot	Creates a Function App Deployment Slot in the resource group.
azure.KeyVault	Creates a key vault storage within resource group
azure.LoadBalancer	Creates a Load Balancer resource in the Resource Group.
azure.NetworkInterface	Creates a network interface in a resource group.
azure.NetworkSecurityGroup	Ad a Network Security Group to the Resource Group.
azure.PublicIpAddress	Creates an Azure Public Ip Address in the given Resource Group.
azure.ResourceGroup	Azure Resource Group definition.
azure.RouteTable	Creates a RouteTable resource in the Resource Group.
azure.StaticWebApp	Creates a Static Webapp in the Resource Group.
azure.StaticWebAppCode	Uploads StaticWebAppCode to the Resource Group.
azure.StorageAccount	Create an Azure Storage Account.
azure.TriggeredWebJob	Creates a Triggered Web Job in the resource group.
azure.VirtualMachine	Describes a Virtual Machine in the Resource Group.
azure.VirtualNetwork	Creates a Virtual Network resource in the Resource Group.
azure.WebApp	Creates a Webapp in the Resource Group.
azure.WebAppCode	Uploads WebAppCode to the Resource Group.
azure.WebAppExtension	Creates a Webapp Extension in the Resource group.
azure.WebAppLogging	Creates Webapp logging in the resource group.
azure.WebAppSlot	Creates a Webapp Slot in the resource group.

Containers

CI	Description
azure.ArtifactsFeed	Creates an Artifact Feed in the given Cloud organization.
azure.Cloud	Base container definition for Azure cloud.
azure.ResourceGroup	Azure Resource Group definition.

Other Configuration Items

CI	Description
azure.BaseLoadBalancerConfiguration	Base configuration of the load balancer which can be extended.
azure.BaseLoadBalancerConfigurationSpec	Base configuration of the load balancer which can be extended. (deployable)
azure.BaseSecurityRule	Adds a Network security rule to the Network Security Group.
azure.BaseSecurityRuleSpec	Specification for Network security rule.
azure.ContainerInstance	Creates a Container Instance resource in the Container Group.
azure.ContainerInstanceSpec	Container Instance resource
azure.DefaultSecurityRule	Add a Default Network Security Rule to the Network Security Group.
azure.DefaultSecurityRuleSpec	Specification for Default Network Security Rule.
azure.KeyVaultSecret	Creates a Secret within a Keyvault
azure.KeyVaultSecretSpec	Secret within keyvault
azure.LoadBalancerBeAddressPool	Backend address pool configuration of the load balancer.
azure.LoadBalancerBeAddressPoolSpec	Backend address pool configuration of the load balancer
azure.LoadBalancerFeIpConfiguration	Frontend IP address configuration of the load balancer.
azure.LoadBalancerFeIpConfigurationSpec	Frontend IP address configuration of the load balancer
azure.LoadBalancerProbe	Probe definition of the load balancer.
azure.LoadBalancerProbeSpec	Probe definition of the load balancer
azure.LoadBalancerRule	Adds a Load balacer rule to the load balancer.
azure.LoadBalancerRuleSpec	Load balancing rules of the load balancer
azure.NetworkInterfaceIPBeAddressPool	Address pool binding to the network interface IP configuration.
azure.NetworkInterfaceIPBeAddressPoolSpec	Address pool binding to the network interface IP configuration
azure.NetworkInterfaceIPConfiguration	Creates an IPConfiguration in a network interface.
azure.NetworkInterfaceIPConfigurationSpec	Specification for an IPConfiguration in a network interface.
azure.Route	Creates a Route resource in the specified Route Table.
azure.RouteSpec	Route resource
azure.SecurityRule	Adds a Security Rule to the Network Security Group.
azure.SecurityRuleSpec	Specification for Network Security Rule.
azure.Subnet	Creates a Subnet in a VirtualNework resource.
azure.SubnetSpec	Subnet in a VirtualNetwork resource.
azure.WinRMListener	Creates a Win RM Listener in the Virtual Machine.
azure.WinRMListenerSpec	Win RM Listeners
azure.container	List of container definitions for the Container App.
azure.containerAppEnvVariable	Container environment variable.
azure.containerAppEnvVariableSpec	Specification for container environment variable.
azure.containerProbe	List of probes for the container.
azure.containerProbeSpec	Specification for list of probes for the container.
azure.containerSpec	Specification for list of container definitions for the Container App.
azure.containerVolume	Volume definitions for the Container App.
azure.containerVolumeMount	Volume mount for the Container App.
azure.containerVolumeMountSpec	Specification for volume mount for the Container App.
azure.containerVolumeSpec	Volume definitions for the Container App.
azure.ingressCustomDomain	Ingress custom domain mapping.
azure.ingressCustomDomainSpec	Specification for an Ingress custom domain mapping.
azure.ingressIpSecurityRestriction	Rule to restrict incoming IP address.
azure.ingressIpSecurityRestrictionSpec	Specification for a rule to restrict incoming IP address.
azure.ingressTrafficWeight	Traffic weight assigned to a revision.
azure.ingressTrafficWeightSpec	Specification for an Traffic weight assigned to a revision.
azure.initContainer	Container App init container definition.
azure.initContainerSpec	Specification for Container App init container definition.
azure.privateContainerRegistry	Container App Private Registry.
azure.privateContainerRegistrySpec	Specification for Container App Private Registry.
azure.serviceBind	Configuration to bind a ContainerApp to a dev ContainerApp Service.
azure.serviceBindSpec	Specification for Configuration to bind a ContainerApp to a dev ContainerApp Service.
azure.volumeSecret	Secret to be added to volume.
azure.volumeSecretSpec	Volume definitions for the Container App.

Configuration Item Details

azure.AppServicePlan

Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Create an AppServicePlan in the Resource Group.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		location: STRING
		The location of the service plan
		osType: ENUM [Linux, Windows] = Windows
		Operating System
		skuCapacity: INTEGER
		Web Hosting Plan SKU capacity
		skuFamily: STRING = S
		Web Hosting Plan SKU family
		skuName: STRING = S1
		Web Hosting Plan SKU name
		skuSize: STRING = 1
		Web Hosting Plan SKU size
		skuTier: STRING = Basic
		Web Hosting Plan SKU tier
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		servicePlanName: STRING
		Service Plan name. If not specified, the CI name will be used.

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.AppServicePlanSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Create an AppServicePlan in the Resource Group. (deployable)

		Public properties
		location: STRING
		The location of the service plan (string)
		osType: STRING
		Operating System (enum) values(Linux, Windows) default(Windows)
		servicePlanName: STRING
		Service Plan name. If not specified, the CI name will be used. (string)
		skuCapacity: STRING
		Web Hosting Plan SKU capacity (integer) default(0)
		skuFamily: STRING
		Web Hosting Plan SKU family (string) default(S)
		skuName: STRING
		Web Hosting Plan SKU name (string) default(S1)
		skuSize: STRING
		Web Hosting Plan SKU size (string) default(1)
		skuTier: STRING
		Web Hosting Plan SKU tier (string) default(Basic)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

azure.ArtifactPackage

Type Hierarchy	udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer

Uploads an artifact to the specified artifact feed.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		packageVersion: STRING
		The version of the Package to upload. Should follow semantic versioning (example:1.0.1)
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		packageName: STRING
		The name of the Package to upload. If not specified, the CI name will be used. Lower case alpha numneric
		placeholders: MAP_STRING_STRING
		A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.ArtifactPackageSpec

Type Hierarchy	udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.ArchiveArtifact, udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable

Uploads an artifact to the specified artifact feed. (deployable)

		Public properties
		checksum: STRING
		The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
		credentials: CI<credentials.Credentials>
		Credentials of the URI.
		excludeFileNamesRegex: STRING
		Regular expression that matches file names that must be excluded from scanning
		fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
		A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
		fileUri: STRING
		The URI pointing to the (remote) location of the file this artifact represents
		isRescanned: BOOLEAN
		Indicates if the artifact has been rescanned
		packageName: STRING
		The name of the Package to upload. If not specified, the CI name will be used. Lower case alpha numneric (string)
		packageVersion: STRING
		The version of the Package to upload. Should follow semantic versioning (example:1.0.1) (string)
		placeholders: SET_OF_STRING
		Placeholders detected in this artifact
		preScannedPlaceholders: BOOLEAN
		Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
		proxySettings: CI<credentials.ProxySettings>
		Proxy Settings for artifact location
		scanPlaceholders: BOOLEAN
		Whether to scan this artifact to replace placeholders when it is imported
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

		Hidden properties
		textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
		Regular expression that matches file names of text files
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.
		delimiters: STRING = {{ }}
		The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter

Control task	Parameter CI	Attributes	Description
rescanArtifacts		delegate = rescanArtifact	No description.

---

azure.ArtifactsFeed

Type Hierarchy	udm.BaseDeployedContainer >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Container, udm.Deployed, udm.EmbeddedDeployedContainer, udm.Taggable

Creates an Artifact Feed in the given Cloud organization.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		organizationUrl: STRING
		Url of the Devops Organization(example:https://dev.azure.com/organization1)
		scope: ENUM [project, organization] = project
		Scope of the Package
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		feedName: STRING
		The name of the Artifact Feed to create. If not specified, the CI name will be used. The feed name can't contain spaces, start with a '.' or '_', end with a '.', and can't contain any other special characters
		projectName: STRING
		Name of the project in the organization. Mandatory if Scope is project
		tags: SET_OF_STRING
		If set, only deployables with the same tag will be automatically mapped to this container.

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.ArtifactsFeedSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Creates an Artifact Feed in the given Cloud organization. (deployable)

		Public properties
		feedName: STRING
		The name of the Artifact Feed to create. If not specified, the CI name will be used. The feed name can't contain spaces, start with a '.' or '_', end with a '.', and can't contain any other special characters (string)
		organizationUrl: STRING
		Url of the Devops Organization(example:https://dev.azure.com/organization1) (string)
		projectName: STRING
		Name of the project in the organization. Mandatory if Scope is project (string)
		scope: STRING = project
		Scope of the Package (enum) values(project, organization) default(project)
		tags: SET_OF_STRING
		If set, only deployables with the same tag will be automatically mapped to this container. (set_of_string)

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

azure.AvailabilitySet

Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Creates an Availability Set resource in the Resource Group.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		location: STRING
		Resource location.
		sku: ENUM [Classic, Aligned] = Classic
		Specifies whether the availability set is managed or not. Posible values are: Aligned or Classic. Aligned = managed. Classic = unmanaged. Default = Classic.
		availabilitySetName: STRING
		Availability Set name. If not specified, the CI name will be used.
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		faultDomainCount: INTEGER
		Number of fault domains used, must be 3 or less. If not specified, 3 is the default.
		updateDomainCount: INTEGER
		Number of update domains used, must be 5 or more. If not specified, 5 is the default.

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.AvailabilitySetSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Availability Set resource

		Public properties
		availabilitySetName: STRING
		Availability Set name. If not specified, the CI name will be used. (string)
		faultDomainCount: STRING
		Number of fault domains used, must be 3 or less. If not specified, 3 is the default. (integer)
		location: STRING
		Resource location. (string)
		sku: STRING
		Specifies whether the availability set is managed or not. Posible values are: Aligned or Classic. Aligned = managed. Classic = unmanaged. Default = Classic. (enum) values(Classic, Aligned) default(Classic)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		updateDomainCount: STRING
		Number of update domains used, must be 5 or more. If not specified, 5 is the default. (integer)

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

azure.BaseLoadBalancerConfiguration

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Base configuration of the load balancer which can be extended.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.

---

azure.BaseLoadBalancerConfigurationSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Base configuration of the load balancer which can be extended. (deployable)

---

azure.BaseSecurityRule

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Adds a Network security rule to the Network Security Group.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		access: ENUM [Allow, Deny]
		Network traffic is allowed or denied
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		description: STRING
		A description for this rule. Restricted to 140 chars.
		destinationAddressPrefix: STRING
		Destination address prefix. CIDR or source IP range. Asterix ‘*’ can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used.
		destinationPortRange: STRING
		Destination port or range. Integer or range between 0 and 65535. Asterix ‘*’ can also be used to match all ports.
		direction: ENUM [Inbound, Outbound]
		Direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic
		priority: INTEGER = 100
		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.
		protocol: ENUM [*, Tcp, Udp] = *
		Network protocol this rule applies to
		securityRuleName: STRING
		Name of the resource that is unique within a resource group. If not specified, the CI name will be used.
		sourceAddressPrefix: STRING
		CIDR or source IP range. Asterix ‘*’ can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. If this is an ingress rule, specifies where network traffic originates from.
		sourcePortRange: STRING
		Source port or range. Integer or range between 0 and 65535. Asterix ‘*’ can also be used to match all ports.

---

azure.BaseSecurityRuleSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Specification for Network security rule.

		Public properties
		access: STRING
		Network traffic is allowed or denied (enum) values(Allow, Deny)
		description: STRING
		A description for this rule. Restricted to 140 chars. (string)
		destinationAddressPrefix: STRING
		Destination address prefix. CIDR or source IP range. Asterix ‘*’ can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. (string)
		destinationPortRange: STRING
		Destination port or range. Integer or range between 0 and 65535. Asterix ‘*’ can also be used to match all ports. (string)
		direction: STRING
		Direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic (enum) values(Inbound, Outbound)
		priority: STRING = 100
		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. (integer) default(100)
		protocol: STRING = *
		Network protocol this rule applies to (enum) values(*, Tcp, Udp) default(*)
		securityRuleName: STRING
		Name of the resource that is unique within a resource group. If not specified, the CI name will be used. (string)
		sourceAddressPrefix: STRING
		CIDR or source IP range. Asterix ‘*’ can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. If this is an ingress rule, specifies where network traffic originates from. (string)
		sourcePortRange: STRING
		Source port or range. Integer or range between 0 and 65535. Asterix ‘*’ can also be used to match all ports. (string)

---

azure.BaseWebAppExtension

Virtual Type
Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Base Webapp Extension task which can be extended.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		siteExtensionID: STRING
		Site Extension ID. Example: Specify 'Raygun.AzureAppService.Extension' for '.Net Raygun APM' Extension.
		webAppName: STRING
		The name of the web app to bind extension to.
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.BaseWebAppLogging

Virtual Type
Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Base Webapp Logging task which can be extended.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		webAppName: STRING
		The name of the web app to configure logging.
		applicationLoggingBlob: ENUM [Off, On]
		Application Logging (Blob).
		applicationLoggingBlobLevel: ENUM [Error, Warning, Information, Verbose]
		Log Level required if enabling Application Logging (Blob).
		applicationLoggingBlobRetention: INTEGER
		Retention period required if enabling Application Logging (Blob). Remove blobs older than specified days. 0 or lower means no retention.
		applicationLoggingBlobStorage: STRING
		Storage Account URL required if enabling Application Logging (Blob). SAS url to a azure blob container with read/write/list/delete permissions.
		applicationLoggingFileSystem: ENUM [Off, On]
		Application Logging (FileSystem).
		applicationLoggingFileSystemLevel: ENUM [Error, Warning, Information, Verbose]
		Log Level required if enabling Application Logging (FileSystem).
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		detailedErrorMessages: ENUM [Off, On]
		Detailed error messages.
		failedRequestsTracing: ENUM [Off, On]
		Failed requests tracing.
		httpFileSystemQuota: INTEGER = 35
		Quota (in MB) required if enabling Web Server Logging (FileSystem). Maximum size in megabytes that http log files can use. When reached old log files will be removed to make space for new ones.
		httpFileSystemRetention: INTEGER
		Retention period required if enabling Web Server Logging (FileSystem). Remove blobs older than X days. 0 or lower means no retention.
		httpLogs: ENUM [Off, FileSystem, Storage]
		Web Server Logging.
		httpStorageRetention: INTEGER
		Retention period required if enabling Web Server Logging (Storage). Remove blobs older than X days. 0 or lower means no retention.
		httpStorageStorage: STRING
		Storage Account URL required if enabling Web Server Logging (Storage). SAS url to a azure blob container with read/write/list/delete permissions.

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.BaseWebAppSlot

Virtual Type
Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Base Webapp Slot taks which can be extended.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		cloneSettingsFrom: ENUM [Clone configuration from WebApp, Clone configuration from Deployment slot, Do not clone settings]
		Choose the webapp or deployment slot to clone from .
		slotName: STRING
		The name of the new deployment slot to be created.
		webAppName: STRING
		The name of the web app to bind slot to.
		cloneFromDeploymentSlot: STRING
		The name of the deployment slot from which configuration is to be cloned
		cloneFromWebApp: STRING
		The name of the web app from which configuration is to be cloned.
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.BaseWebJob

Virtual Type
Type Hierarchy	udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer

Base Webjob task which can be extended by related types.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		executableFileName: STRING
		The name of the file in the web job zip that must be executed
		webAppName: STRING
		The name of the web app to bind job to
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		placeholders: MAP_STRING_STRING
		A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
		webJobName: STRING
		The name of the web job. If not specified, the CI name will be used.

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.CertificateFile

Type Hierarchy	udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.SourceArtifact, udm.Taggable

Certificate/CA Bundle file to be used for verification

		Public properties
		checksum: STRING
		The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
		credentials: CI<credentials.Credentials>
		Credentials of the URI.
		excludeFileNamesRegex: STRING
		Regular expression that matches file names that must be excluded from scanning
		fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
		A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
		fileUri: STRING
		The URI pointing to the (remote) location of the file this artifact represents
		isRescanned: BOOLEAN
		Indicates if the artifact has been rescanned
		placeholders: SET_OF_STRING
		Placeholders detected in this artifact
		preScannedPlaceholders: BOOLEAN
		Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
		proxySettings: CI<credentials.ProxySettings>
		Proxy Settings for artifact location
		scanPlaceholders: BOOLEAN = true
		Whether to scan this artifact to replace placeholders when it is imported
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

		Hidden properties
		textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
		Regular expression that matches file names of text files
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.
		delimiters: STRING = {{ }}
		The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter

Control task	Parameter CI	Attributes	Description
rescanArtifacts		delegate = rescanArtifact	No description.

---

azure.Cloud

Type Hierarchy	xebialabs.azure.MarkerAzureContainer >> udm.BaseContainer >> udm.BaseConfigurationItem
Interfaces	udm.Container, udm.Taggable

Base container definition for Azure cloud.

		Public properties
		authMethod: ENUM [directory-application-and-service-principal, active-directory-user-password] = active-directory-user-password
		Authorization Method
		subscriptionId: STRING
		Subscription ID
		certificateFile: CI<azure.CertificateFile>
		Certificate file for verification - Ex;
		clientId: STRING
		Client ID to use for the account
		clientKey: STRING
		Client Key to use for the account
		proxyHost: STRING
		Hostname of the proxy server to use while connecting to Azure.
		proxyPassword: STRING
		Password of the proxy server.
		proxyPort: INTEGER
		Port number of the proxy server to use while connecting to Azure.
		proxyProtocol: ENUM [http, https]
		Scheme/protocol of the proxy server to use while connecting to Azure.
		proxyUser: STRING
		Username of the proxy server.
		tags: SET_OF_STRING
		If set, only deployables with the same tag will be automatically mapped to this container.
		tenantId: STRING
		Tenant ID to use for the account
		userName: STRING
		Active Directory UserName to use for the account
		userPassword: STRING
		Active Directory Password to use for the account
		verifySSL: BOOLEAN
		Enable/Disable SSL verification while connecting to Azure.

Control task	Parameter CI	Attributes	Description
checkConnection		delegate = jythonScript, script = xld/azure/check_connection.py	Verify the connection to the Azure Cloud.

---

azure.CloudService

Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Creates a Cloud Service in the Resource Group.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		CloudServiceName: STRING
		The name of the cloud service to create.
		configurationUrl: STRING
		Configuration Url of storage account where it contains .cscfg file
		loadBalancerFrontendIpName: STRING
		Name of Load Balancer Front End IP which will be created
		loadBalancerName: STRING
		Name of Load Balancer which Cloud Service will create
		location: STRING
		cloud service location
		packageUrl: STRING
		Package Url of storage account where it contains .cspkg file
		publicIPAddressName: STRING
		Name of Public IP address which Cloud Service will use. Should already exist
		roleName: STRING
		WebRole Name as mentioned in .cscfg file
		skuCapacity: INTEGER
		Sku capacity as per the sku size name used
		skuName: STRING
		Sku size name as mentioned in .csdef file
		skuTier: STRING
		Sku tier as per the sku size name used
		storageAccount: STRING
		Name of storage account used
		virtualNetwork: STRING
		Name of virtual network used as mentioned in .cscfg file
		CloudServiceTags: MAP_STRING_STRING
		Cloud Service Tags
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.CloudServiceSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Creates a Cloud Service in the Resource Group. (deployable)

		Public properties
		CloudServiceName: STRING
		The name of the cloud service to create. (string)
		CloudServiceTags: MAP_STRING_STRING
		Cloud Service Tags (map_string_string)
		configurationUrl: STRING
		Configuration Url of storage account where it contains .cscfg file (string)
		loadBalancerFrontendIpName: STRING
		Name of Load Balancer Front End IP which will be created (string)
		loadBalancerName: STRING
		Name of Load Balancer which Cloud Service will create (string)
		location: STRING
		cloud service location (string)
		packageUrl: STRING
		Package Url of storage account where it contains .cspkg file (string)
		publicIPAddressName: STRING
		Name of Public IP address which Cloud Service will use. Should already exist (string)
		roleName: STRING
		WebRole Name as mentioned in .cscfg file (string)
		skuCapacity: STRING
		Sku capacity as per the sku size name used (integer)
		skuName: STRING
		Sku size name as mentioned in .csdef file (string)
		skuTier: STRING
		Sku tier as per the sku size name used (string)
		storageAccount: STRING
		Name of storage account used (string)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		virtualNetwork: STRING
		Name of virtual network used as mentioned in .cscfg file (string)

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

azure.ContainerApp

Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Creates a ContainerApp in the Resource Group.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Children
		containers: SET_OF_CI<azure.container>
		List of container definitions for the Container App.
		customDomains: SET_OF_CI<azure.ingressCustomDomain>
		Custom domain bindings for Container Apps' hostnames
		initContainers: SET_OF_CI<azure.initContainer>
		List of specialized containers that run before app containers.
		ipSecurityRestrictions: SET_OF_CI<azure.ingressIpSecurityRestriction>
		Rules to restrict incoming IP address.
		registries: SET_OF_CI<azure.privateContainerRegistry>
		Collection of private container registry credentials for containers used by the Container app.
		serviceBinds: SET_OF_CI<azure.serviceBind>
		List of container app services bound to the app.
		trafficWeights: SET_OF_CI<azure.ingressTrafficWeight>
		Traffic weights assigned to revisions
		volumes: SET_OF_CI<azure.containerVolume>
		Volume definitions for the Container App.

		Public properties
		appPort: INTEGER
		Tells Dapr which port your application is listening on.
		appProtocol: STRING = http
		Tells Dapr which protocol your application is using. Valid options are http and grpc.
		environmentName: STRING
		Name of the managed environment to create the ContainerApp
		httpMaxRequestSize: INTEGER = 4
		Increasing max size of request body http and grpc servers parameter in MB.
		httpReadBufferSize: INTEGER = 65
		Dapr max size of http header read buffer in KB.
		location: STRING
		Location
		logLevel: STRING
		Sets the log level for the Dapr sidecar.
		targetPort: INTEGER
		Target Port in containers for traffic from ingress
		workloadProfileName: STRING
		Workload profile name to pin for container app execution.
		allowCredentials: BOOLEAN
		Specifies whether the resource allows credentials.
		allowInsecure: BOOLEAN
		Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections.
		allowedHeaders: LIST_OF_STRING
		Specifies the content for the access-control-allow-headers header.
		allowedMethods: LIST_OF_STRING
		Specifies the content for the access-control-allow-methods header.
		allowedOrigins: LIST_OF_STRING
		Specifies the content for the access-control-allow-origins header.
		appName: STRING
		The name of the conatainer app to create. If not specified, the CI name will be used.
		appTags: MAP_STRING_STRING
		App Tags
		checkRunningStatePostDeployment: BOOLEAN = true
		Validates if revision is in Running State after deployment.
		clientCertificateMode: STRING = ignore
		Client certificate mode for mTLS authentication.accept|ignore|require
		daprEnabled: BOOLEAN
		Indicates if the Dapr side car is enabled.
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		enableApiLogging: BOOLEAN
		Specifies whether the resource allows credentials.
		exposeHeaders: LIST_OF_STRING
		Specifies the content for the access-control-expose-headers header.
		exposedPort: INTEGER
		Exposed Port in containers for TCP traffic from ingress
		fqdn: STRING
		Hostname
		isExternal: BOOLEAN
		If the app exposes an external http endpoint
		maxAge: INTEGER
		Specifies the content for the access-control-max-age header
		maxInactiveRevisions: INTEGER
		Max inactive revisions a Container App can have
		revisionSuffix: STRING
		User friendly suffix that is appended to the revision name.
		serviceType: STRING
		Dev ContainerApp service type.
		stickySessionsAffinity: BOOLEAN
		Sticky Sessions affinity for Single Revision Mode.
		terminationGracePeriodSeconds: INTEGER
		Optional duration in seconds the Container App Instance needs to terminate gracefully. Value must be non-negative integer.

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.ContainerAppSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Creates a ContainerApp in the Resource Group. (deployable)

		Children
		containers: SET_OF_CI<azure.containerSpec>
		List of container definitions for the Container App.
		customDomains: SET_OF_CI<azure.ingressCustomDomainSpec>
		Custom domain bindings for Container Apps' hostnames
		initContainers: SET_OF_CI<azure.initContainerSpec>
		List of specialized containers that run before app containers.
		ipSecurityRestrictions: SET_OF_CI<azure.ingressIpSecurityRestrictionSpec>
		Rules to restrict incoming IP address.
		registries: SET_OF_CI<azure.privateContainerRegistrySpec>
		Collection of private container registry credentials for containers used by the Container app.
		serviceBinds: SET_OF_CI<azure.serviceBindSpec>
		List of container app services bound to the app.
		trafficWeights: SET_OF_CI<azure.ingressTrafficWeightSpec>
		Traffic weights assigned to revisions
		volumes: SET_OF_CI<azure.containerVolumeSpec>
		Volume definitions for the Container App.

		Public properties
		allowCredentials: STRING
		Specifies whether the resource allows credentials. (boolean) default(false)
		allowInsecure: STRING
		Bool indicating if HTTP connections to is allowed. If set to false HTTP connections are automatically redirected to HTTPS connections. (boolean) default(false)
		allowedHeaders: LIST_OF_STRING
		Specifies the content for the access-control-allow-headers header. (list_of_string)
		allowedMethods: LIST_OF_STRING
		Specifies the content for the access-control-allow-methods header. (list_of_string)
		allowedOrigins: LIST_OF_STRING
		Specifies the content for the access-control-allow-origins header. (list_of_string)
		appName: STRING
		The name of the conatainer app to create. If not specified, the CI name will be used. (string)
		appPort: STRING
		Tells Dapr which port your application is listening on. (integer) default(0)
		appProtocol: STRING
		Tells Dapr which protocol your application is using. Valid options are http and grpc. (string) default(http)
		appTags: MAP_STRING_STRING
		App Tags (map_string_string)
		checkRunningStatePostDeployment: STRING
		Validates if revision is in Running State after deployment. (boolean) default(true)
		clientCertificateMode: STRING
		Client certificate mode for mTLS authentication.accept|ignore|require (string) default(ignore)
		daprEnabled: STRING
		Indicates if the Dapr side car is enabled. (boolean) default(false)
		enableApiLogging: STRING
		Specifies whether the resource allows credentials. (boolean) default(false)
		environmentName: STRING
		Name of the managed environment to create the ContainerApp (string)
		exposeHeaders: LIST_OF_STRING
		Specifies the content for the access-control-expose-headers header. (list_of_string)
		exposedPort: STRING
		Exposed Port in containers for TCP traffic from ingress (integer) default(0)
		fqdn: STRING
		Hostname (string)
		httpMaxRequestSize: STRING
		Increasing max size of request body http and grpc servers parameter in MB. (integer) default(4)
		httpReadBufferSize: STRING
		Dapr max size of http header read buffer in KB. (integer) default(65)
		isExternal: STRING
		If the app exposes an external http endpoint (boolean) default(false)
		location: STRING
		Location (string)
		logLevel: STRING
		Sets the log level for the Dapr sidecar. (string)
		maxAge: STRING
		Specifies the content for the access-control-max-age header (integer) default(0)
		maxInactiveRevisions: STRING
		Max inactive revisions a Container App can have (integer) default(0)
		revisionSuffix: STRING
		User friendly suffix that is appended to the revision name. (string)
		serviceType: STRING
		Dev ContainerApp service type. (string)
		stickySessionsAffinity: STRING
		Sticky Sessions affinity for Single Revision Mode. (boolean) default(false)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		targetPort: STRING
		Target Port in containers for traffic from ingress (integer) default(0)
		terminationGracePeriodSeconds: STRING
		Optional duration in seconds the Container App Instance needs to terminate gracefully. Value must be non-negative integer. (integer) default(0)
		workloadProfileName: STRING
		Workload profile name to pin for container app execution. (string)

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

azure.ContainerGroup

Type Hierarchy	udm.BaseProvisioned >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer, udm.Provisioned

Creates a Container Group resource in the Resource Group.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Children
		containers: SET_OF_CI<azure.ContainerInstance>
		Containers Definition
		provisioners: LIST_OF_CI<udm.AppliedProvisioner>
		A list of provisioners associated with the instance.

		Public properties
		location: STRING
		Resource location.
		osType: STRING = linux
		Base OS to use
		boundConfigurationItems: SET_OF_CI<udm.BaseConfigurationItem>
		The set of created CIs.
		containerGroupName: STRING
		Container group name. If not specified, the CI name will be used.
		containerGroupTags: MAP_STRING_STRING
		Tags
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		ipAddress: STRING
		IP address of the container group
		ports: LIST_OF_STRING
		Ports to expose with container group

		Hidden properties
		ordinal: INTEGER = 1
		The index of the cardinality amount created provisioneds.

---

azure.ContainerGroupSpec

Type Hierarchy	udm.BaseProvisionable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Provisionable, udm.Taggable

Container Group resource

		Children
		containers: SET_OF_CI<azure.ContainerInstanceSpec>
		Containers Definition
		provisioners: LIST_OF_CI<udm.Provisioner>
		A list of provisioners associated with the instance.

		Public properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.
		containerGroupName: STRING
		Container group name. If not specified, the CI name will be used. (string)
		containerGroupTags: MAP_STRING_STRING
		Tags (map_string_string)
		ipAddress: STRING
		IP address of the container group (string)
		location: STRING
		Resource location. (string)
		osType: STRING = linux
		Base OS to use (string) default(linux)
		ports: LIST_OF_STRING
		Ports to expose with container group (list_of_string)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

		Hidden properties
		cardinality: STRING = 1
		Number of instances to launch.

---

azure.ContainerInstance

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Creates a Container Instance resource in the Container Group.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		containerImage: STRING
		Image to be used (repo/image:tag)
		containerName: STRING
		Container name. If not specified, the CI name will be used.
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		environmentVariables: MAP_STRING_STRING
		Environment variables
		ports: LIST_OF_STRING
		Ports to expose with container group
		registryPassword: STRING
		Password to use when authenticating with the registry.
		registryUrl: STRING
		URL of the registry. For example: https://index.docker.io/v1/
		registryUsername: STRING
		User name to use when authenticating with the registry.
		resourceLimitsCpu: INTEGER = 2
		CPU limits of this container
		resourceLimitsMemoryGb: INTEGER = 2
		The memory limits in GB of this container
		resourceRequestsCpu: INTEGER = 1
		CPU request of this container
		resourceRequestsMemoryGb: INTEGER = 1
		The memory request in GB of this container

---

azure.ContainerInstanceSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Container Instance resource

		Public properties
		containerImage: STRING
		Image to be used (repo/image:tag) (string)
		containerName: STRING
		Container name. If not specified, the CI name will be used. (string)
		environmentVariables: MAP_STRING_STRING
		Environment variables (map_string_string)
		ports: LIST_OF_STRING
		Ports to expose with container group (list_of_string)
		registryPassword: STRING
		Password to use when authenticating with the registry. (string)
		registryUrl: STRING
		URL of the registry. For example: https://index.docker.io/v1/ (string)
		registryUsername: STRING
		User name to use when authenticating with the registry. (string)
		resourceLimitsCpu: STRING = 2
		CPU limits of this container (integer) default(2)
		resourceLimitsMemoryGb: STRING = 2
		The memory limits in GB of this container (integer) default(2)
		resourceRequestsCpu: STRING = 1
		CPU request of this container (integer) default(1)
		resourceRequestsMemoryGb: STRING = 1
		The memory request in GB of this container (integer) default(1)

---

azure.ContinuousWebJob

Type Hierarchy	azure.BaseWebJob >> udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer

Creates a Continuous Web Job in the resource group.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		executableFileName: STRING
		The name of the file in the web job zip that must be executed
		webAppName: STRING
		The name of the web app to bind job to
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		isSingleton: BOOLEAN
		If a continuous job is set as singleton it'll run only on a single instance opposed to running on all instances. By default, it runs on all instances.
		placeholders: MAP_STRING_STRING
		A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
		webJobName: STRING
		The name of the web job. If not specified, the CI name will be used.

		Hidden properties
		jobType: STRING = continuouswebjobs
		Job Type
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.ContinuousWebJobSpec

Type Hierarchy	udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable

Creates a Continuous Web Job in the resource group. (deployable)

		Public properties
		checksum: STRING
		The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
		credentials: CI<credentials.Credentials>
		Credentials of the URI.
		excludeFileNamesRegex: STRING
		Regular expression that matches file names that must be excluded from scanning
		executableFileName: STRING
		The name of the file in the web job zip that must be executed (string)
		fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
		A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
		fileUri: STRING
		The URI pointing to the (remote) location of the file this artifact represents
		isRescanned: BOOLEAN
		Indicates if the artifact has been rescanned
		isSingleton: STRING
		If a continuous job is set as singleton it'll run only on a single instance opposed to running on all instances. By default, it runs on all instances. (boolean) default(false)
		placeholders: SET_OF_STRING
		Placeholders detected in this artifact
		preScannedPlaceholders: BOOLEAN
		Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
		proxySettings: CI<credentials.ProxySettings>
		Proxy Settings for artifact location
		scanPlaceholders: BOOLEAN = true
		Whether to scan this artifact to replace placeholders when it is imported
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		webAppName: STRING
		The name of the web app to bind job to (string)
		webJobName: STRING
		The name of the web job. If not specified, the CI name will be used. (string)

		Hidden properties
		textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
		Regular expression that matches file names of text files
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.
		delimiters: STRING = {{ }}
		The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter

Control task	Parameter CI	Attributes	Description
rescanArtifacts		delegate = rescanArtifact	No description.

---

azure.DefaultSecurityRule

Type Hierarchy	azure.BaseSecurityRule >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Add a Default Network Security Rule to the Network Security Group.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		access: ENUM [Allow, Deny]
		Network traffic is allowed or denied
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		description: STRING
		A description for this rule. Restricted to 140 chars.
		destinationAddressPrefix: STRING
		Destination address prefix. CIDR or source IP range. Asterix ‘*’ can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used.
		destinationPortRange: STRING
		Destination port or range. Integer or range between 0 and 65535. Asterix ‘*’ can also be used to match all ports.
		direction: ENUM [Inbound, Outbound]
		Direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic
		priority: INTEGER = 100
		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.
		protocol: ENUM [*, Tcp, Udp] = *
		Network protocol this rule applies to
		securityRuleName: STRING
		Name of the resource that is unique within a resource group. If not specified, the CI name will be used.
		sourceAddressPrefix: STRING
		CIDR or source IP range. Asterix ‘*’ can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. If this is an ingress rule, specifies where network traffic originates from.
		sourcePortRange: STRING
		Source port or range. Integer or range between 0 and 65535. Asterix ‘*’ can also be used to match all ports.

---

azure.DefaultSecurityRuleSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Specification for Default Network Security Rule.

		Public properties
		access: STRING
		Network traffic is allowed or denied (enum) values(Allow, Deny)
		description: STRING
		A description for this rule. Restricted to 140 chars. (string)
		destinationAddressPrefix: STRING
		Destination address prefix. CIDR or source IP range. Asterix ‘*’ can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. (string)
		destinationPortRange: STRING
		Destination port or range. Integer or range between 0 and 65535. Asterix ‘*’ can also be used to match all ports. (string)
		direction: STRING
		Direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic (enum) values(Inbound, Outbound)
		priority: STRING = 100
		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. (integer) default(100)
		protocol: STRING = *
		Network protocol this rule applies to (enum) values(*, Tcp, Udp) default(*)
		securityRuleName: STRING
		Name of the resource that is unique within a resource group. If not specified, the CI name will be used. (string)
		sourceAddressPrefix: STRING
		CIDR or source IP range. Asterix ‘*’ can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. If this is an ingress rule, specifies where network traffic originates from. (string)
		sourcePortRange: STRING
		Source port or range. Integer or range between 0 and 65535. Asterix ‘*’ can also be used to match all ports. (string)

---

azure.FunctionApp

Type Hierarchy	udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer

Creates a Function App in the Resource Group.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		location: STRING
		Function app location.
		osType: ENUM [Linux, Windows] = Windows
		Operating System
		servicePlanName: STRING
		Name of the associated service plan to create
		storageAccount: STRING
		Storage account name for this function app.
		allowedOrigins: LIST_OF_STRING
		List of allowed origins. If set, will remove the defaults provided by Azure and set the value that the user specified.
		appName: STRING
		Name of the function app to create. If not specified, the CI name will be used.
		appSettings: MAP_STRING_STRING
		List of Application Settings.
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		extensionVersion: STRING = ~1
		Functions Extension Version
		function_app_url: STRING
		Base url for all functions part of this app.
		isHttpsOnly: BOOLEAN
		Set True to redirect all HTTP traffic to HTTPS
		linuxFxVersion: STRING
		Example JAVA|11-java11 or DOCKER. Mandatory for linux os type
		placeholders: MAP_STRING_STRING
		A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
		workerRuntime: STRING
		Example Java, Python

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.FunctionAppCode

Type Hierarchy	udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer

Uploads FunctionAppCode to the Resource Group.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		location: STRING
		Function app location.
		osType: ENUM [Linux, Windows] = Windows
		Operating System
		servicePlanName: STRING
		Name of the associated service plan to create
		storageAccount: STRING
		Storage account name for this function app.
		allowedOrigins: LIST_OF_STRING
		List of allowed origins. If set, will remove the defaults provided by Azure and set the value that the user specified.
		appName: STRING
		Name of the function app to create. If not specified, the CI name will be used.
		appSettings: MAP_STRING_STRING
		List of Application Settings.
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		deploymentSlot: STRING
		Name of the deployment slot to create.
		deploymentSlotUrl: STRING
		Deployment Slot url under the Function App.
		extensionVersion: STRING = ~1
		Functions Extension Version
		isHttpsOnly: BOOLEAN
		Set True to redirect all HTTP traffic to HTTPS
		linuxFxVersion: STRING
		Example JAVA|11-java11 or DOCKER. Mandatory for linux os type
		placeholders: MAP_STRING_STRING
		A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
		workerRuntime: STRING
		Example Java, Python

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.FunctionAppCodeSpec

Type Hierarchy	udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable

Uploads FunctionAppCode to the Resource Group. (deployable)

		Public properties
		allowedOrigins: LIST_OF_STRING
		List of allowed origins. If set, will remove the defaults provided by Azure and set the value that the user specified. (list_of_string)
		appName: STRING
		Name of the function app to create. If not specified, the CI name will be used. (string)
		appSettings: MAP_STRING_STRING
		List of Application Settings. (map_string_string)
		checksum: STRING
		The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
		credentials: CI<credentials.Credentials>
		Credentials of the URI.
		deploymentSlot: STRING
		Name of the deployment slot to create. (string)
		deploymentSlotUrl: STRING
		Deployment Slot url under the Function App. (string)
		excludeFileNamesRegex: STRING
		Regular expression that matches file names that must be excluded from scanning
		extensionVersion: STRING
		Functions Extension Version (string) default(~1)
		fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
		A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
		fileUri: STRING
		The URI pointing to the (remote) location of the file this artifact represents
		isHttpsOnly: STRING
		Set True to redirect all HTTP traffic to HTTPS (boolean) default(false)
		isRescanned: BOOLEAN
		Indicates if the artifact has been rescanned
		linuxFxVersion: STRING
		Example JAVA|11-java11 or DOCKER. Mandatory for linux os type (string)
		location: STRING
		Function app location. (string)
		osType: STRING
		Operating System (enum) values(Linux, Windows) default(Windows)
		placeholders: SET_OF_STRING
		Placeholders detected in this artifact
		preScannedPlaceholders: BOOLEAN
		Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
		proxySettings: CI<credentials.ProxySettings>
		Proxy Settings for artifact location
		scanPlaceholders: BOOLEAN = true
		Whether to scan this artifact to replace placeholders when it is imported
		servicePlanName: STRING
		Name of the associated service plan to create (string)
		storageAccount: STRING
		Storage account name for this function app. (string)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		workerRuntime: STRING
		Example Java, Python (string)

		Hidden properties
		textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
		Regular expression that matches file names of text files
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.
		delimiters: STRING = {{ }}
		The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter

Control task	Parameter CI	Attributes	Description
rescanArtifacts		delegate = rescanArtifact	No description.

---

azure.FunctionAppContainer

Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Creates a Function App as a custom Docker Container in the Resource Group.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		dockerCustomImageName: STRING
		Docker Image Name
		dockerRegistryUrl: STRING
		Docker Registry url
		location: STRING
		Function app location.
		osType: ENUM [Linux] = Linux
		Operating System
		servicePlanName: STRING
		Name of the associated service plan (Should be created manually beforehand)
		storageAccount: STRING
		Storage account name for this function app.
		allowedOrigins: LIST_OF_STRING
		List of allowed origins. If set, will remove the defaults provided by Azure and set the value that the user specified.
		appName: STRING
		Name of the function app to create. If not specified, the CI name will be used.
		appSettings: MAP_STRING_STRING
		List of Application Settings.
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		dockerRegistryPassword: STRING
		Docker Registry Password
		dockerRegistryUsername: STRING
		Docker Registry Username
		function_app_url: STRING
		Base url for all functions part of this app.
		isHttpsOnly: BOOLEAN
		Set True to redirect all HTTP traffic to HTTPS
		linuxFxVersion: STRING
		Example JAVA|11-java11 or DOCKER. Mandatory for linux os type

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.FunctionAppContainerSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Creates a Function App as a custom Docker Container in the Resource Group. (deployable)

		Public properties
		allowedOrigins: LIST_OF_STRING
		List of allowed origins. If set, will remove the defaults provided by Azure and set the value that the user specified. (list_of_string)
		appName: STRING
		Name of the function app to create. If not specified, the CI name will be used. (string)
		appSettings: MAP_STRING_STRING
		List of Application Settings. (map_string_string)
		dockerCustomImageName: STRING
		Docker Image Name (string)
		dockerRegistryPassword: STRING
		Docker Registry Password (string)
		dockerRegistryUrl: STRING
		Docker Registry url (string)
		dockerRegistryUsername: STRING
		Docker Registry Username (string)
		function_app_url: STRING
		Base url for all functions part of this app. (string)
		isHttpsOnly: STRING
		Set True to redirect all HTTP traffic to HTTPS (boolean) default(false)
		linuxFxVersion: STRING
		Example JAVA|11-java11 or DOCKER. Mandatory for linux os type (string)
		location: STRING
		Function app location. (string)
		osType: STRING
		Operating System (enum) values(Linux) default(Linux)
		servicePlanName: STRING
		Name of the associated service plan (Should be created manually beforehand) (string)
		storageAccount: STRING
		Storage account name for this function app. (string)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

azure.FunctionAppSlot

Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Creates a Function App Deployment Slot in the resource group.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		functionAppName: STRING
		The name of the function app to bind slot to.
		slotName: STRING
		The name of the new deployment slot to be created.
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.FunctionAppSlotSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Creates a Function App Deployment Slot in the resource group. (deployable)

		Public properties
		functionAppName: STRING
		The name of the function app to bind slot to. (string)
		slotName: STRING
		The name of the new deployment slot to be created. (string)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

azure.FunctionAppZip

Type Hierarchy	udm.BaseDeployableArchiveArtifact >> udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.ArchiveArtifact, udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable

Creates a Function App in the Resource Group. (deployable)

		Public properties
		allowedOrigins: LIST_OF_STRING
		List of allowed origins. If set, will remove the defaults provided by Azure and set the value that the user specified. (list_of_string)
		appName: STRING
		Name of the function app to create. If not specified, the CI name will be used. (string)
		appSettings: MAP_STRING_STRING
		List of Application Settings. (map_string_string)
		checksum: STRING
		The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
		credentials: CI<credentials.Credentials>
		Credentials of the URI.
		excludeFileNamesRegex: STRING
		Regular expression that matches file names that must be excluded from scanning
		extensionVersion: STRING
		Functions Extension Version (string) default(~1)
		fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
		A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
		fileUri: STRING
		The URI pointing to the (remote) location of the file this artifact represents
		function_app_url: STRING
		Base url for all functions part of this app. (string)
		isHttpsOnly: STRING
		Set True to redirect all HTTP traffic to HTTPS (boolean) default(false)
		isRescanned: BOOLEAN
		Indicates if the artifact has been rescanned
		linuxFxVersion: STRING
		Example JAVA|11-java11 or DOCKER. Mandatory for linux os type (string)
		location: STRING
		Function app location. (string)
		osType: STRING
		Operating System (enum) values(Linux, Windows) default(Windows)
		placeholders: SET_OF_STRING
		Placeholders detected in this artifact
		preScannedPlaceholders: BOOLEAN
		Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
		proxySettings: CI<credentials.ProxySettings>
		Proxy Settings for artifact location
		scanPlaceholders: BOOLEAN
		Whether to scan this artifact to replace placeholders when it is imported
		servicePlanName: STRING
		Name of the associated service plan to create (string)
		storageAccount: STRING
		Storage account name for this function app. (string)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		workerRuntime: STRING
		Example Java, Python (string)

		Hidden properties
		textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
		Regular expression that matches file names of text files
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.
		delimiters: STRING = {{ }}
		The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter

Control task	Parameter CI	Attributes	Description
rescanArtifacts		delegate = rescanArtifact	No description.

---

azure.KeyVault

Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Creates a key vault storage within resource group

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Children
		secrets: SET_OF_CI<azure.KeyVaultSecret>
		A list of secrets within key vault

		Public properties
		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
		sku: STRING = standard
		SKU details
		tenantId: STRING
		The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		enabledForDeployment: BOOLEAN = true
		Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault.
		enabledForTemplateDeployment: BOOLEAN = true
		Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault
		keyVaultName: STRING
		Key Vault Name. If not specified, the CI name will be used.

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.KeyVaultSecret

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Creates a Secret within a Keyvault

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		secretName: STRING
		Name of the secret
		secretValue: STRING
		Value of the secret
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.

---

azure.KeyVaultSecretSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Secret within keyvault

		Public properties
		secretName: STRING
		Name of the secret (string)
		secretValue: STRING
		Value of the secret (string)

---

azure.KeyVaultSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

A key vault storage within resource group

		Children
		secrets: SET_OF_CI<azure.KeyVaultSecretSpec>
		A list of secrets.

		Public properties
		enabledForDeployment: STRING = True
		Property to specify whether Azure Virtual Machines are permitted to retrieve certificates stored as secrets from the key vault. (boolean) default(true)
		enabledForTemplateDeployment: STRING = True
		Property to specify whether Azure Resource Manager is permitted to retrieve secrets from the key vault (boolean) default(true)
		keyVaultName: STRING
		Key Vault Name. If not specified, the CI name will be used. (string)
		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 (string)
		sku: STRING = standard
		SKU details (string) default(standard)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		tenantId: STRING
		The Azure Active Directory tenant ID that should be used for authenticating requests to the key vault (string)

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

azure.LoadBalancer

Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Creates a Load Balancer resource in the Resource Group.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Children
		backendAddressPools: SET_OF_CI<azure.LoadBalancerBeAddressPool>
		Backend address pools used by a load balancer
		frontendIpConfigurations: SET_OF_CI<azure.LoadBalancerFeIpConfiguration>
		Frontend IPs used for the load balancer
		loadBalancingProbes: SET_OF_CI<azure.LoadBalancerProbe>
		Probes used in the load balancer
		loadBalancingRules: SET_OF_CI<azure.LoadBalancerRule>
		Load balancing rules

		Public properties
		location: STRING
		Resource location.
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		loadBalancerName: STRING
		Load Balancer name. If not specified, the CI name will be used.

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.LoadBalancerBeAddressPool

Type Hierarchy	azure.BaseLoadBalancerConfiguration >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Backend address pool configuration of the load balancer.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		backendAddressPoolName: STRING
		Name of the address pool
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.

---

azure.LoadBalancerBeAddressPoolSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Backend address pool configuration of the load balancer

		Public properties
		backendAddressPoolName: STRING
		Name of the address pool (string)

---

azure.LoadBalancerFeIpConfiguration

Type Hierarchy	azure.BaseLoadBalancerConfiguration >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Frontend IP address configuration of the load balancer.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		frontendIpConfigurationName: STRING
		Name of the frontend IP configuration
		privateIpAllocationMethod: ENUM [Static, Dynamic] = Dynamic
		Defines how a private IP address is assigned
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		frontendIpName: STRING
		Name of the public IP address it refers to. Must already be deployed in advance

		Hidden properties
		loadBalancerName: STRING
		Load Balancer name. If not specified, the CI name will be used.

---

azure.LoadBalancerFeIpConfigurationSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Frontend IP address configuration of the load balancer

		Public properties
		frontendIpConfigurationName: STRING
		Name of the frontend IP configuration (string)
		frontendIpName: STRING
		Name of the public IP address it refers to. Must already be deployed in advance (string)
		privateIpAllocationMethod: STRING
		Defines how a private IP address is assigned (enum) values(Static, Dynamic) default(Dynamic)

---

azure.LoadBalancerProbe

Type Hierarchy	azure.BaseLoadBalancerConfiguration >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Probe definition of the load balancer.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		loadBalancingProbeName: STRING
		Name of the load balancing probe
		loadBalancingProbePort: STRING
		Port of the load balancing probe
		loadBalancingProbeProtocol: ENUM [tcp, http] = tcp
		Protocol of the load balancing probe
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		loadBalancingProbePath: STRING
		Path of the load balancing probe (only applicaple to HTTP probes)

---

azure.LoadBalancerProbeSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Probe definition of the load balancer

		Public properties
		loadBalancingProbeName: STRING
		Name of the load balancing probe (string)
		loadBalancingProbePath: STRING
		Path of the load balancing probe (only applicaple to HTTP probes) (string)
		loadBalancingProbePort: STRING
		Port of the load balancing probe (string)
		loadBalancingProbeProtocol: STRING
		Protocol of the load balancing probe (enum) values(tcp, http) default(tcp)

---

azure.LoadBalancerRule

Type Hierarchy	azure.BaseLoadBalancerConfiguration >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Adds a Load balacer rule to the load balancer.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		loadBalancingProbe: STRING
		Probe used by this rule
		loadBalancingRuleBackendAddressPool: STRING
		Backend address pool used by this rule
		loadBalancingRuleBackendPort: INTEGER
		Backend port number of the load balancing rule
		loadBalancingRuleFrontendIpConfiguration: STRING
		Frontend IP configuration used by this rule
		loadBalancingRuleFrontendPort: INTEGER
		Frontend port number of the load balancing rule
		loadBalancingRuleName: STRING
		Name of the load balancing rule
		loadBalancingRuleProtocol: ENUM [all, tcp, udp] = all
		Protocol of the load balancing rule
		loadBalancingRuleTimeout: INTEGER
		Idle timeout in minutes of the load balancing rule
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.

---

azure.LoadBalancerRuleSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Load balancing rules of the load balancer

		Public properties
		loadBalancingProbe: STRING
		Probe used by this rule (string)
		loadBalancingRuleBackendAddressPool: STRING
		Backend address pool used by this rule (string)
		loadBalancingRuleBackendPort: STRING
		Backend port number of the load balancing rule (integer)
		loadBalancingRuleFrontendIpConfiguration: STRING
		Frontend IP configuration used by this rule (string)
		loadBalancingRuleFrontendPort: STRING
		Frontend port number of the load balancing rule (integer)
		loadBalancingRuleName: STRING
		Name of the load balancing rule (string)
		loadBalancingRuleProtocol: STRING
		Protocol of the load balancing rule (enum) values(all, tcp, udp) default(all)
		loadBalancingRuleTimeout: STRING
		Idle timeout in minutes of the load balancing rule (integer)

---

azure.LoadBalancerSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Load Balancer resource

		Children
		backendAddressPools: SET_OF_CI<azure.LoadBalancerBeAddressPoolSpec>
		Backend address pools used by a load balancer
		frontendIpConfigurations: SET_OF_CI<azure.LoadBalancerFeIpConfigurationSpec>
		Frontend IPs used for the load balancer
		loadBalancingProbes: SET_OF_CI<azure.LoadBalancerProbeSpec>
		Probes used in the load balancer
		loadBalancingRules: SET_OF_CI<azure.LoadBalancerRuleSpec>
		Load balancing rules

		Public properties
		loadBalancerName: STRING
		Load Balancer name. If not specified, the CI name will be used. (string)
		location: STRING
		Resource location. (string)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

azure.NetworkInterface

Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Creates a network interface in a resource group.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Children
		ipConfigurations: SET_OF_CI<azure.NetworkInterfaceIPConfiguration>
		A list of IPConfigurations of the network interface.

		Public properties
		location: STRING
		Resource location.
		appliedDnsServers: LIST_OF_STRING
		If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs.
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		dnsServers: LIST_OF_STRING
		List of DNS servers IP addresses. Use ‘AzureProvidedDNS’ to switch to azure provided DNS resolution. ‘AzureProvidedDNS’ value cannot be combined with other IPs, it must be the only value in dnsServers collection.
		dnsSettingsEnable: BOOLEAN
		Activate dns settings
		enableIpForwarding: BOOLEAN
		Indicates whether IP forwarding is enabled on this network interface
		internalDnsNameLabel: STRING
		Relative DNS name for this NIC used for internal communications between VMs in the same virtual network.
		internalDomainNameSuffix: STRING
		Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix.
		internalFqdn: STRING
		Fully qualified DNS name supporting internal communications between VMs in the same virtual network.
		macAddress: STRING
		The MAC address of the network interface.
		networkInterfaceName: STRING
		Network Interface Name. If not specified, the CI name will be used.
		networkInterfaceTags: MAP_STRING_STRING
		tags
		networkSecurityGroupName: STRING
		The reference of the NetworkSecurityGroup resource.
		primary: BOOLEAN
		Gets whether this is a primary network interface on a virtual machine

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.NetworkInterfaceIPBeAddressPool

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Address pool binding to the network interface IP configuration.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		LoadBalancerBeAddressPool: STRING
		Name of the address pool contained in the load balancer.
		loadBalancerName: STRING
		Load balancer name.
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.

---

azure.NetworkInterfaceIPBeAddressPoolSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Address pool binding to the network interface IP configuration

		Public properties
		LoadBalancerBeAddressPool: STRING
		Name of the address pool contained in the load balancer. (string)
		loadBalancerName: STRING
		Load balancer name. (string)

---

azure.NetworkInterfaceIPConfiguration

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Creates an IPConfiguration in a network interface.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Children
		backendAddressPools: SET_OF_CI<azure.NetworkInterfaceIPBeAddressPool>
		Backend address pools used by a load balancer

		Public properties
		privateIpAllocationMethod: ENUM [Static, Dynamic] = Dynamic
		Defines how a private IP address is assigned
		subnet: STRING
		Subnet name in Virtual Network above
		virtualNetworkName: STRING
		Virtual Network Name
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		networkInterfaceIPConfigurationName: STRING
		The name of the resource that is unique within a resource group. This name can be used to access the resource.
		primary: BOOLEAN
		Gets whether this is a primary customer address on the network interface.
		privateIpAddress: STRING
		The private ip address, leave empty for auto assign
		privateIpAddressVersion: ENUM [IPv4, IPv6] = IPv4
		Represents whether the specific ipconfiguration is IPv4 or IPv6
		publicIpAddress: STRING
		Name of the public ip address resource

---

azure.NetworkInterfaceIPConfigurationSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Specification for an IPConfiguration in a network interface.

		Children
		backendAddressPools: SET_OF_CI<azure.NetworkInterfaceIPBeAddressPoolSpec>
		Backend address pools used by a load balancer

		Public properties
		networkInterfaceIPConfigurationName: STRING
		The name of the resource that is unique within a resource group. This name can be used to access the resource. (string)
		primary: STRING
		Gets whether this is a primary customer address on the network interface. (boolean)
		privateIpAddress: STRING
		The private ip address, leave empty for auto assign (string)
		privateIpAddressVersion: STRING = IPv4
		Represents whether the specific ipconfiguration is IPv4 or IPv6 (enum) values(IPv4, IPv6) default(IPv4)
		privateIpAllocationMethod: STRING = Dynamic
		Defines how a private IP address is assigned (enum) values(Static, Dynamic) default(Dynamic)
		publicIpAddress: STRING
		Name of the public ip address resource (string)
		subnet: STRING
		Subnet name in Virtual Network above (string)
		virtualNetworkName: STRING
		Virtual Network Name (string)

---

azure.NetworkInterfaceSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

A network interface in a resource group

		Children
		ipConfigurations: SET_OF_CI<azure.NetworkInterfaceIPConfigurationSpec>
		A list of IPConfigurations of the network interface.

		Public properties
		appliedDnsServers: LIST_OF_STRING
		If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs. (list_of_string)
		dnsServers: LIST_OF_STRING
		List of DNS servers IP addresses. Use ‘AzureProvidedDNS’ to switch to azure provided DNS resolution. ‘AzureProvidedDNS’ value cannot be combined with other IPs, it must be the only value in dnsServers collection. (list_of_string)
		dnsSettingsEnable: STRING = false
		Activate dns settings (boolean) default(false)
		enableIpForwarding: STRING
		Indicates whether IP forwarding is enabled on this network interface (boolean)
		internalDnsNameLabel: STRING
		Relative DNS name for this NIC used for internal communications between VMs in the same virtual network. (string)
		internalDomainNameSuffix: STRING
		Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix. (string)
		internalFqdn: STRING
		Fully qualified DNS name supporting internal communications between VMs in the same virtual network. (string)
		location: STRING
		Resource location. (string)
		macAddress: STRING
		The MAC address of the network interface. (string)
		networkInterfaceName: STRING
		Network Interface Name. If not specified, the CI name will be used. (string)
		networkInterfaceTags: MAP_STRING_STRING
		tags (map_string_string)
		networkSecurityGroupName: STRING
		The reference of the NetworkSecurityGroup resource. (string)
		primary: STRING
		Gets whether this is a primary network interface on a virtual machine (boolean)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

azure.NetworkSecurityGroup

Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Ad a Network Security Group to the Resource Group.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Children
		defaultSecurityRules: SET_OF_CI<azure.DefaultSecurityRule>
		A collection of default security rules for the network security group.
		securityRules: SET_OF_CI<azure.SecurityRule>
		A collection of security rules for the network security group.

		Public properties
		location: STRING
		Location
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		networkSecurityGroupTags: MAP_STRING_STRING
		Tags
		securityGroupName: STRING
		Security Group Name. If not specified, the CI name will be used.

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.NetworkSecurityGroupSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Specification for Network Security Group.

		Children
		defaultSecurityRules: SET_OF_CI<azure.DefaultSecurityRuleSpec>
		A collection of default security rules for the network security group.
		securityRules: SET_OF_CI<azure.SecurityRuleSpec>
		A collection of security rules for the network security group.

		Public properties
		location: STRING
		Location (string)
		networkSecurityGroupTags: MAP_STRING_STRING
		Tags (map_string_string)
		securityGroupName: STRING
		Security Group Name. If not specified, the CI name will be used. (string)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

azure.PublicIpAddress

Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Creates an Azure Public Ip Address in the given Resource Group.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		location: STRING
		Location
		publicIpAddressAllocationMethod: ENUM [Static, Dynamic] = Dynamic
		Public IP allocation method
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		publicIpAddressIdleTimeoutInMinutes: INTEGER = 4
		Idle timeout of the public IP address 4 .. 30
		publicIpAddressName: STRING
		Resource name. If not specified, the CI name will be used.
		publicIpAddressTags: MAP_STRING_STRING
		Tags
		publicIpAddressVersion: ENUM [IPv4, IPv6] = IPv4
		Public IP address version

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.PublicIpAddressSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Specification for an Azure Public Ip Address.

		Public properties
		location: STRING
		Location (string)
		publicIpAddressAllocationMethod: STRING = Dynamic
		Public IP allocation method (enum) values(Static, Dynamic) default(Dynamic)
		publicIpAddressIdleTimeoutInMinutes: STRING = 4
		Idle timeout of the public IP address 4 .. 30 (integer) default(4)
		publicIpAddressName: STRING
		Resource name. If not specified, the CI name will be used. (string)
		publicIpAddressTags: MAP_STRING_STRING
		Tags (map_string_string)
		publicIpAddressVersion: STRING = IPv4
		Public IP address version (enum) values(IPv4, IPv6) default(IPv4)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

azure.ResourceGroup

Type Hierarchy	udm.BaseDeployedContainer >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Container, udm.Deployed, udm.EmbeddedDeployedContainer, udm.Taggable

Azure Resource Group definition.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		location: STRING
		Location
		certificateFile: CI<azure.CertificateFile>
		Certificate file for verification
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		maxRetries: INTEGER = 500
		Number of times the script waits for Resource Group to be created. 5 seconds interval.
		resourceGroupName: STRING
		Name of the Resource Group. If not specified, the CI name will be used.
		resourceGroupTags: MAP_STRING_STRING
		Tags
		tags: SET_OF_STRING
		If set, only deployables with the same tag will be automatically mapped to this container.

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.ResourceGroupSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Specification for an Azure Resource Group.

		Public properties
		location: STRING
		Location (string)
		maxRetries: STRING = 500
		Number of times the script waits for Resource Group to be created. 5 seconds interval. (integer) default(500)
		resourceGroupName: STRING
		Name of the Resource Group. If not specified, the CI name will be used. (string)
		resourceGroupTags: MAP_STRING_STRING
		Tags (map_string_string)
		tags: SET_OF_STRING
		If set, only deployables with the same tag will be automatically mapped to this container. (set_of_string)

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

azure.Route

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Creates a Route resource in the specified Route Table.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		addressPrefix: STRING
		Destination CIDR to which the route applies.
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		nextHopIpAddress: STRING
		IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance.
		nextHopType: ENUM [VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None]
		Type of Azure hop the packet should be sent to
		routeName: STRING
		Route Name. If not specified, the CI name will be used.

---

azure.RouteSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Route resource

		Public properties
		addressPrefix: STRING
		Destination CIDR to which the route applies. (string)
		nextHopIpAddress: STRING
		IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance. (string)
		nextHopType: STRING
		Type of Azure hop the packet should be sent to (enum) values(VirtualNetworkGateway, VnetLocal, Internet, VirtualAppliance, None)
		routeName: STRING
		Route Name. If not specified, the CI name will be used. (string)

---

azure.RouteTable

Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Creates a RouteTable resource in the Resource Group.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Children
		routes: SET_OF_CI<azure.Route>
		Routes in a Route Table

		Public properties
		location: STRING
		Resource location.
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		routeTableName: STRING
		Route Table Name. If not specified, the CI name will be used.
		routeTableTags: MAP_STRING_STRING
		Route table tags

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.RouteTableSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

RouteTable resource

		Children
		routes: SET_OF_CI<azure.RouteSpec>
		Routes in a Route Table

		Public properties
		location: STRING
		Resource location. (string)
		routeTableName: STRING
		Route Table Name. If not specified, the CI name will be used. (string)
		routeTableTags: MAP_STRING_STRING
		Route table tags (map_string_string)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

azure.SecurityRule

Type Hierarchy	azure.BaseSecurityRule >> udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Adds a Security Rule to the Network Security Group.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		access: ENUM [Allow, Deny]
		Network traffic is allowed or denied
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		description: STRING
		A description for this rule. Restricted to 140 chars.
		destinationAddressPrefix: STRING
		Destination address prefix. CIDR or source IP range. Asterix ‘*’ can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used.
		destinationPortRange: STRING
		Destination port or range. Integer or range between 0 and 65535. Asterix ‘*’ can also be used to match all ports.
		direction: ENUM [Inbound, Outbound]
		Direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic
		priority: INTEGER = 100
		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.
		protocol: ENUM [*, Tcp, Udp] = *
		Network protocol this rule applies to
		securityRuleName: STRING
		Name of the resource that is unique within a resource group. If not specified, the CI name will be used.
		sourceAddressPrefix: STRING
		CIDR or source IP range. Asterix ‘*’ can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. If this is an ingress rule, specifies where network traffic originates from.
		sourcePortRange: STRING
		Source port or range. Integer or range between 0 and 65535. Asterix ‘*’ can also be used to match all ports.

---

azure.SecurityRuleSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Specification for Network Security Rule.

		Public properties
		access: STRING
		Network traffic is allowed or denied (enum) values(Allow, Deny)
		description: STRING
		A description for this rule. Restricted to 140 chars. (string)
		destinationAddressPrefix: STRING
		Destination address prefix. CIDR or source IP range. Asterix ‘*’ can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. (string)
		destinationPortRange: STRING
		Destination port or range. Integer or range between 0 and 65535. Asterix ‘*’ can also be used to match all ports. (string)
		direction: STRING
		Direction of the rule. The direction specifies if rule will be evaluated on incoming or outcoming traffic (enum) values(Inbound, Outbound)
		priority: STRING = 100
		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. (integer) default(100)
		protocol: STRING = *
		Network protocol this rule applies to (enum) values(*, Tcp, Udp) default(*)
		securityRuleName: STRING
		Name of the resource that is unique within a resource group. If not specified, the CI name will be used. (string)
		sourceAddressPrefix: STRING
		CIDR or source IP range. Asterix ‘*’ can also be used to match all source IPs. Default tags such as ‘VirtualNetwork’, ‘AzureLoadBalancer’ and ‘Internet’ can also be used. If this is an ingress rule, specifies where network traffic originates from. (string)
		sourcePortRange: STRING
		Source port or range. Integer or range between 0 and 65535. Asterix ‘*’ can also be used to match all ports. (string)

---

azure.StaticWebApp

Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Creates a Static Webapp in the Resource Group.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		hostingPlan: STRING = Free
		The Hosting Plan for the Static Web App
		location: STRING
		Static Web App location
		servicePlanName: STRING
		Name of the associated service plan to use
		apiLocation: STRING
		The path to the Static Web App api code
		appArtifactLocation: STRING
		The path of the Static Web App artifacts after building
		appLocation: STRING
		The path to the Static Web App code
		appName: STRING
		The name of the static webapp to create. If not specified, the CI name will be used.
		appSettings: MAP_STRING_STRING
		App Settings
		appTags: MAP_STRING_STRING
		App Tags
		branch: STRING
		The target branch in the repository.
		customConnectionStrings: MAP_STRING_STRING
		Connection Strings
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		repositoryToken: STRING
		A user's github repository token. This is used to setup the Github Actions workflow file and API secrets.
		repositoryUrl: STRING
		URL for the repository of the static site.
		sqlDatabaseConnectionStrings: MAP_STRING_STRING
		Connection Strings
		sqlServerConnectionStrings: MAP_STRING_STRING
		Connection Strings

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.StaticWebAppCode

Virtual Type
Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Uploads StaticWebAppCode to the Resource Group.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		apiZipUrl: STRING = false
		URL for the zipped api content
		appZipUrl: STRING
		URL for the zipped app content
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		deploymentTitle: STRING
		A title to label the deployment
		functionLanguage: STRING
		The language of the api content, if it exists.
		provider: STRING
		The provider submitting this deployment
		staticWebAppName: STRING
		The name of the web app to bind job to

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.StaticWebAppCodeSpec

Virtual Type
Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Uploads StaticWebAppCode to the Resource Group. (deployable)

		Public properties
		apiZipUrl: STRING
		URL for the zipped api content (string) default(false)
		appZipUrl: STRING
		URL for the zipped app content (string)
		deploymentTitle: STRING
		A title to label the deployment (string)
		functionLanguage: STRING
		The language of the api content, if it exists. (string)
		provider: STRING
		The provider submitting this deployment (string)
		staticWebAppName: STRING
		The name of the web app to bind job to (string)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

azure.StaticWebAppSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Creates a Static Webapp in the Resource Group. (deployable)

		Public properties
		apiLocation: STRING
		The path to the Static Web App api code (string)
		appArtifactLocation: STRING
		The path of the Static Web App artifacts after building (string)
		appLocation: STRING
		The path to the Static Web App code (string)
		appName: STRING
		The name of the static webapp to create. If not specified, the CI name will be used. (string)
		appSettings: MAP_STRING_STRING
		App Settings (map_string_string)
		appTags: MAP_STRING_STRING
		App Tags (map_string_string)
		branch: STRING
		The target branch in the repository. (string)
		customConnectionStrings: MAP_STRING_STRING
		Connection Strings (map_string_string)
		hostingPlan: STRING = Free
		The Hosting Plan for the Static Web App (string) default(Free)
		location: STRING
		Static Web App location (string)
		repositoryToken: STRING
		A user's github repository token. This is used to setup the Github Actions workflow file and API secrets. (string)
		repositoryUrl: STRING
		URL for the repository of the static site. (string)
		servicePlanName: STRING
		Name of the associated service plan to use (string)
		sqlDatabaseConnectionStrings: MAP_STRING_STRING
		Connection Strings (map_string_string)
		sqlServerConnectionStrings: MAP_STRING_STRING
		Connection Strings (map_string_string)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

azure.StorageAccount

Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Create an Azure Storage Account.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		location: STRING
		Location
		storageAccountKind: ENUM [Storage, StorageBlob] = Storage
		Kind
		storageAccountType: STRING = Standard_LRS
		Type of storage account
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		key1: STRING
		Storage Key #1
		key2: STRING
		Storage Key #2
		storageAccountName: STRING
		Name of the storage account to update or create. Storage account name must be between 3 and 24 characters in length and use numbers and lower-case letters only. If not specified, the CI name will be used (same rules apply).{{placeHolder_Key}} can be anything with atleast 1 character.
		storageAccountTags: MAP_STRING_STRING
		Tags

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.StorageAccountSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Specification for an Azure Storage Account.

		Public properties
		key1: STRING
		Storage Key #1 (string)
		key2: STRING
		Storage Key #2 (string)
		location: STRING
		Location (string)
		storageAccountKind: STRING = Storage
		Kind (enum) values(Storage, StorageBlob) default(Storage)
		storageAccountName: STRING
		Name of the storage account to update or create. Storage account name must be between 3 and 24 characters in length and use numbers and lower-case letters only. If not specified, the CI name will be used (same rules apply).{{placeHolder_Key}} can be anything with atleast 1 character. (string)
		storageAccountTags: MAP_STRING_STRING
		Tags (map_string_string)
		storageAccountType: STRING = Standard_LRS
		Type of storage account (string) default(Standard_LRS)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

azure.Subnet

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Creates a Subnet in a VirtualNework resource.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		addressPrefix: STRING
		Address prefix for the subnet.
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		networkSecurityGroupName: STRING
		Name of the NetworkSecurityGroup resource
		resourceNavigationLinks: LIST_OF_STRING
		Gets array of references to the external resources using subnet
		routeTableName: STRING
		Reference of the RouteTable resource
		subnetName: STRING
		Subnet Name. If not specified, the CI name will be used.
		subnetTags: MAP_STRING_STRING
		Subnet tags

---

azure.SubnetSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Subnet in a VirtualNetwork resource.

		Public properties
		addressPrefix: STRING
		Address prefix for the subnet. (string)
		networkSecurityGroupName: STRING
		Name of the NetworkSecurityGroup resource (string)
		resourceNavigationLinks: LIST_OF_STRING
		Gets array of references to the external resources using subnet (list_of_string)
		routeTableName: STRING
		Reference of the RouteTable resource (string)
		subnetName: STRING
		Subnet Name. If not specified, the CI name will be used. (string)
		subnetTags: MAP_STRING_STRING
		Subnet tags (map_string_string)

---

azure.TriggeredWebJob

Type Hierarchy	azure.BaseWebJob >> udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer

Creates a Triggered Web Job in the resource group.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		executableFileName: STRING
		The name of the file in the web job zip that must be executed
		webAppName: STRING
		The name of the web app to bind job to
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		placeholders: MAP_STRING_STRING
		A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
		schedule: STRING
		Cron expression made of 6 fields (second, minute, hour, day, month, day of the week). If not provided the job can be started manually.
		webJobName: STRING
		The name of the web job. If not specified, the CI name will be used.

		Hidden properties
		jobType: STRING = triggeredwebjobs
		Job Type
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.TriggeredWebJobSpec

Type Hierarchy	udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable

Creates a Triggered Web Job in the resource group. (deployable)

		Public properties
		checksum: STRING
		The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
		credentials: CI<credentials.Credentials>
		Credentials of the URI.
		excludeFileNamesRegex: STRING
		Regular expression that matches file names that must be excluded from scanning
		executableFileName: STRING
		The name of the file in the web job zip that must be executed (string)
		fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
		A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
		fileUri: STRING
		The URI pointing to the (remote) location of the file this artifact represents
		isRescanned: BOOLEAN
		Indicates if the artifact has been rescanned
		placeholders: SET_OF_STRING
		Placeholders detected in this artifact
		preScannedPlaceholders: BOOLEAN
		Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
		proxySettings: CI<credentials.ProxySettings>
		Proxy Settings for artifact location
		scanPlaceholders: BOOLEAN = true
		Whether to scan this artifact to replace placeholders when it is imported
		schedule: STRING
		Cron expression made of 6 fields (second, minute, hour, day, month, day of the week). If not provided the job can be started manually. (string)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		webAppName: STRING
		The name of the web app to bind job to (string)
		webJobName: STRING
		The name of the web job. If not specified, the CI name will be used. (string)

		Hidden properties
		textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
		Regular expression that matches file names of text files
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.
		delimiters: STRING = {{ }}
		The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter

Control task	Parameter CI	Attributes	Description
rescanArtifacts		delegate = rescanArtifact	No description.

---

azure.VirtualMachine

Type Hierarchy	udm.BaseProvisioned >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer, udm.Provisioned

Describes a Virtual Machine in the Resource Group.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Children
		provisioners: LIST_OF_CI<udm.AppliedProvisioner>
		A list of provisioners associated with the instance.
		winrmListeners: SET_OF_CI<azure.WinRMListener>
		A list of winrm listeners

		Public properties
		adminPassword: STRING
		Specifies the password of the administrator account.
		adminUserName: STRING
		Specifies the name of the administrator account.
		caching: ENUM [None, ReadOnly, ReadWrite] = None
		Caching type
		computerName: STRING
		Specifies the host OS name of the virtual machine.
		createOption: ENUM [fromImage, empty, attach] = fromImage
		Create option
		diskSizeGb: INTEGER = 30
		Initial disk size, in GB, for blank data disks, and the new desired size for resizing existing OS and data disks.
		location: STRING
		Location
		networkInterfaces: LIST_OF_STRING
		Specifies the list of resource IDs for the network interfaces associated with the virtual machine.
		offer: STRING = UbuntuServer
		Image offer
		osDiskName: STRING
		Disk name.
		osStorageAccountName: STRING
		If specified, osVhd below would be in format https://#storage_name#.blob.core.windows.net/vhds/#vhd_name#.vhd
		osType: ENUM [Linux, Windows] = Linux
		Operating System type
		publisher: STRING = Canonical
		Image publisher
		sku: STRING = 16.04.0-LTS
		Image SKU
		storageAccountType: STRING = Standard_LRS
		Parameters of a managed disk
		version: STRING
		Image version. The allowed formats are Major.Minor.Build or ‘latest’. Major, Minor and Build are decimal numbers. Specify ‘latest’ to use the latest version of the image.
		vmSize: STRING = Basic_A0
		Hardware profile.
		additionalUnattendContent: LIST_OF_STRING
		Additional base-64 encoded XML formatted information that can be included in the Unattend.xml file
		availabilitySet: STRING
		Name of the availability set to which the virtual machine belongs. Required for load balancer use.
		boundConfigurationItems: SET_OF_CI<udm.BaseConfigurationItem>
		The set of created CIs.
		customData: STRING
		Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		disablePasswordAuthentication: BOOLEAN
		Specifies whether password authentication should be disabled.
		enableAutomaticUpdates: BOOLEAN = true
		Indicates whether Windows updates are automatically installed on the VM
		enableBootDiagnostics: BOOLEAN
		Enable the diagnostics profile section
		enableLinuxConfiguration: BOOLEAN
		Enable linux configuration
		enableWindowsConfiguration: BOOLEAN
		Enable windows configuration
		instanceId: STRING
		Azure Instance Id
		osDiskAutoRemove: BOOLEAN
		Remove OS Disk on vm removal
		osImage: STRING
		Image - The virtual hard disk’s URI. Must be a valid URI to a virtual hard disk.
		osVhd: STRING
		Disk - The virtual hard disk’s URI. Must be a valid URI to a virtual hard disk.
		privateIp: STRING
		Private IP address of the instance.
		provisionVmAgent: BOOLEAN = true
		Indicates whether the virtual machine agent should be provisioned on the Virtual Machine. If not specified, then the default behavior is to set it to true.
		publicIp: STRING
		Public IP address of the instance.
		publicIpName: STRING
		IP Name of the VM
		publicKeys: MAP_STRING_STRING
		List of SSH public keys used to authenticate with linux based VMs.
		storageUri: STRING
		URI of the storage account to use for placing the console output and screenshot.
		timeZone: STRING
		Time zone of the VM
		virtualMachineName: STRING
		tags
		virtualMachineTags: MAP_STRING_STRING
		tags

		Hidden properties
		ordinal: INTEGER = 1
		The index of the cardinality amount created provisioneds.

---

azure.VirtualMachineSpec

Type Hierarchy	udm.BaseProvisionable >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Provisionable, udm.Taggable

Describes a Virtual Machine.

		Children
		winrmListeners: SET_OF_CI<azure.WinRMListenerSpec>
		A list of winrm listeners
		provisioners: LIST_OF_CI<udm.Provisioner>
		A list of provisioners associated with the instance.

		Public properties
		additionalUnattendContent: LIST_OF_STRING
		Additional base-64 encoded XML formatted information that can be included in the Unattend.xml file (list_of_string)
		adminPassword: STRING
		Specifies the password of the administrator account. (string)
		adminUserName: STRING
		Specifies the name of the administrator account. (string)
		availabilitySet: STRING
		Name of the availability set to which the virtual machine belongs. Required for load balancer use. (string)
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.
		caching: STRING = None
		Caching type (enum) values(None, ReadOnly, ReadWrite) default(None)
		computerName: STRING
		Specifies the host OS name of the virtual machine. (string)
		createOption: STRING = fromImage
		Create option (enum) values(fromImage, empty, attach) default(fromImage)
		customData: STRING
		Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes (string)
		disablePasswordAuthentication: STRING
		Specifies whether password authentication should be disabled. (boolean)
		diskSizeGb: STRING = 30
		Initial disk size, in GB, for blank data disks, and the new desired size for resizing existing OS and data disks. (integer) default(30)
		enableAutomaticUpdates: STRING = true
		Indicates whether Windows updates are automatically installed on the VM (boolean) default(true)
		enableBootDiagnostics: STRING
		Enable the diagnostics profile section (boolean)
		enableLinuxConfiguration: STRING
		Enable linux configuration (boolean)
		enableWindowsConfiguration: STRING
		Enable windows configuration (boolean)
		instanceId: STRING
		Azure Instance Id (string)
		location: STRING
		Location (string)
		networkInterfaces: LIST_OF_STRING
		Specifies the list of resource IDs for the network interfaces associated with the virtual machine. (list_of_string)
		offer: STRING = UbuntuServer
		Image offer (string) default(UbuntuServer)
		osDiskAutoRemove: STRING = false
		Remove OS Disk on vm removal (boolean) default(false)
		osDiskName: STRING
		Disk name. (string)
		osImage: STRING
		Image - The virtual hard disk’s URI. Must be a valid URI to a virtual hard disk. (string)
		osStorageAccountName: STRING
		If specified, osVhd below would be in format https://#storage_name#.blob.core.windows.net/vhds/#vhd_name#.vhd (string)
		osType: STRING = Linux
		Operating System type (enum) values(Linux, Windows) default(Linux)
		osVhd: STRING
		Disk - The virtual hard disk’s URI. Must be a valid URI to a virtual hard disk. (string)
		privateIp: STRING
		Private IP address of the instance. (string)
		provisionVmAgent: STRING = true
		Indicates whether the virtual machine agent should be provisioned on the Virtual Machine. If not specified, then the default behavior is to set it to true. (boolean) default(true)
		publicIp: STRING
		Public IP address of the instance. (string)
		publicIpName: STRING
		IP Name of the VM (string)
		publicKeys: MAP_STRING_STRING
		List of SSH public keys used to authenticate with linux based VMs. (map_string_string)
		publisher: STRING = Canonical
		Image publisher (string) default(Canonical)
		sku: STRING = 16.04.0-LTS
		Image SKU (string) default(16.04.0-LTS)
		storageAccountType: STRING = Standard_LRS
		Parameters of a managed disk (string) default(Standard_LRS)
		storageUri: STRING
		URI of the storage account to use for placing the console output and screenshot. (string)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		timeZone: STRING
		Time zone of the VM (string)
		version: STRING
		Image version. The allowed formats are Major.Minor.Build or ‘latest’. Major, Minor and Build are decimal numbers. Specify ‘latest’ to use the latest version of the image. (string)
		virtualMachineName: STRING
		tags (string)
		virtualMachineTags: MAP_STRING_STRING
		tags (map_string_string)
		vmSize: STRING = Basic_A0
		Hardware profile. (string) default(Basic_A0)

		Hidden properties
		cardinality: STRING = 1
		Number of instances to launch.

---

azure.VirtualNetwork

Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Creates a Virtual Network resource in the Resource Group.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Children
		subnets: SET_OF_CI<azure.Subnet>
		List of subnets in a VirtualNetwork

		Public properties
		location: STRING
		Resource location.
		addressPrefixes: LIST_OF_STRING
		A list of address blocks reserved for this virtual network in CIDR notation
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		dnsServers: LIST_OF_STRING
		List of DNS servers IP addresses
		virtualNetworkName: STRING
		Virtual Network Name. If not specified, the CI name will be used.
		virtualNetworkPeerings: STRING
		List of peerings in a VirtualNetwork
		virtualNetworkTags: MAP_STRING_STRING
		Virtual network tags

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.VirtualNetworkSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Virtual Network resource

		Children
		subnets: SET_OF_CI<azure.SubnetSpec>
		List of subnets in a VirtualNetwork

		Public properties
		addressPrefixes: LIST_OF_STRING
		A list of address blocks reserved for this virtual network in CIDR notation (list_of_string)
		dnsServers: LIST_OF_STRING
		List of DNS servers IP addresses (list_of_string)
		location: STRING
		Resource location. (string)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		virtualNetworkName: STRING
		Virtual Network Name. If not specified, the CI name will be used. (string)
		virtualNetworkPeerings: STRING
		List of peerings in a VirtualNetwork (string)
		virtualNetworkTags: MAP_STRING_STRING
		Virtual network tags (map_string_string)

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

azure.WebApp

Type Hierarchy	udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Creates a Webapp in the Resource Group.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		location: STRING
		wep app location
		servicePlanName: STRING
		Name of the associated service plan to use
		appCommandLine: STRING
		Optional startup command run as part of container startup
		appName: STRING
		The name of the webapp to create. If not specified, the CI name will be used.
		appSettings: MAP_STRING_STRING
		App Settings
		appTags: MAP_STRING_STRING
		App Tags
		customConnectionStrings: MAP_STRING_STRING
		Connection Strings
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		linuxFxVersion: STRING = TOMCAT|8.5-java11
		Linux App Framework and version. Eg. TOMCAT|8.5-java11
		sqlDatabaseConnectionStrings: MAP_STRING_STRING
		Connection Strings
		sqlServerConnectionStrings: MAP_STRING_STRING
		Connection Strings
		windowsFxVersion: STRING
		Windows App Framework and version

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.WebAppCode

Type Hierarchy	udm.BaseDeployedArtifact >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Artifact, udm.Deployed, udm.DerivedArtifact, udm.EmbeddedDeployedContainer

Uploads WebAppCode to the Resource Group.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		webAppName: STRING
		The name of the web app to bind job to
		artifactType: STRING
		The type of the artifact being deployed. war|jar|ear|lib|startup|static|zip
		cleanTgtSpace: STRING = false
		true|false. Caution:Cleans the target deployment space before deployment
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		deploymentSlot: STRING
		Deployment Slot used for Deploying the Webapp.
		placeholders: MAP_STRING_STRING
		A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
		targetPath: STRING
		The absolute path to deploy the artifact to.

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.
		deploymentId: STRING
		Internally used to track deployment progress.
		statusCheckRetryCounter: INTEGER
		Internally used to track deployment progress.

---

azure.WebAppCodeSpec

Type Hierarchy	udm.BaseDeployableFileArtifact >> udm.BaseDeployableArtifact >> udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Artifact, udm.Deployable, udm.DeployableArtifact, udm.FileArtifact, udm.SourceArtifact, udm.Taggable

Uploads WebAppCode to the Resource Group. (deployable)

		Public properties
		artifactType: STRING
		The type of the artifact being deployed. war|jar|ear|lib|startup|static|zip (string)
		checksum: STRING
		The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
		cleanTgtSpace: STRING
		true|false. Caution:Cleans the target deployment space before deployment (string) default(false)
		credentials: CI<credentials.Credentials>
		Credentials of the URI.
		deploymentSlot: STRING
		Deployment Slot used for Deploying the Webapp. (string)
		excludeFileNamesRegex: STRING
		Regular expression that matches file names that must be excluded from scanning
		fileEncodings: MAP_STRING_STRING = { .+\.properties=ISO-8859-1 }
		A map that maps regular expressions matching the full path of file(s) in the artifact to character set encodings
		fileUri: STRING
		The URI pointing to the (remote) location of the file this artifact represents
		isRescanned: BOOLEAN
		Indicates if the artifact has been rescanned
		placeholders: SET_OF_STRING
		Placeholders detected in this artifact
		preScannedPlaceholders: BOOLEAN
		Whether this artifact has been pre-scanned by the packager (ie. scanned for placeholders and checksum is set)
		proxySettings: CI<credentials.ProxySettings>
		Proxy Settings for artifact location
		scanPlaceholders: BOOLEAN = true
		Whether to scan this artifact to replace placeholders when it is imported
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		targetPath: STRING
		The absolute path to deploy the artifact to. (string)
		webAppName: STRING
		The name of the web app to bind job to (string)

		Hidden properties
		textFileNamesRegex: STRING = .+\.(cfg | conf | config | ini | properties | props | txt | asp | aspx | htm | html | jsf | jsp | xht | xhtml | sql | xml | xsd | xsl | xslt)
		Regular expression that matches file names of text files
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.
		delimiters: STRING = {{ }}
		The delimiters used indicate placeholders, defaults to '{{ }}'. This is a 5 character string with a space in the middle, the first two are the leading delimiter, the last two are the closing delimiter

Control task	Parameter CI	Attributes	Description
rescanArtifacts		delegate = rescanArtifact	No description.

---

azure.WebAppExtension

Type Hierarchy	azure.BaseWebAppExtension >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Creates a Webapp Extension in the Resource group.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		siteExtensionID: STRING
		Site Extension ID. Example: Specify 'Raygun.AzureAppService.Extension' for '.Net Raygun APM' Extension.
		webAppName: STRING
		The name of the web app to bind extension to.
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.WebAppExtensionSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Creates a Webapp Extension in the Resource group. (deployable)

		Public properties
		siteExtensionID: STRING
		Site Extension ID. Example: Specify 'Raygun.AzureAppService.Extension' for '.Net Raygun APM' Extension. (string)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		webAppName: STRING
		The name of the web app to bind extension to. (string)

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

azure.WebAppLogging

Type Hierarchy	azure.BaseWebAppLogging >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Creates Webapp logging in the resource group.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		webAppName: STRING
		The name of the web app to configure logging.
		applicationLoggingBlob: ENUM [Off, On]
		Application Logging (Blob).
		applicationLoggingBlobLevel: ENUM [Error, Warning, Information, Verbose]
		Log Level required if enabling Application Logging (Blob).
		applicationLoggingBlobRetention: INTEGER
		Retention period required if enabling Application Logging (Blob). Remove blobs older than specified days. 0 or lower means no retention.
		applicationLoggingBlobStorage: STRING
		Storage Account URL required if enabling Application Logging (Blob). SAS url to a azure blob container with read/write/list/delete permissions.
		applicationLoggingFileSystem: ENUM [Off, On]
		Application Logging (FileSystem).
		applicationLoggingFileSystemLevel: ENUM [Error, Warning, Information, Verbose]
		Log Level required if enabling Application Logging (FileSystem).
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.
		detailedErrorMessages: ENUM [Off, On]
		Detailed error messages.
		failedRequestsTracing: ENUM [Off, On]
		Failed requests tracing.
		httpFileSystemQuota: INTEGER = 35
		Quota (in MB) required if enabling Web Server Logging (FileSystem). Maximum size in megabytes that http log files can use. When reached old log files will be removed to make space for new ones.
		httpFileSystemRetention: INTEGER
		Retention period required if enabling Web Server Logging (FileSystem). Remove blobs older than X days. 0 or lower means no retention.
		httpLogs: ENUM [Off, FileSystem, Storage]
		Web Server Logging.
		httpStorageRetention: INTEGER
		Retention period required if enabling Web Server Logging (Storage). Remove blobs older than X days. 0 or lower means no retention.
		httpStorageStorage: STRING
		Storage Account URL required if enabling Web Server Logging (Storage). SAS url to a azure blob container with read/write/list/delete permissions.

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.WebAppLoggingSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Creates Webapp logging in the resource group. (deployable)

		Public properties
		applicationLoggingBlob: STRING
		Application Logging (Blob). (enum) values(Off, On)
		applicationLoggingBlobLevel: STRING
		Log Level required if enabling Application Logging (Blob). (enum) values(Error, Warning, Information, Verbose)
		applicationLoggingBlobRetention: STRING
		Retention period required if enabling Application Logging (Blob). Remove blobs older than specified days. 0 or lower means no retention. (integer)
		applicationLoggingBlobStorage: STRING
		Storage Account URL required if enabling Application Logging (Blob). SAS url to a azure blob container with read/write/list/delete permissions. (string)
		applicationLoggingFileSystem: STRING
		Application Logging (FileSystem). (enum) values(Off, On)
		applicationLoggingFileSystemLevel: STRING
		Log Level required if enabling Application Logging (FileSystem). (enum) values(Error, Warning, Information, Verbose)
		detailedErrorMessages: STRING
		Detailed error messages. (enum) values(Off, On)
		failedRequestsTracing: STRING
		Failed requests tracing. (enum) values(Off, On)
		httpFileSystemQuota: STRING
		Quota (in MB) required if enabling Web Server Logging (FileSystem). Maximum size in megabytes that http log files can use. When reached old log files will be removed to make space for new ones. (integer) default(35)
		httpFileSystemRetention: STRING
		Retention period required if enabling Web Server Logging (FileSystem). Remove blobs older than X days. 0 or lower means no retention. (integer)
		httpLogs: STRING
		Web Server Logging. (enum) values(Off, FileSystem, Storage)
		httpStorageRetention: STRING
		Retention period required if enabling Web Server Logging (Storage). Remove blobs older than X days. 0 or lower means no retention. (integer)
		httpStorageStorage: STRING
		Storage Account URL required if enabling Web Server Logging (Storage). SAS url to a azure blob container with read/write/list/delete permissions. (string)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		webAppName: STRING
		The name of the web app to configure logging. (string)

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

azure.WebAppSlot

Type Hierarchy	azure.BaseWebAppSlot >> udm.BaseDeployed >> udm.BaseConfigurationItem
Interfaces	udm.Deployed, udm.EmbeddedDeployedContainer

Creates a Webapp Slot in the resource group.

		Parent
		container: CI<udm.Container>
		The container on which this deployed runs.

		Public properties
		cloneSettingsFrom: ENUM [Clone configuration from WebApp, Clone configuration from Deployment slot, Do not clone settings]
		Choose the webapp or deployment slot to clone from .
		slotName: STRING
		The name of the new deployment slot to be created.
		webAppName: STRING
		The name of the web app to bind slot to.
		cloneFromDeploymentSlot: STRING
		The name of the deployment slot from which configuration is to be cloned
		cloneFromWebApp: STRING
		The name of the web app from which configuration is to be cloned.
		deployable: CI<udm.Deployable>
		The deployable that this deployed is derived from.

		Hidden properties
		boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
		The set of created CIs.

---

azure.WebAppSlotSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Creates a Webapp Slot in the resource group. (deployable)

		Public properties
		cloneFromDeploymentSlot: STRING
		The name of the deployment slot from which configuration is to be cloned (string)
		cloneFromWebApp: STRING
		The name of the web app from which configuration is to be cloned. (string)
		cloneSettingsFrom: STRING
		Choose the webapp or deployment slot to clone from . (enum) values(Clone configuration from WebApp, Clone configuration from Deployment slot, Do not clone settings)
		slotName: STRING
		The name of the new deployment slot to be created. (string)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		webAppName: STRING
		The name of the web app to bind slot to. (string)

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

azure.WebAppSpec

Type Hierarchy	udm.BaseDeployable >> udm.BaseConfigurationItem
Interfaces	udm.Deployable, udm.Taggable

Creates a Webapp in the Resource Group. (deployable)

		Public properties
		appCommandLine: STRING
		Optional startup command run as part of container startup (string)
		appName: STRING
		The name of the webapp to create. If not specified, the CI name will be used. (string)
		appSettings: MAP_STRING_STRING
		App Settings (map_string_string)
		appTags: MAP_STRING_STRING
		App Tags (map_string_string)
		customConnectionStrings: MAP_STRING_STRING
		Connection Strings (map_string_string)
		linuxFxVersion: STRING = TOMCAT|8.5-java11
		Linux App Framework and version. Eg. TOMCAT|8.5-java11 (string) default(TOMCAT|8.5-java11)
		location: STRING
		wep app location (string)
		servicePlanName: STRING
		Name of the associated service plan to use (string)
		sqlDatabaseConnectionStrings: MAP_STRING_STRING
		Connection Strings (map_string_string)
		sqlServerConnectionStrings: MAP_STRING_STRING
		Connection Strings (map_string_string)
		tags: SET_OF_STRING
		If set, this deployable will only be mapped automatically to containers with the same tag.
		windowsFxVersion: STRING
		Windows App Framework and version (string)

		Hidden properties
		boundTemplates: SET_OF_CI<udm.Template>
		The set of CI templates.

---

azure.WinRMListener

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Creates a Win RM Listener in the Virtual Machine.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		protocol: ENUM [Http, Https] = Http
		protocol
		certificateSecretName: STRING
		Secret Name
		certificateUrl: STRING
		Certificate Url
		certificateVaultName: STRING
		Vault Name
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.

---

azure.WinRMListenerSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Win RM Listeners

		Public properties
		certificateSecretName: STRING
		Secret Name (string)
		certificateUrl: STRING
		Certificate Url (string)
		certificateVaultName: STRING
		Vault Name (string)
		protocol: STRING = http
		protocol (enum) values(Http, Https) default(Http)

---

azure.container

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

List of container definitions for the Container App.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Children
		env: SET_OF_CI<azure.containerAppEnvVariable>
		Container environment variables.
		probes: SET_OF_CI<azure.containerProbe>
		List of probes for the container.
		volumeMounts: SET_OF_CI<azure.containerVolumeMount>
		Container volume mounts.

		Public properties
		cpu: STRING
		Required CPU in cores, e.g. 0.5.
		image: STRING
		Container image tag.
		args: LIST_OF_STRING
		Container start command arguments.
		command: LIST_OF_STRING
		Container start command.
		containerName: STRING
		Container image tag.
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		ephemeralStorage: STRING
		Ephemeral Storage, e.g.1Gi
		memory: STRING
		Required memory, e.g. 0.25Gi

---

azure.containerAppEnvVariable

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Container environment variable.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		value: STRING
		Non-secret environment variable value.
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		secretRef: STRING
		Name of the Container App secret from which to pull the environment variable value.
		variableName: STRING
		Environment variable name. If not specified CI name will be used.

---

azure.containerAppEnvVariableSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Specification for container environment variable.

		Public properties
		secretRef: STRING
		Name of the Container App secret from which to pull the environment variable value. (string)
		value: STRING
		Non-secret environment variable value. (string)
		variableName: STRING
		Environment variable name. If not specified CI name will be used. (string)

---

azure.containerProbe

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

List of probes for the container.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		probetype: STRING
		The type of probe. Liveness|Readiness|Startup
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		failureThreshold: INTEGER = 3
		Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10.
		httpGetHeaders: MAP_STRING_STRING
		Custom headers to set in the request. HTTP allows repeated headers.
		httpGetHost: STRING
		Host name to connect to, defaults to the pod IP.
		httpGetPath: STRING = /
		Path to access on the HTTP server.
		httpGetPort: INTEGER = 80
		Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME.
		httpGetScheme: STRING = HTTP
		Scheme to use for connecting to the host. Defaults to HTTP.
		initialDelaySeconds: INTEGER
		Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60.
		periodSeconds: INTEGER = 10
		How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240.
		successThreshold: INTEGER = 1
		Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10.
		terminationGracePeriodSeconds: INTEGER
		Optional duration in seconds the pod needs to terminate gracefully upon probe failure.
		timeoutSeconds: INTEGER = 30
		Number of seconds after which the probe times out. Defaults to 30 seconds. Minimum value is 1. Maximum value is 240.

---

azure.containerProbeSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Specification for list of probes for the container.

		Public properties
		failureThreshold: STRING
		Minimum consecutive failures for the probe to be considered failed after having succeeded. Defaults to 3. Minimum value is 1. Maximum value is 10. (integer) default(3)
		httpGetHeaders: MAP_STRING_STRING
		Custom headers to set in the request. HTTP allows repeated headers. (map_string_string)
		httpGetHost: STRING
		Host name to connect to, defaults to the pod IP. (string)
		httpGetPath: STRING
		Path to access on the HTTP server. (string) default(/)
		httpGetPort: STRING
		Name or number of the port to access on the container. Number must be in the range 1 to 65535. Name must be an IANA_SVC_NAME. (integer) default(80)
		httpGetScheme: STRING
		Scheme to use for connecting to the host. Defaults to HTTP. (string) default(HTTP)
		initialDelaySeconds: STRING
		Number of seconds after the container has started before liveness probes are initiated. Minimum value is 1. Maximum value is 60. (integer) default(0)
		periodSeconds: STRING
		How often (in seconds) to perform the probe. Default to 10 seconds. Minimum value is 1. Maximum value is 240. (integer) default(10)
		probetype: STRING
		The type of probe. Liveness|Readiness|Startup (string)
		successThreshold: STRING
		Minimum consecutive successes for the probe to be considered successful after having failed. Defaults to 1. Must be 1 for liveness and startup. Minimum value is 1. Maximum value is 10. (integer) default(1)
		terminationGracePeriodSeconds: STRING
		Optional duration in seconds the pod needs to terminate gracefully upon probe failure. (integer) default(0)
		timeoutSeconds: STRING
		Number of seconds after which the probe times out. Defaults to 30 seconds. Minimum value is 1. Maximum value is 240. (integer) default(30)

---

azure.containerSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Specification for list of container definitions for the Container App.

		Children
		env: SET_OF_CI<azure.containerAppEnvVariableSpec>
		Container environment variables.
		probes: SET_OF_CI<azure.containerProbeSpec>
		List of probes for the container.
		volumeMounts: SET_OF_CI<azure.containerVolumeMountSpec>
		Container volume mounts.

		Public properties
		args: LIST_OF_STRING
		Container start command arguments. (list_of_string)
		command: LIST_OF_STRING
		Container start command. (list_of_string)
		containerName: STRING
		Container image tag. (string)
		cpu: STRING
		Required CPU in cores, e.g. 0.5. (string)
		ephemeralStorage: STRING
		Ephemeral Storage, e.g.1Gi (string)
		image: STRING
		Container image tag. (string)
		memory: STRING
		Required memory, e.g. 0.25Gi (string)

---

azure.containerVolume

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Volume definitions for the Container App.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Children
		secrets: SET_OF_CI<azure.volumeSecret>
		List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume.

		Public properties
		mountOptions: STRING
		Mount options used while mounting the AzureFile. Must be a comma-separated string.
		volumeName: STRING
		Volume name. If not specified, the CI name will be used.
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		storageName: STRING
		Name of storage resource. No need to provide for EmptyDir and Secret.
		storageType: STRING
		Storage type for the volume. If not provided, use EmptyDir.

---

azure.containerVolumeMount

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Volume mount for the Container App.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		mountPath: STRING
		Path within the container at which the volume should be mounted.Must not contain ':'
		subPath: STRING
		Path within the volume from which the container's volume should be mounted. Defaults to '' (volume's root)
		volumeName: STRING
		This must match the Name of a Volume.
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.

---

azure.containerVolumeMountSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Specification for volume mount for the Container App.

		Public properties
		mountPath: STRING
		Path within the container at which the volume should be mounted.Must not contain ':' (string)
		subPath: STRING
		Path within the volume from which the container's volume should be mounted. Defaults to '' (volume's root) (string)
		volumeName: STRING
		This must match the Name of a Volume. (string)

---

azure.containerVolumeSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Volume definitions for the Container App.

		Public properties
		mountOptions: STRING
		Mount options used while mounting the AzureFile. Must be a comma-separated string. (string)
		storageName: STRING
		Name of storage resource. No need to provide for EmptyDir and Secret. (string)
		storageType: STRING
		Storage type for the volume. If not provided, use EmptyDir. (string)
		volumeName: STRING
		Volume name. If not specified, the CI name will be used. (string)

---

azure.ingressCustomDomain

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Ingress custom domain mapping.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		bindingType: STRING = Disabled
		Custom Domain binding type - Disabled|SniEnabled
		certificateName: STRING
		Certificate to be bound to this hostname. Must exist in the Managed Environment.
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		domainName: STRING
		The hostname. If not specified CI name will be used.

---

azure.ingressCustomDomainSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Specification for an Ingress custom domain mapping.

		Public properties
		bindingType: STRING
		Custom Domain binding type - Disabled|SniEnabled (string) default(Disabled)
		certificateName: STRING
		Certificate to be bound to this hostname. Must exist in the Managed Environment. (string)
		domainName: STRING
		The hostname. If not specified CI name will be used. (string)

---

azure.ingressIpSecurityRestriction

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Rule to restrict incoming IP address.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		action: STRING
		Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or Deny.
		ipAddressRange: STRING
		CIDR notation to match incoming IP address.
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		description: STRING
		Describe the IP restriction rule that is being sent to the container-app. This is an optional field.
		restictionName: STRING
		Name for the IP restriction rule. If not specified CI name will be used.

---

azure.ingressIpSecurityRestrictionSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Specification for a rule to restrict incoming IP address.

		Public properties
		action: STRING
		Allow or Deny rules to determine for incoming IP. Note: Rules can only consist of ALL Allow or Deny. (string)
		description: STRING
		Describe the IP restriction rule that is being sent to the container-app. This is an optional field. (string)
		ipAddressRange: STRING
		CIDR notation to match incoming IP address. (string)
		restictionName: STRING
		Name for the IP restriction rule. If not specified CI name will be used. (string)

---

azure.ingressTrafficWeight

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Traffic weight assigned to a revision.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		revisionName: STRING
		Name of a revision.
		weight: INTEGER
		Traffic weight assigned to a revision.
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		label: STRING
		Associates a traffic label with a revision.
		latestRevision: BOOLEAN
		Indicates that the traffic weight belongs to a latest stable revision

---

azure.ingressTrafficWeightSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Specification for an Traffic weight assigned to a revision.

		Public properties
		label: STRING
		Associates a traffic label with a revision. (string)
		latestRevision: STRING
		Indicates that the traffic weight belongs to a latest stable revision (boolean) default(false)
		revisionName: STRING
		Name of a revision. (string)
		weight: STRING
		Traffic weight assigned to a revision. (integer)

---

azure.initContainer

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Container App init container definition.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Children
		env: SET_OF_CI<azure.containerAppEnvVariable>
		Container environment variables.
		volumeMounts: SET_OF_CI<azure.containerVolumeMount>
		Container volume mounts.

		Public properties
		containerName: STRING
		Custom container name. If not specified, the CI name will be used.
		cpu: STRING
		Required CPU in cores, e.g. 0.5.
		image: STRING
		Container image tag.
		args: LIST_OF_STRING
		Container start command arguments.
		command: LIST_OF_STRING
		Container start command.
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		ephemeralStorage: STRING
		Ephemeral Storage, e.g.1Gi
		memory: STRING
		Required memory, e.g. 0.25Gi

---

azure.initContainerSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Specification for Container App init container definition.

		Children
		env: SET_OF_CI<azure.containerAppEnvVariableSpec>
		Container environment variables.
		volumeMounts: SET_OF_CI<azure.containerVolumeMountSpec>
		Container volume mounts.

		Public properties
		args: LIST_OF_STRING
		Container start command arguments. (list_of_string)
		command: LIST_OF_STRING
		Container start command. (list_of_string)
		containerName: STRING
		Custom container name. If not specified, the CI name will be used. (string)
		cpu: STRING
		Required CPU in cores, e.g. 0.5. (string)
		ephemeralStorage: STRING
		Ephemeral Storage, e.g.1Gi (string)
		image: STRING
		Container image tag. (string)
		memory: STRING
		Required memory, e.g. 0.25Gi (string)

---

azure.privateContainerRegistry

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Container App Private Registry.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		identity: STRING
		A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use 'system'.
		passwordSecretRef: STRING
		The name of the Secret that contains the registry login password.
		server: STRING
		Container Registry Server.
		username: STRING
		Container Registry Username.
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.

---

azure.privateContainerRegistrySpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Specification for Container App Private Registry.

		Public properties
		identity: STRING
		A Managed Identity to use to authenticate with Azure Container Registry. For user-assigned identities, use the full user-assigned identity Resource ID. For system-assigned identities, use 'system'. (string)
		passwordSecretRef: STRING
		The name of the Secret that contains the registry login password. (string)
		server: STRING
		Container Registry Server. (string)
		username: STRING
		Container Registry Username. (string)

---

azure.serviceBind

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Configuration to bind a ContainerApp to a dev ContainerApp Service.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		serviceId: STRING
		Resource id of the target service.
		serviceName: STRING
		Name of the service bind.
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.

---

azure.serviceBindSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Specification for Configuration to bind a ContainerApp to a dev ContainerApp Service.

		Public properties
		serviceId: STRING
		Resource id of the target service. (string)
		serviceName: STRING
		Name of the service bind. (string)

---

azure.volumeSecret

Type Hierarchy	udm.BaseEmbeddedDeployed >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployed, udm.EmbeddedDeployedContainer

Secret to be added to volume.

		Parent
		container: CI<udm.EmbeddedDeployedContainer>
		The (embedded) deployed which contains this embedded deployed.

		Public properties
		secretRef: STRING
		Name of the Container App secret from which to pull the secret value.
		deployable: CI<udm.EmbeddedDeployable>
		The embedded deployable that this embedded deployed is derived from.
		path: STRING
		Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef.

---

azure.volumeSecretSpec

Type Hierarchy	udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem
Interfaces	udm.EmbeddedDeployable

Volume definitions for the Container App.

		Children
		secrets: SET_OF_CI<azure.volumeSecretSpec>
		List of secrets to be added in volume. If no secrets are provided, all secrets in collection will be added to volume.

		Public properties
		path: STRING
		Path to project secret to. If no path is provided, path defaults to name of secret listed in secretRef. (string)
		secretRef: STRING
		Name of the Container App secret from which to pull the secret value. (string)

---