Docs Home Pulumi IaC Pulumi ESC Pulumi Cloud Packages Tutorials
  1. Packages
  2. Azure Native
  3. API Docs
  4. devtestlab
  5. getFormula
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.3 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-azure-native

azure-native.devtestlab.getFormula

Explore with Pulumi AI

azure-native logo
This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
Azure Native v2.89.3 published on Thursday, Mar 20, 2025 by Pulumi
pulumi/pulumi-azure-native

    Get formula. Azure REST API version: 2018-09-15.

    Using getFormula

    Two invocation forms are available. The direct form accepts plain arguments and either blocks until the result value is available, or returns a Promise-wrapped result. The output form accepts Input-wrapped arguments and returns an Output-wrapped result.

    function getFormula(args: GetFormulaArgs, opts?: InvokeOptions): Promise<GetFormulaResult>
function getFormulaOutput(args: GetFormulaOutputArgs, opts?: InvokeOptions): Output<GetFormulaResult>
    def get_formula(expand: Optional[str] = None,
                lab_name: Optional[str] = None,
                name: Optional[str] = None,
                resource_group_name: Optional[str] = None,
                opts: Optional[InvokeOptions] = None) -> GetFormulaResult
def get_formula_output(expand: Optional[pulumi.Input[str]] = None,
                lab_name: Optional[pulumi.Input[str]] = None,
                name: Optional[pulumi.Input[str]] = None,
                resource_group_name: Optional[pulumi.Input[str]] = None,
                opts: Optional[InvokeOptions] = None) -> Output[GetFormulaResult]
    func LookupFormula(ctx *Context, args *LookupFormulaArgs, opts ...InvokeOption) (*LookupFormulaResult, error)
func LookupFormulaOutput(ctx *Context, args *LookupFormulaOutputArgs, opts ...InvokeOption) LookupFormulaResultOutput

    > Note: This function is named LookupFormula in the Go SDK.

    public static class GetFormula 
{
    public static Task<GetFormulaResult> InvokeAsync(GetFormulaArgs args, InvokeOptions? opts = null)
    public static Output<GetFormulaResult> Invoke(GetFormulaInvokeArgs args, InvokeOptions? opts = null)
}
    public static CompletableFuture<GetFormulaResult> getFormula(GetFormulaArgs args, InvokeOptions options)
public static Output<GetFormulaResult> getFormula(GetFormulaArgs args, InvokeOptions options)

    fn::invoke:
  function: azure-native:devtestlab:getFormula
  arguments:
    # arguments dictionary

    The following arguments are supported:

    LabName string
    The name of the lab.
    Name string
    The name of the formula.
    ResourceGroupName string
    The name of the resource group.
    Expand string
    Specify the $expand query. Example: 'properties($select=description)'
    LabName string
    The name of the lab.
    Name string
    The name of the formula.
    ResourceGroupName string
    The name of the resource group.
    Expand string
    Specify the $expand query. Example: 'properties($select=description)'
    labName String
    The name of the lab.
    name String
    The name of the formula.
    resourceGroupName String
    The name of the resource group.
    expand String
    Specify the $expand query. Example: 'properties($select=description)'
    labName string
    The name of the lab.
    name string
    The name of the formula.
    resourceGroupName string
    The name of the resource group.
    expand string
    Specify the $expand query. Example: 'properties($select=description)'
    lab_name str
    The name of the lab.
    name str
    The name of the formula.
    resource_group_name str
    The name of the resource group.
    expand str
    Specify the $expand query. Example: 'properties($select=description)'
    labName String
    The name of the lab.
    name String
    The name of the formula.
    resourceGroupName String
    The name of the resource group.
    expand String
    Specify the $expand query. Example: 'properties($select=description)'

    getFormula Result

    The following output properties are available:

    Author string
    The author of the formula.
    CreationDate string
    The creation date of the formula.
    Id string
    The identifier of the resource.
    Name string
    The name of the resource.
    ProvisioningState string
    The provisioning status of the resource.
    Type string
    The type of the resource.
    UniqueIdentifier string
    The unique immutable identifier of a resource (Guid).
    Description string
    The description of the formula.
    FormulaContent Pulumi.AzureNative.DevTestLab.Outputs.LabVirtualMachineCreationParameterResponse
    The content of the formula.
    Location string
    The location of the resource.
    OsType string
    The OS type of the formula.
    Tags Dictionary<string, string>
    The tags of the resource.
    Vm Pulumi.AzureNative.DevTestLab.Outputs.FormulaPropertiesFromVmResponse
    Information about a VM from which a formula is to be created.
    Author string
    The author of the formula.
    CreationDate string
    The creation date of the formula.
    Id string
    The identifier of the resource.
    Name string
    The name of the resource.
    ProvisioningState string
    The provisioning status of the resource.
    Type string
    The type of the resource.
    UniqueIdentifier string
    The unique immutable identifier of a resource (Guid).
    Description string
    The description of the formula.
    FormulaContent LabVirtualMachineCreationParameterResponse
    The content of the formula.
    Location string
    The location of the resource.
    OsType string
    The OS type of the formula.
    Tags map[string]string
    The tags of the resource.
    Vm FormulaPropertiesFromVmResponse
    Information about a VM from which a formula is to be created.
    author String
    The author of the formula.
    creationDate String
    The creation date of the formula.
    id String
    The identifier of the resource.
    name String
    The name of the resource.
    provisioningState String
    The provisioning status of the resource.
    type String
    The type of the resource.
    uniqueIdentifier String
    The unique immutable identifier of a resource (Guid).
    description String
    The description of the formula.
    formulaContent LabVirtualMachineCreationParameterResponse
    The content of the formula.
    location String
    The location of the resource.
    osType String
    The OS type of the formula.
    tags Map<String,String>
    The tags of the resource.
    vm FormulaPropertiesFromVmResponse
    Information about a VM from which a formula is to be created.
    author string
    The author of the formula.
    creationDate string
    The creation date of the formula.
    id string
    The identifier of the resource.
    name string
    The name of the resource.
    provisioningState string
    The provisioning status of the resource.
    type string
    The type of the resource.
    uniqueIdentifier string
    The unique immutable identifier of a resource (Guid).
    description string
    The description of the formula.
    formulaContent LabVirtualMachineCreationParameterResponse
    The content of the formula.
    location string
    The location of the resource.
    osType string
    The OS type of the formula.
    tags {[key: string]: string}
    The tags of the resource.
    vm FormulaPropertiesFromVmResponse
    Information about a VM from which a formula is to be created.
    author str
    The author of the formula.
    creation_date str
    The creation date of the formula.
    id str
    The identifier of the resource.
    name str
    The name of the resource.
    provisioning_state str
    The provisioning status of the resource.
    type str
    The type of the resource.
    unique_identifier str
    The unique immutable identifier of a resource (Guid).
    description str
    The description of the formula.
    formula_content LabVirtualMachineCreationParameterResponse
    The content of the formula.
    location str
    The location of the resource.
    os_type str
    The OS type of the formula.
    tags Mapping[str, str]
    The tags of the resource.
    vm FormulaPropertiesFromVmResponse
    Information about a VM from which a formula is to be created.
    author String
    The author of the formula.
    creationDate String
    The creation date of the formula.
    id String
    The identifier of the resource.
    name String
    The name of the resource.
    provisioningState String
    The provisioning status of the resource.
    type String
    The type of the resource.
    uniqueIdentifier String
    The unique immutable identifier of a resource (Guid).
    description String
    The description of the formula.
    formulaContent Property Map
    The content of the formula.
    location String
    The location of the resource.
    osType String
    The OS type of the formula.
    tags Map<String>
    The tags of the resource.
    vm Property Map
    Information about a VM from which a formula is to be created.

    Supporting Types

    ArtifactInstallPropertiesResponse

    ArtifactId string
    The artifact's identifier.
    ArtifactTitle string
    The artifact's title.
    DeploymentStatusMessage string
    The status message from the deployment.
    InstallTime string
    The time that the artifact starts to install on the virtual machine.
    Parameters List<Pulumi.AzureNative.DevTestLab.Inputs.ArtifactParameterPropertiesResponse>
    The parameters of the artifact.
    Status string
    The status of the artifact.
    VmExtensionStatusMessage string
    The status message from the virtual machine extension.
    ArtifactId string
    The artifact's identifier.
    ArtifactTitle string
    The artifact's title.
    DeploymentStatusMessage string
    The status message from the deployment.
    InstallTime string
    The time that the artifact starts to install on the virtual machine.
    Parameters []ArtifactParameterPropertiesResponse
    The parameters of the artifact.
    Status string
    The status of the artifact.
    VmExtensionStatusMessage string
    The status message from the virtual machine extension.
    artifactId String
    The artifact's identifier.
    artifactTitle String
    The artifact's title.
    deploymentStatusMessage String
    The status message from the deployment.
    installTime String
    The time that the artifact starts to install on the virtual machine.
    parameters List<ArtifactParameterPropertiesResponse>
    The parameters of the artifact.
    status String
    The status of the artifact.
    vmExtensionStatusMessage String
    The status message from the virtual machine extension.
    artifactId string
    The artifact's identifier.
    artifactTitle string
    The artifact's title.
    deploymentStatusMessage string
    The status message from the deployment.
    installTime string
    The time that the artifact starts to install on the virtual machine.
    parameters ArtifactParameterPropertiesResponse[]
    The parameters of the artifact.
    status string
    The status of the artifact.
    vmExtensionStatusMessage string
    The status message from the virtual machine extension.
    artifact_id str
    The artifact's identifier.
    artifact_title str
    The artifact's title.
    deployment_status_message str
    The status message from the deployment.
    install_time str
    The time that the artifact starts to install on the virtual machine.
    parameters Sequence[ArtifactParameterPropertiesResponse]
    The parameters of the artifact.
    status str
    The status of the artifact.
    vm_extension_status_message str
    The status message from the virtual machine extension.
    artifactId String
    The artifact's identifier.
    artifactTitle String
    The artifact's title.
    deploymentStatusMessage String
    The status message from the deployment.
    installTime String
    The time that the artifact starts to install on the virtual machine.
    parameters List<Property Map>
    The parameters of the artifact.
    status String
    The status of the artifact.
    vmExtensionStatusMessage String
    The status message from the virtual machine extension.

    ArtifactParameterPropertiesResponse

    Name string
    The name of the artifact parameter.
    Value string
    The value of the artifact parameter.
    Name string
    The name of the artifact parameter.
    Value string
    The value of the artifact parameter.
    name String
    The name of the artifact parameter.
    value String
    The value of the artifact parameter.
    name string
    The name of the artifact parameter.
    value string
    The value of the artifact parameter.
    name str
    The name of the artifact parameter.
    value str
    The value of the artifact parameter.
    name String
    The name of the artifact parameter.
    value String
    The value of the artifact parameter.

    AttachNewDataDiskOptionsResponse

    DiskName string
    The name of the disk to be attached.
    DiskSizeGiB int
    Size of the disk to be attached in Gibibytes.
    DiskType string
    The storage type for the disk (i.e. Standard, Premium).
    DiskName string
    The name of the disk to be attached.
    DiskSizeGiB int
    Size of the disk to be attached in Gibibytes.
    DiskType string
    The storage type for the disk (i.e. Standard, Premium).
    diskName String
    The name of the disk to be attached.
    diskSizeGiB Integer
    Size of the disk to be attached in Gibibytes.
    diskType String
    The storage type for the disk (i.e. Standard, Premium).
    diskName string
    The name of the disk to be attached.
    diskSizeGiB number
    Size of the disk to be attached in Gibibytes.
    diskType string
    The storage type for the disk (i.e. Standard, Premium).
    disk_name str
    The name of the disk to be attached.
    disk_size_gi_b int
    Size of the disk to be attached in Gibibytes.
    disk_type str
    The storage type for the disk (i.e. Standard, Premium).
    diskName String
    The name of the disk to be attached.
    diskSizeGiB Number
    Size of the disk to be attached in Gibibytes.
    diskType String
    The storage type for the disk (i.e. Standard, Premium).

    BulkCreationParametersResponse

    InstanceCount int
    The number of virtual machine instances to create.
    InstanceCount int
    The number of virtual machine instances to create.
    instanceCount Integer
    The number of virtual machine instances to create.
    instanceCount number
    The number of virtual machine instances to create.
    instance_count int
    The number of virtual machine instances to create.
    instanceCount Number
    The number of virtual machine instances to create.

    DataDiskPropertiesResponse

    AttachNewDataDiskOptions Pulumi.AzureNative.DevTestLab.Inputs.AttachNewDataDiskOptionsResponse
    Specifies options to attach a new disk to the virtual machine.
    ExistingLabDiskId string
    Specifies the existing lab disk id to attach to virtual machine.
    HostCaching string
    Caching option for a data disk (i.e. None, ReadOnly, ReadWrite).
    AttachNewDataDiskOptions AttachNewDataDiskOptionsResponse
    Specifies options to attach a new disk to the virtual machine.
    ExistingLabDiskId string
    Specifies the existing lab disk id to attach to virtual machine.
    HostCaching string
    Caching option for a data disk (i.e. None, ReadOnly, ReadWrite).
    attachNewDataDiskOptions AttachNewDataDiskOptionsResponse
    Specifies options to attach a new disk to the virtual machine.
    existingLabDiskId String
    Specifies the existing lab disk id to attach to virtual machine.
    hostCaching String
    Caching option for a data disk (i.e. None, ReadOnly, ReadWrite).
    attachNewDataDiskOptions AttachNewDataDiskOptionsResponse
    Specifies options to attach a new disk to the virtual machine.
    existingLabDiskId string
    Specifies the existing lab disk id to attach to virtual machine.
    hostCaching string
    Caching option for a data disk (i.e. None, ReadOnly, ReadWrite).
    attach_new_data_disk_options AttachNewDataDiskOptionsResponse
    Specifies options to attach a new disk to the virtual machine.
    existing_lab_disk_id str
    Specifies the existing lab disk id to attach to virtual machine.
    host_caching str
    Caching option for a data disk (i.e. None, ReadOnly, ReadWrite).
    attachNewDataDiskOptions Property Map
    Specifies options to attach a new disk to the virtual machine.
    existingLabDiskId String
    Specifies the existing lab disk id to attach to virtual machine.
    hostCaching String
    Caching option for a data disk (i.e. None, ReadOnly, ReadWrite).

    DayDetailsResponse

    Time string
    The time of day the schedule will occur.
    Time string
    The time of day the schedule will occur.
    time String
    The time of day the schedule will occur.
    time string
    The time of day the schedule will occur.
    time str
    The time of day the schedule will occur.
    time String
    The time of day the schedule will occur.

    FormulaPropertiesFromVmResponse

    LabVmId string
    The identifier of the VM from which a formula is to be created.
    LabVmId string
    The identifier of the VM from which a formula is to be created.
    labVmId String
    The identifier of the VM from which a formula is to be created.
    labVmId string
    The identifier of the VM from which a formula is to be created.
    lab_vm_id str
    The identifier of the VM from which a formula is to be created.
    labVmId String
    The identifier of the VM from which a formula is to be created.

    GalleryImageReferenceResponse

    Offer string
    The offer of the gallery image.
    OsType string
    The OS type of the gallery image.
    Publisher string
    The publisher of the gallery image.
    Sku string
    The SKU of the gallery image.
    Version string
    The version of the gallery image.
    Offer string
    The offer of the gallery image.
    OsType string
    The OS type of the gallery image.
    Publisher string
    The publisher of the gallery image.
    Sku string
    The SKU of the gallery image.
    Version string
    The version of the gallery image.
    offer String
    The offer of the gallery image.
    osType String
    The OS type of the gallery image.
    publisher String
    The publisher of the gallery image.
    sku String
    The SKU of the gallery image.
    version String
    The version of the gallery image.
    offer string
    The offer of the gallery image.
    osType string
    The OS type of the gallery image.
    publisher string
    The publisher of the gallery image.
    sku string
    The SKU of the gallery image.
    version string
    The version of the gallery image.
    offer str
    The offer of the gallery image.
    os_type str
    The OS type of the gallery image.
    publisher str
    The publisher of the gallery image.
    sku str
    The SKU of the gallery image.
    version str
    The version of the gallery image.
    offer String
    The offer of the gallery image.
    osType String
    The OS type of the gallery image.
    publisher String
    The publisher of the gallery image.
    sku String
    The SKU of the gallery image.
    version String
    The version of the gallery image.

    HourDetailsResponse

    Minute int
    Minutes of the hour the schedule will run.
    Minute int
    Minutes of the hour the schedule will run.
    minute Integer
    Minutes of the hour the schedule will run.
    minute number
    Minutes of the hour the schedule will run.
    minute int
    Minutes of the hour the schedule will run.
    minute Number
    Minutes of the hour the schedule will run.

    InboundNatRuleResponse

    BackendPort int
    The port to which the external traffic will be redirected.
    FrontendPort int
    The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically.
    TransportProtocol string
    The transport protocol for the endpoint.
    BackendPort int
    The port to which the external traffic will be redirected.
    FrontendPort int
    The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically.
    TransportProtocol string
    The transport protocol for the endpoint.
    backendPort Integer
    The port to which the external traffic will be redirected.
    frontendPort Integer
    The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically.
    transportProtocol String
    The transport protocol for the endpoint.
    backendPort number
    The port to which the external traffic will be redirected.
    frontendPort number
    The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically.
    transportProtocol string
    The transport protocol for the endpoint.
    backend_port int
    The port to which the external traffic will be redirected.
    frontend_port int
    The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically.
    transport_protocol str
    The transport protocol for the endpoint.
    backendPort Number
    The port to which the external traffic will be redirected.
    frontendPort Number
    The external endpoint port of the inbound connection. Possible values range between 1 and 65535, inclusive. If unspecified, a value will be allocated automatically.
    transportProtocol String
    The transport protocol for the endpoint.

    LabVirtualMachineCreationParameterResponse

    AllowClaim bool
    Indicates whether another user can take ownership of the virtual machine
    Artifacts List<Pulumi.AzureNative.DevTestLab.Inputs.ArtifactInstallPropertiesResponse>
    The artifacts to be installed on the virtual machine.
    BulkCreationParameters Pulumi.AzureNative.DevTestLab.Inputs.BulkCreationParametersResponse
    The number of virtual machine instances to create.
    CreatedDate string
    The creation date of the virtual machine.
    CustomImageId string
    The custom image identifier of the virtual machine.
    DataDiskParameters List<Pulumi.AzureNative.DevTestLab.Inputs.DataDiskPropertiesResponse>
    New or existing data disks to attach to the virtual machine after creation
    DisallowPublicIpAddress bool
    Indicates whether the virtual machine is to be created without a public IP address.
    EnvironmentId string
    The resource ID of the environment that contains this virtual machine, if any.
    ExpirationDate string
    The expiration date for VM.
    GalleryImageReference Pulumi.AzureNative.DevTestLab.Inputs.GalleryImageReferenceResponse
    The Microsoft Azure Marketplace image reference of the virtual machine.
    IsAuthenticationWithSshKey bool
    Indicates whether this virtual machine uses an SSH key for authentication.
    LabSubnetName string
    The lab subnet name of the virtual machine.
    LabVirtualNetworkId string
    The lab virtual network identifier of the virtual machine.
    Location string
    The location of the new virtual machine or environment
    Name string
    The name of the virtual machine or environment
    NetworkInterface Pulumi.AzureNative.DevTestLab.Inputs.NetworkInterfacePropertiesResponse
    The network interface properties.
    Notes string
    The notes of the virtual machine.
    OwnerObjectId string
    The object identifier of the owner of the virtual machine.
    OwnerUserPrincipalName string
    The user principal name of the virtual machine owner.
    Password string
    The password of the virtual machine administrator.
    PlanId string
    The id of the plan associated with the virtual machine image
    ScheduleParameters List<Pulumi.AzureNative.DevTestLab.Inputs.ScheduleCreationParameterResponse>
    Virtual Machine schedules to be created
    Size string
    The size of the virtual machine.
    SshKey string
    The SSH key of the virtual machine administrator.
    StorageType string
    Storage type to use for virtual machine (i.e. Standard, Premium).
    Tags Dictionary<string, string>
    The tags of the resource.
    UserName string
    The user name of the virtual machine.
    AllowClaim bool
    Indicates whether another user can take ownership of the virtual machine
    Artifacts []ArtifactInstallPropertiesResponse
    The artifacts to be installed on the virtual machine.
    BulkCreationParameters BulkCreationParametersResponse
    The number of virtual machine instances to create.
    CreatedDate string
    The creation date of the virtual machine.
    CustomImageId string
    The custom image identifier of the virtual machine.
    DataDiskParameters []DataDiskPropertiesResponse
    New or existing data disks to attach to the virtual machine after creation
    DisallowPublicIpAddress bool
    Indicates whether the virtual machine is to be created without a public IP address.
    EnvironmentId string
    The resource ID of the environment that contains this virtual machine, if any.
    ExpirationDate string
    The expiration date for VM.
    GalleryImageReference GalleryImageReferenceResponse
    The Microsoft Azure Marketplace image reference of the virtual machine.
    IsAuthenticationWithSshKey bool
    Indicates whether this virtual machine uses an SSH key for authentication.
    LabSubnetName string
    The lab subnet name of the virtual machine.
    LabVirtualNetworkId string
    The lab virtual network identifier of the virtual machine.
    Location string
    The location of the new virtual machine or environment
    Name string
    The name of the virtual machine or environment
    NetworkInterface NetworkInterfacePropertiesResponse
    The network interface properties.
    Notes string
    The notes of the virtual machine.
    OwnerObjectId string
    The object identifier of the owner of the virtual machine.
    OwnerUserPrincipalName string
    The user principal name of the virtual machine owner.
    Password string
    The password of the virtual machine administrator.
    PlanId string
    The id of the plan associated with the virtual machine image
    ScheduleParameters []ScheduleCreationParameterResponse
    Virtual Machine schedules to be created
    Size string
    The size of the virtual machine.
    SshKey string
    The SSH key of the virtual machine administrator.
    StorageType string
    Storage type to use for virtual machine (i.e. Standard, Premium).
    Tags map[string]string
    The tags of the resource.
    UserName string
    The user name of the virtual machine.
    allowClaim Boolean
    Indicates whether another user can take ownership of the virtual machine
    artifacts List<ArtifactInstallPropertiesResponse>
    The artifacts to be installed on the virtual machine.
    bulkCreationParameters BulkCreationParametersResponse
    The number of virtual machine instances to create.
    createdDate String
    The creation date of the virtual machine.
    customImageId String
    The custom image identifier of the virtual machine.
    dataDiskParameters List<DataDiskPropertiesResponse>
    New or existing data disks to attach to the virtual machine after creation
    disallowPublicIpAddress Boolean
    Indicates whether the virtual machine is to be created without a public IP address.
    environmentId String
    The resource ID of the environment that contains this virtual machine, if any.
    expirationDate String
    The expiration date for VM.
    galleryImageReference GalleryImageReferenceResponse
    The Microsoft Azure Marketplace image reference of the virtual machine.
    isAuthenticationWithSshKey Boolean
    Indicates whether this virtual machine uses an SSH key for authentication.
    labSubnetName String
    The lab subnet name of the virtual machine.
    labVirtualNetworkId String
    The lab virtual network identifier of the virtual machine.
    location String
    The location of the new virtual machine or environment
    name String
    The name of the virtual machine or environment
    networkInterface NetworkInterfacePropertiesResponse
    The network interface properties.
    notes String
    The notes of the virtual machine.
    ownerObjectId String
    The object identifier of the owner of the virtual machine.
    ownerUserPrincipalName String
    The user principal name of the virtual machine owner.
    password String
    The password of the virtual machine administrator.
    planId String
    The id of the plan associated with the virtual machine image
    scheduleParameters List<ScheduleCreationParameterResponse>
    Virtual Machine schedules to be created
    size String
    The size of the virtual machine.
    sshKey String
    The SSH key of the virtual machine administrator.
    storageType String
    Storage type to use for virtual machine (i.e. Standard, Premium).
    tags Map<String,String>
    The tags of the resource.
    userName String
    The user name of the virtual machine.
    allowClaim boolean
    Indicates whether another user can take ownership of the virtual machine
    artifacts ArtifactInstallPropertiesResponse[]
    The artifacts to be installed on the virtual machine.
    bulkCreationParameters BulkCreationParametersResponse
    The number of virtual machine instances to create.
    createdDate string
    The creation date of the virtual machine.
    customImageId string
    The custom image identifier of the virtual machine.
    dataDiskParameters DataDiskPropertiesResponse[]
    New or existing data disks to attach to the virtual machine after creation
    disallowPublicIpAddress boolean
    Indicates whether the virtual machine is to be created without a public IP address.
    environmentId string
    The resource ID of the environment that contains this virtual machine, if any.
    expirationDate string
    The expiration date for VM.
    galleryImageReference GalleryImageReferenceResponse
    The Microsoft Azure Marketplace image reference of the virtual machine.
    isAuthenticationWithSshKey boolean
    Indicates whether this virtual machine uses an SSH key for authentication.
    labSubnetName string
    The lab subnet name of the virtual machine.
    labVirtualNetworkId string
    The lab virtual network identifier of the virtual machine.
    location string
    The location of the new virtual machine or environment
    name string
    The name of the virtual machine or environment
    networkInterface NetworkInterfacePropertiesResponse
    The network interface properties.
    notes string
    The notes of the virtual machine.
    ownerObjectId string
    The object identifier of the owner of the virtual machine.
    ownerUserPrincipalName string
    The user principal name of the virtual machine owner.
    password string
    The password of the virtual machine administrator.
    planId string
    The id of the plan associated with the virtual machine image
    scheduleParameters ScheduleCreationParameterResponse[]
    Virtual Machine schedules to be created
    size string
    The size of the virtual machine.
    sshKey string
    The SSH key of the virtual machine administrator.
    storageType string
    Storage type to use for virtual machine (i.e. Standard, Premium).
    tags {[key: string]: string}
    The tags of the resource.
    userName string
    The user name of the virtual machine.
    allow_claim bool
    Indicates whether another user can take ownership of the virtual machine
    artifacts Sequence[ArtifactInstallPropertiesResponse]
    The artifacts to be installed on the virtual machine.
    bulk_creation_parameters BulkCreationParametersResponse
    The number of virtual machine instances to create.
    created_date str
    The creation date of the virtual machine.
    custom_image_id str
    The custom image identifier of the virtual machine.
    data_disk_parameters Sequence[DataDiskPropertiesResponse]
    New or existing data disks to attach to the virtual machine after creation
    disallow_public_ip_address bool
    Indicates whether the virtual machine is to be created without a public IP address.
    environment_id str
    The resource ID of the environment that contains this virtual machine, if any.
    expiration_date str
    The expiration date for VM.
    gallery_image_reference GalleryImageReferenceResponse
    The Microsoft Azure Marketplace image reference of the virtual machine.
    is_authentication_with_ssh_key bool
    Indicates whether this virtual machine uses an SSH key for authentication.
    lab_subnet_name str
    The lab subnet name of the virtual machine.
    lab_virtual_network_id str
    The lab virtual network identifier of the virtual machine.
    location str
    The location of the new virtual machine or environment
    name str
    The name of the virtual machine or environment
    network_interface NetworkInterfacePropertiesResponse
    The network interface properties.
    notes str
    The notes of the virtual machine.
    owner_object_id str
    The object identifier of the owner of the virtual machine.
    owner_user_principal_name str
    The user principal name of the virtual machine owner.
    password str
    The password of the virtual machine administrator.
    plan_id str
    The id of the plan associated with the virtual machine image
    schedule_parameters Sequence[ScheduleCreationParameterResponse]
    Virtual Machine schedules to be created
    size str
    The size of the virtual machine.
    ssh_key str
    The SSH key of the virtual machine administrator.
    storage_type str
    Storage type to use for virtual machine (i.e. Standard, Premium).
    tags Mapping[str, str]
    The tags of the resource.
    user_name str
    The user name of the virtual machine.
    allowClaim Boolean
    Indicates whether another user can take ownership of the virtual machine
    artifacts List<Property Map>
    The artifacts to be installed on the virtual machine.
    bulkCreationParameters Property Map
    The number of virtual machine instances to create.
    createdDate String
    The creation date of the virtual machine.
    customImageId String
    The custom image identifier of the virtual machine.
    dataDiskParameters List<Property Map>
    New or existing data disks to attach to the virtual machine after creation
    disallowPublicIpAddress Boolean
    Indicates whether the virtual machine is to be created without a public IP address.
    environmentId String
    The resource ID of the environment that contains this virtual machine, if any.
    expirationDate String
    The expiration date for VM.
    galleryImageReference Property Map
    The Microsoft Azure Marketplace image reference of the virtual machine.
    isAuthenticationWithSshKey Boolean
    Indicates whether this virtual machine uses an SSH key for authentication.
    labSubnetName String
    The lab subnet name of the virtual machine.
    labVirtualNetworkId String
    The lab virtual network identifier of the virtual machine.
    location String
    The location of the new virtual machine or environment
    name String
    The name of the virtual machine or environment
    networkInterface Property Map
    The network interface properties.
    notes String
    The notes of the virtual machine.
    ownerObjectId String
    The object identifier of the owner of the virtual machine.
    ownerUserPrincipalName String
    The user principal name of the virtual machine owner.
    password String
    The password of the virtual machine administrator.
    planId String
    The id of the plan associated with the virtual machine image
    scheduleParameters List<Property Map>
    Virtual Machine schedules to be created
    size String
    The size of the virtual machine.
    sshKey String
    The SSH key of the virtual machine administrator.
    storageType String
    Storage type to use for virtual machine (i.e. Standard, Premium).
    tags Map<String>
    The tags of the resource.
    userName String
    The user name of the virtual machine.

    NetworkInterfacePropertiesResponse

    DnsName string
    The DNS name.
    PrivateIpAddress string
    The private IP address.
    PublicIpAddress string
    The public IP address.
    PublicIpAddressId string
    The resource ID of the public IP address.
    RdpAuthority string
    The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).
    SharedPublicIpAddressConfiguration Pulumi.AzureNative.DevTestLab.Inputs.SharedPublicIpAddressConfigurationResponse
    The configuration for sharing a public IP address across multiple virtual machines.
    SshAuthority string
    The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.
    SubnetId string
    The resource ID of the sub net.
    VirtualNetworkId string
    The resource ID of the virtual network.
    DnsName string
    The DNS name.
    PrivateIpAddress string
    The private IP address.
    PublicIpAddress string
    The public IP address.
    PublicIpAddressId string
    The resource ID of the public IP address.
    RdpAuthority string
    The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).
    SharedPublicIpAddressConfiguration SharedPublicIpAddressConfigurationResponse
    The configuration for sharing a public IP address across multiple virtual machines.
    SshAuthority string
    The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.
    SubnetId string
    The resource ID of the sub net.
    VirtualNetworkId string
    The resource ID of the virtual network.
    dnsName String
    The DNS name.
    privateIpAddress String
    The private IP address.
    publicIpAddress String
    The public IP address.
    publicIpAddressId String
    The resource ID of the public IP address.
    rdpAuthority String
    The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).
    sharedPublicIpAddressConfiguration SharedPublicIpAddressConfigurationResponse
    The configuration for sharing a public IP address across multiple virtual machines.
    sshAuthority String
    The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.
    subnetId String
    The resource ID of the sub net.
    virtualNetworkId String
    The resource ID of the virtual network.
    dnsName string
    The DNS name.
    privateIpAddress string
    The private IP address.
    publicIpAddress string
    The public IP address.
    publicIpAddressId string
    The resource ID of the public IP address.
    rdpAuthority string
    The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).
    sharedPublicIpAddressConfiguration SharedPublicIpAddressConfigurationResponse
    The configuration for sharing a public IP address across multiple virtual machines.
    sshAuthority string
    The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.
    subnetId string
    The resource ID of the sub net.
    virtualNetworkId string
    The resource ID of the virtual network.
    dns_name str
    The DNS name.
    private_ip_address str
    The private IP address.
    public_ip_address str
    The public IP address.
    public_ip_address_id str
    The resource ID of the public IP address.
    rdp_authority str
    The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).
    shared_public_ip_address_configuration SharedPublicIpAddressConfigurationResponse
    The configuration for sharing a public IP address across multiple virtual machines.
    ssh_authority str
    The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.
    subnet_id str
    The resource ID of the sub net.
    virtual_network_id str
    The resource ID of the virtual network.
    dnsName String
    The DNS name.
    privateIpAddress String
    The private IP address.
    publicIpAddress String
    The public IP address.
    publicIpAddressId String
    The resource ID of the public IP address.
    rdpAuthority String
    The RdpAuthority property is a server DNS host name or IP address followed by the service port number for RDP (Remote Desktop Protocol).
    sharedPublicIpAddressConfiguration Property Map
    The configuration for sharing a public IP address across multiple virtual machines.
    sshAuthority String
    The SshAuthority property is a server DNS host name or IP address followed by the service port number for SSH.
    subnetId String
    The resource ID of the sub net.
    virtualNetworkId String
    The resource ID of the virtual network.

    NotificationSettingsResponse

    EmailRecipient string
    The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
    NotificationLocale string
    The locale to use when sending a notification (fallback for unsupported languages is EN).
    Status string
    If notifications are enabled for this schedule (i.e. Enabled, Disabled).
    TimeInMinutes int
    Time in minutes before event at which notification will be sent.
    WebhookUrl string
    The webhook URL to which the notification will be sent.
    EmailRecipient string
    The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
    NotificationLocale string
    The locale to use when sending a notification (fallback for unsupported languages is EN).
    Status string
    If notifications are enabled for this schedule (i.e. Enabled, Disabled).
    TimeInMinutes int
    Time in minutes before event at which notification will be sent.
    WebhookUrl string
    The webhook URL to which the notification will be sent.
    emailRecipient String
    The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
    notificationLocale String
    The locale to use when sending a notification (fallback for unsupported languages is EN).
    status String
    If notifications are enabled for this schedule (i.e. Enabled, Disabled).
    timeInMinutes Integer
    Time in minutes before event at which notification will be sent.
    webhookUrl String
    The webhook URL to which the notification will be sent.
    emailRecipient string
    The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
    notificationLocale string
    The locale to use when sending a notification (fallback for unsupported languages is EN).
    status string
    If notifications are enabled for this schedule (i.e. Enabled, Disabled).
    timeInMinutes number
    Time in minutes before event at which notification will be sent.
    webhookUrl string
    The webhook URL to which the notification will be sent.
    email_recipient str
    The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
    notification_locale str
    The locale to use when sending a notification (fallback for unsupported languages is EN).
    status str
    If notifications are enabled for this schedule (i.e. Enabled, Disabled).
    time_in_minutes int
    Time in minutes before event at which notification will be sent.
    webhook_url str
    The webhook URL to which the notification will be sent.
    emailRecipient String
    The email recipient to send notifications to (can be a list of semi-colon separated email addresses).
    notificationLocale String
    The locale to use when sending a notification (fallback for unsupported languages is EN).
    status String
    If notifications are enabled for this schedule (i.e. Enabled, Disabled).
    timeInMinutes Number
    Time in minutes before event at which notification will be sent.
    webhookUrl String
    The webhook URL to which the notification will be sent.

    ScheduleCreationParameterResponse

    Location string
    The location of the new virtual machine or environment
    DailyRecurrence Pulumi.AzureNative.DevTestLab.Inputs.DayDetailsResponse
    If the schedule will occur once each day of the week, specify the daily recurrence.
    HourlyRecurrence Pulumi.AzureNative.DevTestLab.Inputs.HourDetailsResponse
    If the schedule will occur multiple times a day, specify the hourly recurrence.
    Name string
    The name of the virtual machine or environment
    NotificationSettings Pulumi.AzureNative.DevTestLab.Inputs.NotificationSettingsResponse
    Notification settings.
    Status string
    The status of the schedule (i.e. Enabled, Disabled)
    Tags Dictionary<string, string>
    The tags of the resource.
    TargetResourceId string
    The resource ID to which the schedule belongs
    TaskType string
    The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).
    TimeZoneId string
    The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
    WeeklyRecurrence Pulumi.AzureNative.DevTestLab.Inputs.WeekDetailsResponse
    If the schedule will occur only some days of the week, specify the weekly recurrence.
    Location string
    The location of the new virtual machine or environment
    DailyRecurrence DayDetailsResponse
    If the schedule will occur once each day of the week, specify the daily recurrence.
    HourlyRecurrence HourDetailsResponse
    If the schedule will occur multiple times a day, specify the hourly recurrence.
    Name string
    The name of the virtual machine or environment
    NotificationSettings NotificationSettingsResponse
    Notification settings.
    Status string
    The status of the schedule (i.e. Enabled, Disabled)
    Tags map[string]string
    The tags of the resource.
    TargetResourceId string
    The resource ID to which the schedule belongs
    TaskType string
    The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).
    TimeZoneId string
    The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
    WeeklyRecurrence WeekDetailsResponse
    If the schedule will occur only some days of the week, specify the weekly recurrence.
    location String
    The location of the new virtual machine or environment
    dailyRecurrence DayDetailsResponse
    If the schedule will occur once each day of the week, specify the daily recurrence.
    hourlyRecurrence HourDetailsResponse
    If the schedule will occur multiple times a day, specify the hourly recurrence.
    name String
    The name of the virtual machine or environment
    notificationSettings NotificationSettingsResponse
    Notification settings.
    status String
    The status of the schedule (i.e. Enabled, Disabled)
    tags Map<String,String>
    The tags of the resource.
    targetResourceId String
    The resource ID to which the schedule belongs
    taskType String
    The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).
    timeZoneId String
    The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
    weeklyRecurrence WeekDetailsResponse
    If the schedule will occur only some days of the week, specify the weekly recurrence.
    location string
    The location of the new virtual machine or environment
    dailyRecurrence DayDetailsResponse
    If the schedule will occur once each day of the week, specify the daily recurrence.
    hourlyRecurrence HourDetailsResponse
    If the schedule will occur multiple times a day, specify the hourly recurrence.
    name string
    The name of the virtual machine or environment
    notificationSettings NotificationSettingsResponse
    Notification settings.
    status string
    The status of the schedule (i.e. Enabled, Disabled)
    tags {[key: string]: string}
    The tags of the resource.
    targetResourceId string
    The resource ID to which the schedule belongs
    taskType string
    The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).
    timeZoneId string
    The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
    weeklyRecurrence WeekDetailsResponse
    If the schedule will occur only some days of the week, specify the weekly recurrence.
    location str
    The location of the new virtual machine or environment
    daily_recurrence DayDetailsResponse
    If the schedule will occur once each day of the week, specify the daily recurrence.
    hourly_recurrence HourDetailsResponse
    If the schedule will occur multiple times a day, specify the hourly recurrence.
    name str
    The name of the virtual machine or environment
    notification_settings NotificationSettingsResponse
    Notification settings.
    status str
    The status of the schedule (i.e. Enabled, Disabled)
    tags Mapping[str, str]
    The tags of the resource.
    target_resource_id str
    The resource ID to which the schedule belongs
    task_type str
    The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).
    time_zone_id str
    The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
    weekly_recurrence WeekDetailsResponse
    If the schedule will occur only some days of the week, specify the weekly recurrence.
    location String
    The location of the new virtual machine or environment
    dailyRecurrence Property Map
    If the schedule will occur once each day of the week, specify the daily recurrence.
    hourlyRecurrence Property Map
    If the schedule will occur multiple times a day, specify the hourly recurrence.
    name String
    The name of the virtual machine or environment
    notificationSettings Property Map
    Notification settings.
    status String
    The status of the schedule (i.e. Enabled, Disabled)
    tags Map<String>
    The tags of the resource.
    targetResourceId String
    The resource ID to which the schedule belongs
    taskType String
    The task type of the schedule (e.g. LabVmsShutdownTask, LabVmAutoStart).
    timeZoneId String
    The time zone ID (e.g. China Standard Time, Greenland Standard Time, Pacific Standard time, etc.). The possible values for this property can be found in IReadOnlyCollection<string> TimeZoneConverter.TZConvert.KnownWindowsTimeZoneIds (https://github.com/mattjohnsonpint/TimeZoneConverter/blob/main/README.md)
    weeklyRecurrence Property Map
    If the schedule will occur only some days of the week, specify the weekly recurrence.

    SharedPublicIpAddressConfigurationResponse

    inboundNatRules List<Property Map>
    The incoming NAT rules

    WeekDetailsResponse

    Time string
    The time of the day the schedule will occur.
    Weekdays List<string>
    The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).
    Time string
    The time of the day the schedule will occur.
    Weekdays []string
    The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).
    time String
    The time of the day the schedule will occur.
    weekdays List<String>
    The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).
    time string
    The time of the day the schedule will occur.
    weekdays string[]
    The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).
    time str
    The time of the day the schedule will occur.
    weekdays Sequence[str]
    The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).
    time String
    The time of the day the schedule will occur.
    weekdays List<String>
    The days of the week for which the schedule is set (e.g. Sunday, Monday, Tuesday, etc.).

    Package Details

    Repository
    Azure Native pulumi/pulumi-azure-native
    License
    Apache-2.0
    azure-native logo
    This is the latest version of Azure Native. Use the Azure Native v1 docs if using the v1 version of this package.
    Azure Native v2.89.3 published on Thursday, Mar 20, 2025 by Pulumi
    pulumi/pulumi-azure-native