Azure Plugin Reference 7.2.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
Release notes
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
CI | Description |
---|---|
azure.AppServicePlanSpec | Description unavailable (deployable) |
azure.ContainerGroupSpec | Container Group resource |
azure.FunctionAppSpec | Description unavailable (deployable) |
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.VirtualMachineSpec | Describes a Virtual Machine. |
azure.VirtualNetworkSpec | Virtual Network resource |
Deployeds
CI | Description |
---|---|
azure.AppServicePlan | Description unavailable |
azure.BaseAppServiceDeployed | Description unavailable |
azure.BaseArtifactAppServiceDeployed | Description unavailable |
azure.ContainerGroup | Container Group resource |
azure.FunctionApp | Description unavailable |
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.VirtualMachine | Describes a Virtual Machine. |
azure.VirtualNetwork | Virtual Network resource |
Containers
CI | Description |
---|---|
azure.Cloud | Azure Cloud account |
azure.ResourceGroup | Azure Resource Group. |
Other Configuration Items
CI | Description |
---|---|
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.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 VirtualNework resource. |
Configuration Item Details
azure.AppServicePlan
Type Hierarchy | azure.BaseAppServiceDeployed >> 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
|
||
|
|
servicePlanName: STRING
|
Service Plan Name
|
||
|
|
skuCapacity: INTEGER
|
Web Hosting Plan SKU capacity
|
||
|
|
skuFamily: STRING = Y
|
Web Hosting Plan SKU family
|
||
|
|
skuName: STRING = Y1
|
Web Hosting Plan SKU name
|
||
|
|
skuSize: STRING = Y1
|
Web Hosting Plan SKU size
|
||
|
|
skuTier: STRING = Dynamic
|
Web Hosting Plan SKU tier
|
||
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
forceRedeploy: BOOLEAN
|
Force Redeploy
|
azure.AppServicePlanSpec
Type Hierarchy | udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployable, udm.Taggable |
Description unavailable (deployable)
Public properties | ||
---|---|---|
|
|
forceRedeploy: STRING
|
Force Redeploy (boolean) default(false)
|
||
|
|
location: STRING
|
The location of the service plan (string)
|
||
|
|
servicePlanName: STRING
|
Service Plan Name (string)
|
||
|
|
skuCapacity: STRING
|
Web Hosting Plan SKU capacity (integer) default(0)
|
||
|
|
skuFamily: STRING
|
Web Hosting Plan SKU family (string) default(Y)
|
||
|
|
skuName: STRING
|
Web Hosting Plan SKU name (string) default(Y1)
|
||
|
|
skuSize: STRING
|
Web Hosting Plan SKU size (string) default(Y1)
|
||
|
|
skuTier: STRING
|
Web Hosting Plan SKU tier (string) default(Dynamic)
|
||
|
|
tags: SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
azure.BaseAppServiceDeployed
Virtual Type | |
---|---|
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 | ||
---|---|---|
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
forceRedeploy: BOOLEAN
|
Force Redeploy
|
azure.BaseArtifactAppServiceDeployed
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 | ||
---|---|---|
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
forceRedeploy: BOOLEAN
|
Force Redeploy
|
||
|
|
placeholders: MAP_STRING_STRING
|
A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
|
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. This name can be used to access the resource
|
||
|
|
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. This name can be used to access the resource (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.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
|
||
|
|
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
|
Control task | Parameter CI | Attributes | Description |
---|---|---|---|
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 Definition
|
||
|
|
provisioners:
LIST_OF_CI<udm.AppliedProvisioner>
|
A list of provisioners associated with the instance.
|
Public properties | ||
---|---|---|
|
|
containerGroupName: STRING
|
Container group name
|
||
|
|
location: STRING
|
Resource location.
|
||
|
|
ordinal: INTEGER
|
The index of the cardinality amount created provisioneds.
|
||
|
|
osType: STRING = linux
|
Base OS to use
|
||
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
||
|
|
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
|
azure.ContainerGroupSpec
Type Hierarchy | udm.BaseProvisionable >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployable, udm.Provisionable, udm.Taggable |
Container Group resource
Children | ||
---|---|---|
|
| |
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.
|
||
|
|
cardinality: STRING = 1
|
Number of instances to launch.
|
||
|
|
containerGroupName: STRING
|
Container group name (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.
|
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
|
||
|
|
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 (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.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. This name can be used to access the resource
|
||
|
|
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. This name can be used to access the resource (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 | azure.BaseArtifactAppServiceDeployed >> 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 | ||
---|---|---|
|
|
appName: STRING
|
Name of the function app to create
|
||
|
|
location: STRING
|
function app location
|
||
|
|
servicePlanName: STRING
|
Name of the associated service plan to create
|
||
|
|
storageAccount: STRING
|
storage account for this function app
|
||
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
forceRedeploy: BOOLEAN
|
Force Redeploy
|
||
|
|
placeholders: MAP_STRING_STRING
|
A Map containing all the placeholders mapped to their values. Special values are <ignore> or <empty>
|
azure.FunctionAppSpec
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 | ||
---|---|---|
|
|
appName: STRING
|
Name of the function app to create (string)
|
||
|
|
checksum: STRING
|
The checksum used to detect differences on the artifact. If not provided, it will be calculated by XL Deploy.
|
||
|
|
excludeFileNamesRegex: STRING
|
Regular expression that matches file names that must be excluded from scanning
|
||
|
|
fileUri: STRING
|
The URI pointing to the (remote) location of the file this artifact represents
|
||
|
|
forceRedeploy: STRING
|
Force Redeploy (boolean) default(false)
|
||
|
|
location: STRING
|
function app location (string)
|
||
|
|
placeholders: SET_OF_STRING
|
Placeholders detected in this artifact
|
||
|
|
scanPlaceholders: BOOLEAN = true
|
Whether to scan this artifact for placeholders when it is imported
|
||
|
|
servicePlanName: STRING
|
Name of the associated service plan to create (string)
|
||
|
|
storageAccount: STRING
|
storage account 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
|
||
|
|
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
|
||
|
|
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
|
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 | ||
---|---|---|
|
| |
A list of IPConfigurations of the network interface.
|
Public properties | ||
---|---|---|
|
|
location: STRING
|
Resource location.
|
||
|
|
networkInterfaceName: STRING
|
Network Interface Name
|
||
|
|
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.
|
||
|
|
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
|
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.
|
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.
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 | ||
---|---|---|
|
| |
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 (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.
|
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 | ||
---|---|---|
|
| |
A collection of default security rules for the network security group.
|
||
|
| |
A collection of security rules for the network security group.
|
Public properties | ||
---|---|---|
|
|
location: STRING
|
Location
|
||
|
|
securityGroupName: STRING
|
Security Group Name
|
||
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
networkSecurityGroupTags: MAP_STRING_STRING
|
Tags
|
azure.NetworkSecurityGroupSpec
Type Hierarchy | udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployable, udm.Taggable |
Specification for Network Security Group.
Children | ||
---|---|---|
|
| |
A collection of default security rules for the network security group.
|
||
|
| |
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 (string)
|
||
|
|
tags: SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
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
|
||
|
|
publicIpAddressName: STRING
|
Resource name
|
||
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
publicIpAddressIdleTimeoutInMinutes: INTEGER = 4
|
Idle timeout of the public IP address 4 .. 30
|
||
|
|
publicIpAddressTags: MAP_STRING_STRING
|
Tags
|
||
|
|
publicIpAddressVersion: ENUM [IPv4, IPv6] = IPv4
|
Public IP address version
|
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 (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.
|
azure.ResourceGroup
Type Hierarchy | udm.BaseProvisionedContainer >> udm.BaseProvisioned >> udm.BaseDeployed >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Container, udm.Deployed, udm.EmbeddedDeployedContainer, udm.Provisioned, udm.Taggable |
Azure Resource Group.
Parent | ||
---|---|---|
|
|
container:
CI<udm.Container>
|
The container on which this deployed runs.
|
Children | ||
---|---|---|
|
|
provisioners:
LIST_OF_CI<udm.AppliedProvisioner>
|
A list of provisioners associated with the instance.
|
Public properties | ||
---|---|---|
|
|
location: STRING
|
Location
|
||
|
|
ordinal: INTEGER
|
The index of the cardinality amount created provisioneds.
|
||
|
|
resourceGroupName: STRING
|
Name
|
||
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
The set of created CIs.
|
||
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
resourceGroupTags: MAP_STRING_STRING
|
Tags
|
azure.ResourceGroupSpec
Type Hierarchy | udm.BaseProvisionable >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployable, udm.Provisionable, udm.Taggable |
Specification for an Azure Resource Group.
Children | ||
---|---|---|
|
|
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.
|
||
|
|
cardinality: STRING = 1
|
Number of instances to launch.
|
||
|
|
location: STRING
|
Location (string)
|
||
|
|
resourceGroupName: STRING
|
Name (string)
|
||
|
|
resourceGroupTags: MAP_STRING_STRING
|
Tags (map_string_string)
|
||
|
|
tags: SET_OF_STRING
|
If set, this deployable will only be mapped automatically to containers with the same tag.
|
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 | ||
---|---|---|
|
|
routeName: STRING
|
Route Name
|
||
|
|
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
|
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 (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 in a Route Table
|
Public properties | ||
---|---|---|
|
|
location: STRING
|
Resource location.
|
||
|
|
routeTableName: STRING
|
Route Table Name
|
||
|
|
deployable:
CI<udm.Deployable>
|
The deployable that this deployed is derived from.
|
||
|
|
routeTableTags: MAP_STRING_STRING
|
Route table tags
|
azure.RouteTableSpec
Type Hierarchy | udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployable, udm.Taggable |
RouteTable resource
Children | ||
---|---|---|
|
| |
Routes in a Route Table
|
Public properties | ||
---|---|---|
|
|
location: STRING
|
Resource location. (string)
|
||
|
|
routeTableName: STRING
|
Route Table Name (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.
|
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. This name can be used to access the resource
|
||
|
|
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. This name can be used to access the resource (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
|
||
|
|
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
|
||
|
|
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
|
||
|
|
storageAccountTags: MAP_STRING_STRING
|
Tags
|
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 (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.
|
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 | ||
---|---|---|
|
|
subnetName: STRING
|
Subnet Name
|
||
|
|
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
|
||
|
|
subnetTags: MAP_STRING_STRING
|
Subnet tags
|
azure.SubnetSpec
Type Hierarchy | udm.BaseEmbeddedDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.EmbeddedDeployable |
Subnet in a VirtualNework 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 (string)
|
||
|
|
subnetTags: MAP_STRING_STRING
|
Subnet tags (map_string_string)
|
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.
|
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
|
||
|
|
ordinal: INTEGER
|
The index of the cardinality amount created provisioneds.
|
||
|
|
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
|
||
|
|
boundConfigurationItems:
SET_OF_CI<udm.ConfigurationItem>
|
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
|
||
|
|
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
|
azure.VirtualMachineSpec
Type Hierarchy | udm.BaseProvisionable >> udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployable, udm.Provisionable, udm.Taggable |
Describes a Virtual Machine.
Children | ||
---|---|---|
|
|
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)
|
||
|
|
boundTemplates:
SET_OF_CI<udm.Template>
|
The set of CI templates.
|
||
|
|
caching: STRING = None
|
Caching type (enum) values(None, ReadOnly, ReadWrite) default(None)
|
||
|
|
cardinality: STRING = 1
|
Number of instances to launch.
|
||
|
|
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)
|
||
|
|
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)
|
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 | ||
---|---|---|
|
| |
List of subnets in a VirtualNetwork
|
Public properties | ||
---|---|---|
|
|
location: STRING
|
Resource location.
|
||
|
|
virtualNetworkName: STRING
|
Virtual Network Name
|
||
|
|
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
|
||
|
|
virtualNetworkPeerings: STRING
|
List of peerings in a VirtualNetwork
|
||
|
|
virtualNetworkTags: MAP_STRING_STRING
|
Virtual network tags
|
azure.VirtualNetworkSpec
Type Hierarchy | udm.BaseDeployable >> udm.BaseConfigurationItem |
---|---|
Interfaces | udm.Deployable, udm.Taggable |
Virtual Network resource
Children | ||
---|---|---|
|
| |
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 (string)
|
||
|
|
virtualNetworkPeerings: STRING
|
List of peerings in a VirtualNetwork (string)
|
||
|
|
virtualNetworkTags: MAP_STRING_STRING
|
Virtual network tags (map_string_string)
|