Interface AzureComputeSource

All Superinterfaces:

ComputeSource, Credentialed, Identified, Named, Serializable

All Known Implementing Classes:

AzureInstancesComputeSource, AzureScaleSetComputeSource

@ValidatedBy(AzureComputeSourceValidator.class)
public interface AzureComputeSource
extends ComputeSource

Derives from ComputeSource to provide the interface for all Azure compute source model objects.

Field Summary

Fields inherited from interface ComputeSource

DEFAULT_ASSIGN_PUBLIC_IP

Modifier and Type	Field	Description
static final boolean	DEFAULT_ASSIGN_PUBLIC_IP

Method Summary

Modifier and Type	Method	Description
String	getAdminUserCredential()
String	getAvailabilityZone()
Boolean	getCreateProximityPlacementGroup()
@NotBlank String	getCredential()
String	getEnvironment()	Allows the specification of an Azure environment other than the default public environment.
default InstancePricing	getInstancePricing()	Gets the instance pricing for this source, e.g.
@Size(max=45) Map<String,String>	getInstanceTags()	Gets the custom instance tags to be set on the provisioned instance at startup.
default String	getInstanceType()	Gets the provider-specific instance type of the instances that will be provisioned.
@NotBlank String	getNetworkName()
@NotBlank String	getNetworkResourceGroupName()
default CloudProvider	getProvider()	Gets the Cloud Provider for this source.
@DecimalMin("0.00001") Double	getSpotMaxPrice()	The maximum price that will be paid for Spot VMs provisioned from this source.
String	getSshKey()
@NotBlank String	getSubnetName()
default String	getSubregion()	Gets the provider-specific subregion (aka Availability Domain, Availability Zone or Zone) where instances will be provisioned.
Boolean	getSupportingResourceCreated()	Indicates if supporting resources have been created for this source.
Boolean	getUseAcceleratedNetworking()
Boolean	getUseSpot()	Indicates if Spot VMs should be requested from Azure.
@NotBlank String	getVmSize()
boolean	isAssignPublicIp()
default void	setInstanceType(String instanceType)	Sets the provider-specific instance type of the instances that will be provisioned.
void	setSupportingResourceCreated(Boolean supportingResourceCreated)
void	setVmSize(String vmSize)

Methods inherited from interface ComputeSource

getCreatedFromId, getExhaustion, getId, getImageId, getInstanceSummary, getLimit, getName, getRegion, getStatus, getStatusMessage, getTraits, getUserData, setCreatedFromId, setExhaustion, setId, setImageId, setInstanceSummary, setInstanceTags, setLimit, setName, setStatus, setStatusMessage, setUserData

Modifier and Type	Method	Description
@Ydid String	getCreatedFromId()	Gets the ID of the source template if this source was created from a template.
ComputeSourceExhaustion	getExhaustion()	If this source is associated with an exhausted allowance, gets the exhaustion state.
@Ydid String	getId()	Returns the ID
@NotBlank String	getImageId()	Gets the image ID to use for the instances that will be provisioned.
InstanceSummary	getInstanceSummary()	A summary of instance counts according to instance status
@Min(0L) int	getLimit()	Returns the limit in number of instances that can be provisioned from this source.
@Name @NotBlank @Pattern(regexp="[a-z](?:[a-z\\d_-]{0,58}[a-z\\d])?") @Size(max=60) String	getName()	Returns the name of this compute source (which must be unique within the containing ComputeRequirement).
@NotBlank String	getRegion()	Gets the provider-specific region where instances will be provisioned.
ComputeSourceStatus	getStatus()	Gets the current provisioning status of this source.
String	getStatusMessage()	Gets the message associated with the current provisioning status of this source.
ComputeSourceTraits	getTraits()	Returns an object describing behavioural traits specific to this compute source.
String	getUserData()	Gets the user-data script to be passed to the provisioned instance at startup.
void	setCreatedFromId(String templateId)	Sets the source template ID
void	setExhaustion(ComputeSourceExhaustion exhaustion)
void	setId(String id)	Sets the ID
void	setImageId(String imageId)	Sets the image ID to use for the instances that will be provisioned.
void	setInstanceSummary(InstanceSummary instanceSummary)
void	setInstanceTags(Map<String,String> instanceTags)	Sets the custom instance tags to be set on the provisioned instance at startup.
void	setLimit(int limit)	Sets the limit in number of instances that can be provisioned from this source.
void	setName(String name)	Sets the name of this compute source (which must be unique within the containing ComputeRequirement).
void	setStatus(ComputeSourceStatus status)	Sets the current provisioning status of this source.
void	setStatusMessage(String statusMessage)	Sets the message associated with the current provisioning status of this source.
void	setUserData(String userData)	Sets the user-data script to be passed to the provisioned instance at startup.

Methods inherited from interface Credentialed

getCredentials

Modifier and Type	Method	Description
Set<String>	getCredentials()	Return the names of the credentials to be used for this Credentialed entity.

Method Details

getProvider

default CloudProvider getProvider()

Description copied from interface: ComputeSource

Gets the Cloud Provider for this source.

Specified by:

getProvider in interface ComputeSource

Returns:

the Cloud Provider for this source

getInstancePricing

default InstancePricing getInstancePricing()

Description copied from interface: ComputeSource

Gets the instance pricing for this source, e.g. Spot

Specified by:

getInstancePricing in interface ComputeSource

Returns:

the instance pricing for this source

getSubregion

default String getSubregion()

Description copied from interface: ComputeSource

Gets the provider-specific subregion (aka Availability Domain, Availability Zone or Zone) where instances will be provisioned.

Specified by:

getSubregion in interface ComputeSource

Returns:

the provider-specific subregion where instances will be provisioned

getInstanceType

default String getInstanceType()

Description copied from interface: ComputeSource

Gets the provider-specific instance type of the instances that will be provisioned.

Specified by:

getInstanceType in interface ComputeSource

Returns:

the provider-specific instance type of the instances that will be provisioned

setInstanceType

default void setInstanceType(String instanceType)

Description copied from interface: ComputeSource

Sets the provider-specific instance type of the instances that will be provisioned.

Specified by:

setInstanceType in interface ComputeSource

Parameters:

instanceType - the provider-specific instance type of the instances that will be provisioned

getCredential

@NotBlank
@NotBlank String getCredential()

Specified by:

getCredential in interface ComputeSource

getAvailabilityZone

@JsonPropertyDescription("The Azure availability zone within the region where instances will be provisioned")
String getAvailabilityZone()

getNetworkResourceGroupName

@NotBlank
@JsonPropertyDescription("The Azure network resource group name to use for provisioned instances")
@NotBlank String getNetworkResourceGroupName()

getNetworkName

@NotBlank
@JsonPropertyDescription("The Azure network name to use for provisioned instances")
@NotBlank String getNetworkName()

getSubnetName

@NotBlank
@JsonPropertyDescription("The Azure subnet name to use for provisioned instances")
@NotBlank String getSubnetName()

getEnvironment

@JsonPropertyDescription("An Azure environment other than the default public environment")
String getEnvironment()

Allows the specification of an Azure environment other than the default public environment. This should normally be left blank. Valid values are "china", "germany", "us_government".

Returns:

an Azure environment other than the default public environment

getVmSize

@NotBlank
@JsonPropertyDescription("The virtual machine type (aka instance type) of the instances that will be provisioned")
@NotBlank String getVmSize()

setVmSize

void setVmSize(String vmSize)

getAdminUserCredential

@JsonPropertyDescription("The fully qualified name of the keyring credential '{keyring name}/{credential name}' to use for the admin/root user login details for provisioned instances")
String getAdminUserCredential()

getSshKey

@JsonPropertyDescription("The public SSH key to allow instances to be accessible with the matching private key through SSH")
String getSshKey()

isAssignPublicIp

@JsonPropertyDescription("Assign public IP address to provisioned instances")
boolean isAssignPublicIp()

getCreateProximityPlacementGroup

@JsonPropertyDescription("Provision the instances within a proximity placement group")
Boolean getCreateProximityPlacementGroup()

getUseAcceleratedNetworking

@JsonPropertyDescription("Provision each instance's primary network interface with accelerated networking")
Boolean getUseAcceleratedNetworking()

getUseSpot

@JsonPropertyDescription("Request Spot VMs (requires Spot max price to be set)")
Boolean getUseSpot()

Indicates if Spot VMs should be requested from Azure. Requires Spot max price to be set.

Returns:

if Spot VMs should be requested from Azure

getSpotMaxPrice

@DecimalMin("0.00001")
@JsonPropertyDescription("The maximum price that will be paid for Spot VMs provisioned from this source")
@DecimalMin("0.00001") Double getSpotMaxPrice()

The maximum price that will be paid for Spot VMs provisioned from this source.

Returns:

the maximum price that will be paid for Spot VMs

getSupportingResourceCreated

@SystemGenerated(groups=ValidationGroup.NewEntity.class)
Boolean getSupportingResourceCreated()

Description copied from interface: ComputeSource

Indicates if supporting resources have been created for this source.

Specified by:

getSupportingResourceCreated in interface ComputeSource

Returns:

true, if supporting resources have been created for this source; false, if no supporting resources have been created; null, if unknown

setSupportingResourceCreated

void setSupportingResourceCreated(Boolean supportingResourceCreated)

getInstanceTags

@Size(max=45)
@Size(max=45) Map<String,String> getInstanceTags()

Description copied from interface: ComputeSource

Gets the custom instance tags to be set on the provisioned instance at startup.

Specified by:

getInstanceTags in interface ComputeSource

Returns:

the custom instance tags