Azure Plugin Reference 9.7.x

    The XL Deploy Azure plugin enables XL Deploy to work with the Microsoft Azure cloud computing service. The plugin uses the azure Jython library to communicate with Azure.

    Requirements

    • XL Deploy 7.0.0+
    • A valid Azure subscription and a user with admin rights associate to it
    • Azure CLI (if Azure artifacts are used)

    Release notes

    Azure plugin 9.7.1

    New features

    • [ENG-5618] - Azure Artifactory integration. Now create Azure Feeds and upload artifact packages from XLD

    Azure plugin 9.7.0

    Bugs

    • [XLINT-1466] - azure.storageAccountSpec property storageAccountName unable to provide placeholder

    Azure plugin 9.6.1

    Bugs

    • [XLINT-1466] - azure.storageAccountSpec property storageAccountName unable to provide placeholder

    Azure plugin 9.6.0

    XL Deploy 9.6.0 compatibility

    Azure plugin 9.5.2

    Bugs

    • [XLINT-1348] - Fix ARM update deployment

    Azure plugin 9.5.1

    Bugs

    • [XLINT-898] - Enhance thelog in resource group when applying ARM template

    Azure plugin 9.5.0

    New features

    • [XLINT-894] - Automatically create k8s CI from provisioned cluster deployed by ARM template
    • [XLINT-980] - Add support to active-directory username/password authentication method for ARM deployment

    Azure plugin 7.5.2

    Bugs

    • [DEPL-13176] - Azure Cloud check connection fails while XLD is on Windows

    Azure plugin 7.5.1

    Improvements

    • [DEPL-11930] - Fix step ordering following standards for cloud and container plugins

    Azure plugin 7.5.0

    New features

    • [DEPL-12370] - Make technical names default to the deployed name
    • [DEPL-11989] - Add support for App Services
    • [DEPL-11931] - Add support for Windows VM and Key Vault
    • [DEPL-12461] - Add support for VM osdisk auto removal
    • [DEPL-12371] - Changed ResourceGroup type to udm.BaseDeployedContainer
    • [DEPL-12147] - Add validation for adminPassword for VM
    • [DEPL-11932] - Add support for Load Balancers

    Azure plugin 7.2.1

    New features

    • [DEPL-11934] - Add support for Container Instances

    Azure plugin 7.2.0

    New features

    • [DEPL-11935] - Add support for Function App
    • [DEPL-12084] - Add support for Blob Storage
    • [DEPL-11670] - Change most CI types to extend from BaseDeployed
    • [DEPL-11666] - Make Resource Group extend from BaseProvisionedContainer
    • [DEPL-11906] - Add check connection operation on Azure.cloud

    Limitations

    The current Function App support allows you to update an existing app but has a limitation if you need to re-provision an app that was deleted. In those scenario please remember to change the app name before the re-creation.

    The Blob Storage support is experimental and its use in production systems is currently not supported.

    Azure plugin 7.0.0

    Initial release.

    CI Reference

    Configuration Item Overview

    Deployables

    CIDescription
    azure.AppServicePlanSpec Description unavailable (deployable)
    azure.ArtifactPackageSpec Description unavailable (deployable)
    azure.ArtifactsFeedSpec Description unavailable (deployable)
    azure.AvailabilitySetSpec Availability Set resource
    azure.ContainerGroupSpec Container Group resource
    azure.ContinuousWebJobSpec Description unavailable (deployable)
    azure.FunctionAppZip Description unavailable (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.StorageAccountSpec Specification for an Azure Storage Account.
    azure.TriggeredWebJobSpec Description unavailable (deployable)
    azure.VirtualMachineSpec Describes a Virtual Machine.
    azure.VirtualNetworkSpec Virtual Network resource
    azure.WebAppCodeSpec Description unavailable (deployable)
    azure.WebAppSpec Description unavailable (deployable)

    Deployeds

    CIDescription
    azure.AppServicePlan Description unavailable
    azure.ArtifactPackage Description unavailable
    azure.ArtifactsFeed Description unavailable
    azure.AvailabilitySet Availability Set resource
    azure.BaseWebJob Description unavailable
    azure.ContainerGroup Container Group resource
    azure.ContinuousWebJob Description unavailable
    azure.FunctionApp Description unavailable
    azure.KeyVault A key vault storage within resource group
    azure.LoadBalancer Load Balancer resource
    azure.NetworkInterface A network interface in a resource group
    azure.NetworkSecurityGroup Network Security Group
    azure.PublicIpAddress Azure Public Ip Address.
    azure.ResourceGroup Azure Resource Group.
    azure.RouteTable RouteTable resource
    azure.StorageAccount Azure Storage Account.
    azure.TriggeredWebJob Description unavailable
    azure.VirtualMachine Describes a Virtual Machine.
    azure.VirtualNetwork Virtual Network resource
    azure.WebApp Description unavailable
    azure.WebAppCode Description unavailable

    Containers

    CIDescription
    azure.ArtifactsFeed Description unavailable
    azure.Cloud Azure Cloud account
    azure.ResourceGroup Azure Resource Group.

    Other Configuration Items

    CIDescription
    azure.BaseLoadBalancerConfiguration Base configuration of the load balancer
    azure.BaseLoadBalancerConfigurationSpec Base configuration of the load balancer (deployable)
    azure.BaseSecurityRule Network security rule.
    azure.BaseSecurityRuleSpec Specification for Network security rule.
    azure.ContainerInstance Container Instance resource
    azure.ContainerInstanceSpec Container Instance resource
    azure.DefaultSecurityRule Default Network Security Rule.
    azure.DefaultSecurityRuleSpec Specification for Default Network Security Rule.
    azure.KeyVaultSecret Secret within 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 Load balancing rules of 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 IPConfiguration in a network interface
    azure.NetworkInterfaceIPConfigurationSpec Specification for an IPConfiguration in a network interface.
    azure.Route Route resource
    azure.RouteSpec Route resource
    azure.SecurityRule Network Security Rule.
    azure.SecurityRuleSpec Specification for Network Security Rule.
    azure.Subnet Subnet in a VirtualNework resource.
    azure.SubnetSpec Subnet in a VirtualNetwork resource.
    azure.WinRMListener Win RM Listeners
    azure.WinRMListenerSpec Win RM Listeners

    Configuration Item Details

    azure.AppServicePlan

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

    Description unavailable

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    location: STRING
    The location of the service plan
     
     
    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

    Description unavailable (deployable)

      Public properties
     
     
    location: STRING
    The location of the service plan (string)
     
     
    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

    Description unavailable

      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

    Description unavailable (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
     
     
    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

    azure.ArtifactsFeed

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

    Description unavailable

      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

    Description unavailable (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

    Availability Set resource

      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

      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 (deployable)


    azure.BaseSecurityRule

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

    Network security rule.

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

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

    Description unavailable

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

    Type Hierarchy udm.BaseContainer >> udm.BaseConfigurationItem
    Interfaces udm.Container, udm.Taggable

    Azure Cloud account

      Public properties
     
     
    authMethod: ENUM [directory-application-and-service-principal, active-directory-user-password] = active-directory-user-password
    Authorization Method
     
     
    subscriptionId: STRING
    Subscription ID
     
     
    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 taskParameter CIAttributesDescription
    checkConnection

    delegate = jythonScript, script = xld/azure/check_connection.py

    Verify the connection to the Azure Cloud.


    azure.ContainerGroup

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

    Container Group resource

      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

    Container Instance resource

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

    Description unavailable

      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

    Description unavailable (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
     
     
    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

    azure.DefaultSecurityRule

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

    Default Network Security Rule.

      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

    Description unavailable

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    location: STRING
    Function app location.
     
     
    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.
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    function_app_url: STRING
    Base url for all functions part of this app.
     
     
    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.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

    Description unavailable (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)
     
     
    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
     
     
    function_app_url: STRING
    Base url for all functions part of this app. (string)
     
     
    location: STRING
    Function app location. (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
     
     
    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.
      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

    azure.KeyVault

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

    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

    Secret within 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

    Load Balancer resource

      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

    Load balancing rules of 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

    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

    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

    Network Security 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

    Azure Public Ip Address.

      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.

      Parent
     
     
    container: CI<udm.Container>
    The container on which this deployed runs.
      Public properties
     
     
    location: STRING
    Location
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    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)
     
     
    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

    Route resource

      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

    RouteTable resource

      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

    Network Security Rule.

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

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

    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

    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

    Description unavailable

      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

    Description unavailable (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
     
     
    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

    azure.VirtualMachine

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

    Describes a Virtual Machine.

      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

    Virtual Network resource

      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

    Description unavailable

      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
     
     
    appName: STRING
    The name of the webapp to create. If not specified, the CI name will be used.
     
     
    appSettings: MAP_STRING_STRING
    App Settings
     
     
    customConnectionStrings: MAP_STRING_STRING
    Connection Strings
     
     
    deployable: CI<udm.Deployable>
    The deployable that this deployed is derived from.
     
     
    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.WebAppCode

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

    Description unavailable

      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
     
     
    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>
      Hidden properties
     
     
    boundConfigurationItems: SET_OF_CI<udm.ConfigurationItem>
    The set of created CIs.

    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

    Description unavailable (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
     
     
    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)
      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

    azure.WebAppSpec

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

    Description unavailable (deployable)

      Public properties
     
     
    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)
     
     
    customConnectionStrings: MAP_STRING_STRING
    Connection Strings (map_string_string)
     
     
    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.
      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

    Win RM Listeners

      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)