Snapshot resource.
Uses Azure REST API version 2024-03-02. In version 2.x of the Azure Native provider, it used API version 2022-07-02.
Other available API versions: 2022-07-02, 2023-01-02, 2023-04-02, 2023-10-02, 2025-01-02, 2026-03-02. These can be accessed by generating a local SDK package using the CLI command pulumi package add azure-native compute [ApiVersion]. See the version guide for details.
Example Usage
Create a snapshot by importing an unmanaged blob from a different subscription.
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var snapshot = new AzureNative.Compute.Snapshot("snapshot", new()
{
CreationData = new AzureNative.Compute.Inputs.CreationDataArgs
{
CreateOption = AzureNative.Compute.DiskCreateOption.Import,
SourceUri = "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd",
StorageAccountId = "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount",
},
Location = "West US",
ResourceGroupName = "myResourceGroup",
SnapshotName = "mySnapshot1",
});
});
package main
import (
compute "github.com/pulumi/pulumi-azure-native-sdk/compute/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := compute.NewSnapshot(ctx, "snapshot", &compute.SnapshotArgs{
CreationData: &compute.CreationDataArgs{
CreateOption: pulumi.String(compute.DiskCreateOptionImport),
SourceUri: pulumi.String("https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd"),
StorageAccountId: pulumi.String("subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount"),
},
Location: pulumi.String("West US"),
ResourceGroupName: pulumi.String("myResourceGroup"),
SnapshotName: pulumi.String("mySnapshot1"),
})
if err != nil {
return err
}
return nil
})
}
terraform {
required_providers {
azure-native = {
source = "pulumi/azure-native"
}
}
}
resource "azure-native_compute_snapshot" "snapshot" {
lifecycle {
create_before_destroy = true
}
creation_data = {
create_option = "Import"
source_uri = "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd"
storage_account_id = "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount"
}
location = "West US"
resource_group_name = "myResourceGroup"
snapshot_name = "mySnapshot1"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.compute.Snapshot;
import com.pulumi.azurenative.compute.SnapshotArgs;
import com.pulumi.azurenative.compute.inputs.CreationDataArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var snapshot = new Snapshot("snapshot", SnapshotArgs.builder()
.creationData(CreationDataArgs.builder()
.createOption("Import")
.sourceUri("https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd")
.storageAccountId("subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount")
.build())
.location("West US")
.resourceGroupName("myResourceGroup")
.snapshotName("mySnapshot1")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const snapshot = new azure_native.compute.Snapshot("snapshot", {
creationData: {
createOption: azure_native.compute.DiskCreateOption.Import,
sourceUri: "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd",
storageAccountId: "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount",
},
location: "West US",
resourceGroupName: "myResourceGroup",
snapshotName: "mySnapshot1",
});
import pulumi
import pulumi_azure_native as azure_native
snapshot = azure_native.compute.Snapshot("snapshot",
creation_data={
"create_option": azure_native.compute.DiskCreateOption.IMPORT_,
"source_uri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd",
"storage_account_id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount",
},
location="West US",
resource_group_name="myResourceGroup",
snapshot_name="mySnapshot1")
resources:
snapshot:
type: azure-native:compute:Snapshot
properties:
creationData:
createOption: Import
sourceUri: https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd
storageAccountId: subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount
location: West US
resourceGroupName: myResourceGroup
snapshotName: mySnapshot1
Create a snapshot by importing an unmanaged blob from the same subscription.
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var snapshot = new AzureNative.Compute.Snapshot("snapshot", new()
{
CreationData = new AzureNative.Compute.Inputs.CreationDataArgs
{
CreateOption = AzureNative.Compute.DiskCreateOption.Import,
SourceUri = "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd",
},
Location = "West US",
ResourceGroupName = "myResourceGroup",
SnapshotName = "mySnapshot1",
});
});
package main
import (
compute "github.com/pulumi/pulumi-azure-native-sdk/compute/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := compute.NewSnapshot(ctx, "snapshot", &compute.SnapshotArgs{
CreationData: &compute.CreationDataArgs{
CreateOption: pulumi.String(compute.DiskCreateOptionImport),
SourceUri: pulumi.String("https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd"),
},
Location: pulumi.String("West US"),
ResourceGroupName: pulumi.String("myResourceGroup"),
SnapshotName: pulumi.String("mySnapshot1"),
})
if err != nil {
return err
}
return nil
})
}
terraform {
required_providers {
azure-native = {
source = "pulumi/azure-native"
}
}
}
resource "azure-native_compute_snapshot" "snapshot" {
lifecycle {
create_before_destroy = true
}
creation_data = {
create_option = "Import"
source_uri = "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd"
}
location = "West US"
resource_group_name = "myResourceGroup"
snapshot_name = "mySnapshot1"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.compute.Snapshot;
import com.pulumi.azurenative.compute.SnapshotArgs;
import com.pulumi.azurenative.compute.inputs.CreationDataArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var snapshot = new Snapshot("snapshot", SnapshotArgs.builder()
.creationData(CreationDataArgs.builder()
.createOption("Import")
.sourceUri("https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd")
.build())
.location("West US")
.resourceGroupName("myResourceGroup")
.snapshotName("mySnapshot1")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const snapshot = new azure_native.compute.Snapshot("snapshot", {
creationData: {
createOption: azure_native.compute.DiskCreateOption.Import,
sourceUri: "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd",
},
location: "West US",
resourceGroupName: "myResourceGroup",
snapshotName: "mySnapshot1",
});
import pulumi
import pulumi_azure_native as azure_native
snapshot = azure_native.compute.Snapshot("snapshot",
creation_data={
"create_option": azure_native.compute.DiskCreateOption.IMPORT_,
"source_uri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd",
},
location="West US",
resource_group_name="myResourceGroup",
snapshot_name="mySnapshot1")
resources:
snapshot:
type: azure-native:compute:Snapshot
properties:
creationData:
createOption: Import
sourceUri: https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd
location: West US
resourceGroupName: myResourceGroup
snapshotName: mySnapshot1
Create a snapshot from an elastic san volume snapshot.
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var snapshot = new AzureNative.Compute.Snapshot("snapshot", new()
{
CreationData = new AzureNative.Compute.Inputs.CreationDataArgs
{
CreateOption = AzureNative.Compute.DiskCreateOption.CopyFromSanSnapshot,
ElasticSanResourceId = "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ElasticSan/elasticSans/myElasticSan/volumegroups/myElasticSanVolumeGroup/snapshots/myElasticSanVolumeSnapshot",
},
Location = "West US",
ResourceGroupName = "myResourceGroup",
SnapshotName = "mySnapshot",
});
});
package main
import (
compute "github.com/pulumi/pulumi-azure-native-sdk/compute/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := compute.NewSnapshot(ctx, "snapshot", &compute.SnapshotArgs{
CreationData: &compute.CreationDataArgs{
CreateOption: pulumi.String(compute.DiskCreateOptionCopyFromSanSnapshot),
ElasticSanResourceId: pulumi.String("subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ElasticSan/elasticSans/myElasticSan/volumegroups/myElasticSanVolumeGroup/snapshots/myElasticSanVolumeSnapshot"),
},
Location: pulumi.String("West US"),
ResourceGroupName: pulumi.String("myResourceGroup"),
SnapshotName: pulumi.String("mySnapshot"),
})
if err != nil {
return err
}
return nil
})
}
terraform {
required_providers {
azure-native = {
source = "pulumi/azure-native"
}
}
}
resource "azure-native_compute_snapshot" "snapshot" {
lifecycle {
create_before_destroy = true
}
creation_data = {
create_option = "CopyFromSanSnapshot"
elastic_san_resource_id = "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ElasticSan/elasticSans/myElasticSan/volumegroups/myElasticSanVolumeGroup/snapshots/myElasticSanVolumeSnapshot"
}
location = "West US"
resource_group_name = "myResourceGroup"
snapshot_name = "mySnapshot"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.compute.Snapshot;
import com.pulumi.azurenative.compute.SnapshotArgs;
import com.pulumi.azurenative.compute.inputs.CreationDataArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var snapshot = new Snapshot("snapshot", SnapshotArgs.builder()
.creationData(CreationDataArgs.builder()
.createOption("CopyFromSanSnapshot")
.elasticSanResourceId("subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ElasticSan/elasticSans/myElasticSan/volumegroups/myElasticSanVolumeGroup/snapshots/myElasticSanVolumeSnapshot")
.build())
.location("West US")
.resourceGroupName("myResourceGroup")
.snapshotName("mySnapshot")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const snapshot = new azure_native.compute.Snapshot("snapshot", {
creationData: {
createOption: azure_native.compute.DiskCreateOption.CopyFromSanSnapshot,
elasticSanResourceId: "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ElasticSan/elasticSans/myElasticSan/volumegroups/myElasticSanVolumeGroup/snapshots/myElasticSanVolumeSnapshot",
},
location: "West US",
resourceGroupName: "myResourceGroup",
snapshotName: "mySnapshot",
});
import pulumi
import pulumi_azure_native as azure_native
snapshot = azure_native.compute.Snapshot("snapshot",
creation_data={
"create_option": azure_native.compute.DiskCreateOption.COPY_FROM_SAN_SNAPSHOT,
"elastic_san_resource_id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ElasticSan/elasticSans/myElasticSan/volumegroups/myElasticSanVolumeGroup/snapshots/myElasticSanVolumeSnapshot",
},
location="West US",
resource_group_name="myResourceGroup",
snapshot_name="mySnapshot")
resources:
snapshot:
type: azure-native:compute:Snapshot
properties:
creationData:
createOption: CopyFromSanSnapshot
elasticSanResourceId: subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.ElasticSan/elasticSans/myElasticSan/volumegroups/myElasticSanVolumeGroup/snapshots/myElasticSanVolumeSnapshot
location: West US
resourceGroupName: myResourceGroup
snapshotName: mySnapshot
Create a snapshot from an existing snapshot in the same or a different subscription in a different region with quicker copy speed.
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var snapshot = new AzureNative.Compute.Snapshot("snapshot", new()
{
CreationData = new AzureNative.Compute.Inputs.CreationDataArgs
{
CreateOption = AzureNative.Compute.DiskCreateOption.CopyStart,
ProvisionedBandwidthCopySpeed = AzureNative.Compute.ProvisionedBandwidthCopyOption.Enhanced,
SourceResourceId = "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1",
},
Location = "West US",
ResourceGroupName = "myResourceGroup",
SnapshotName = "mySnapshot2",
});
});
package main
import (
compute "github.com/pulumi/pulumi-azure-native-sdk/compute/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := compute.NewSnapshot(ctx, "snapshot", &compute.SnapshotArgs{
CreationData: &compute.CreationDataArgs{
CreateOption: pulumi.String(compute.DiskCreateOptionCopyStart),
ProvisionedBandwidthCopySpeed: pulumi.String(compute.ProvisionedBandwidthCopyOptionEnhanced),
SourceResourceId: pulumi.String("subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1"),
},
Location: pulumi.String("West US"),
ResourceGroupName: pulumi.String("myResourceGroup"),
SnapshotName: pulumi.String("mySnapshot2"),
})
if err != nil {
return err
}
return nil
})
}
terraform {
required_providers {
azure-native = {
source = "pulumi/azure-native"
}
}
}
resource "azure-native_compute_snapshot" "snapshot" {
lifecycle {
create_before_destroy = true
}
creation_data = {
create_option = "CopyStart"
provisioned_bandwidth_copy_speed = "Enhanced"
source_resource_id = "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1"
}
location = "West US"
resource_group_name = "myResourceGroup"
snapshot_name = "mySnapshot2"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.compute.Snapshot;
import com.pulumi.azurenative.compute.SnapshotArgs;
import com.pulumi.azurenative.compute.inputs.CreationDataArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var snapshot = new Snapshot("snapshot", SnapshotArgs.builder()
.creationData(CreationDataArgs.builder()
.createOption("CopyStart")
.provisionedBandwidthCopySpeed("Enhanced")
.sourceResourceId("subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1")
.build())
.location("West US")
.resourceGroupName("myResourceGroup")
.snapshotName("mySnapshot2")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const snapshot = new azure_native.compute.Snapshot("snapshot", {
creationData: {
createOption: azure_native.compute.DiskCreateOption.CopyStart,
provisionedBandwidthCopySpeed: azure_native.compute.ProvisionedBandwidthCopyOption.Enhanced,
sourceResourceId: "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1",
},
location: "West US",
resourceGroupName: "myResourceGroup",
snapshotName: "mySnapshot2",
});
import pulumi
import pulumi_azure_native as azure_native
snapshot = azure_native.compute.Snapshot("snapshot",
creation_data={
"create_option": azure_native.compute.DiskCreateOption.COPY_START,
"provisioned_bandwidth_copy_speed": azure_native.compute.ProvisionedBandwidthCopyOption.ENHANCED,
"source_resource_id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1",
},
location="West US",
resource_group_name="myResourceGroup",
snapshot_name="mySnapshot2")
resources:
snapshot:
type: azure-native:compute:Snapshot
properties:
creationData:
createOption: CopyStart
provisionedBandwidthCopySpeed: Enhanced
sourceResourceId: subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1
location: West US
resourceGroupName: myResourceGroup
snapshotName: mySnapshot2
Create a snapshot from an existing snapshot in the same or a different subscription in a different region.
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var snapshot = new AzureNative.Compute.Snapshot("snapshot", new()
{
CreationData = new AzureNative.Compute.Inputs.CreationDataArgs
{
CreateOption = AzureNative.Compute.DiskCreateOption.CopyStart,
SourceResourceId = "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1",
},
Location = "West US",
ResourceGroupName = "myResourceGroup",
SnapshotName = "mySnapshot2",
});
});
package main
import (
compute "github.com/pulumi/pulumi-azure-native-sdk/compute/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := compute.NewSnapshot(ctx, "snapshot", &compute.SnapshotArgs{
CreationData: &compute.CreationDataArgs{
CreateOption: pulumi.String(compute.DiskCreateOptionCopyStart),
SourceResourceId: pulumi.String("subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1"),
},
Location: pulumi.String("West US"),
ResourceGroupName: pulumi.String("myResourceGroup"),
SnapshotName: pulumi.String("mySnapshot2"),
})
if err != nil {
return err
}
return nil
})
}
terraform {
required_providers {
azure-native = {
source = "pulumi/azure-native"
}
}
}
resource "azure-native_compute_snapshot" "snapshot" {
lifecycle {
create_before_destroy = true
}
creation_data = {
create_option = "CopyStart"
source_resource_id = "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1"
}
location = "West US"
resource_group_name = "myResourceGroup"
snapshot_name = "mySnapshot2"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.compute.Snapshot;
import com.pulumi.azurenative.compute.SnapshotArgs;
import com.pulumi.azurenative.compute.inputs.CreationDataArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var snapshot = new Snapshot("snapshot", SnapshotArgs.builder()
.creationData(CreationDataArgs.builder()
.createOption("CopyStart")
.sourceResourceId("subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1")
.build())
.location("West US")
.resourceGroupName("myResourceGroup")
.snapshotName("mySnapshot2")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const snapshot = new azure_native.compute.Snapshot("snapshot", {
creationData: {
createOption: azure_native.compute.DiskCreateOption.CopyStart,
sourceResourceId: "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1",
},
location: "West US",
resourceGroupName: "myResourceGroup",
snapshotName: "mySnapshot2",
});
import pulumi
import pulumi_azure_native as azure_native
snapshot = azure_native.compute.Snapshot("snapshot",
creation_data={
"create_option": azure_native.compute.DiskCreateOption.COPY_START,
"source_resource_id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1",
},
location="West US",
resource_group_name="myResourceGroup",
snapshot_name="mySnapshot2")
resources:
snapshot:
type: azure-native:compute:Snapshot
properties:
creationData:
createOption: CopyStart
sourceResourceId: subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1
location: West US
resourceGroupName: myResourceGroup
snapshotName: mySnapshot2
Create a snapshot from an existing snapshot in the same or a different subscription.
using System.Collections.Generic;
using System.Linq;
using Pulumi;
using AzureNative = Pulumi.AzureNative;
return await Deployment.RunAsync(() =>
{
var snapshot = new AzureNative.Compute.Snapshot("snapshot", new()
{
CreationData = new AzureNative.Compute.Inputs.CreationDataArgs
{
CreateOption = AzureNative.Compute.DiskCreateOption.Copy,
SourceResourceId = "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1",
},
Location = "West US",
ResourceGroupName = "myResourceGroup",
SnapshotName = "mySnapshot2",
});
});
package main
import (
compute "github.com/pulumi/pulumi-azure-native-sdk/compute/v3"
"github.com/pulumi/pulumi/sdk/v3/go/pulumi"
)
func main() {
pulumi.Run(func(ctx *pulumi.Context) error {
_, err := compute.NewSnapshot(ctx, "snapshot", &compute.SnapshotArgs{
CreationData: &compute.CreationDataArgs{
CreateOption: pulumi.String(compute.DiskCreateOptionCopy),
SourceResourceId: pulumi.String("subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1"),
},
Location: pulumi.String("West US"),
ResourceGroupName: pulumi.String("myResourceGroup"),
SnapshotName: pulumi.String("mySnapshot2"),
})
if err != nil {
return err
}
return nil
})
}
terraform {
required_providers {
azure-native = {
source = "pulumi/azure-native"
}
}
}
resource "azure-native_compute_snapshot" "snapshot" {
lifecycle {
create_before_destroy = true
}
creation_data = {
create_option = "Copy"
source_resource_id = "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1"
}
location = "West US"
resource_group_name = "myResourceGroup"
snapshot_name = "mySnapshot2"
}
package generated_program;
import com.pulumi.Context;
import com.pulumi.Pulumi;
import com.pulumi.core.Output;
import com.pulumi.azurenative.compute.Snapshot;
import com.pulumi.azurenative.compute.SnapshotArgs;
import com.pulumi.azurenative.compute.inputs.CreationDataArgs;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.Map;
import java.io.File;
import java.nio.file.Files;
import java.nio.file.Paths;
public class App {
public static void main(String[] args) {
Pulumi.run(App::stack);
}
public static void stack(Context ctx) {
var snapshot = new Snapshot("snapshot", SnapshotArgs.builder()
.creationData(CreationDataArgs.builder()
.createOption("Copy")
.sourceResourceId("subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1")
.build())
.location("West US")
.resourceGroupName("myResourceGroup")
.snapshotName("mySnapshot2")
.build());
}
}
import * as pulumi from "@pulumi/pulumi";
import * as azure_native from "@pulumi/azure-native";
const snapshot = new azure_native.compute.Snapshot("snapshot", {
creationData: {
createOption: azure_native.compute.DiskCreateOption.Copy,
sourceResourceId: "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1",
},
location: "West US",
resourceGroupName: "myResourceGroup",
snapshotName: "mySnapshot2",
});
import pulumi
import pulumi_azure_native as azure_native
snapshot = azure_native.compute.Snapshot("snapshot",
creation_data={
"create_option": azure_native.compute.DiskCreateOption.COPY,
"source_resource_id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1",
},
location="West US",
resource_group_name="myResourceGroup",
snapshot_name="mySnapshot2")
resources:
snapshot:
type: azure-native:compute:Snapshot
properties:
creationData:
createOption: Copy
sourceResourceId: subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1
location: West US
resourceGroupName: myResourceGroup
snapshotName: mySnapshot2
Create Snapshot Resource
Resources are created with functions called constructors. To learn more about declaring and configuring resources, see Resources.
Constructor syntax
@overload
def Snapshot(resource_name: str,
args: SnapshotArgs,
opts: Optional[ResourceOptions] = None)
@overload
def Snapshot(resource_name: str,
opts: Optional[ResourceOptions] = None,
creation_data: Optional[CreationDataArgs] = None,
resource_group_name: Optional[str] = None,
incremental: Optional[bool] = None,
os_type: Optional[OperatingSystemTypes] = None,
disk_access_id: Optional[str] = None,
disk_size_gb: Optional[int] = None,
encryption: Optional[EncryptionArgs] = None,
encryption_settings_collection: Optional[EncryptionSettingsCollectionArgs] = None,
extended_location: Optional[ExtendedLocationArgs] = None,
hyper_v_generation: Optional[Union[str, HyperVGeneration]] = None,
completion_percent: Optional[float] = None,
location: Optional[str] = None,
network_access_policy: Optional[Union[str, NetworkAccessPolicy]] = None,
data_access_auth_mode: Optional[Union[str, DataAccessAuthMode]] = None,
public_network_access: Optional[Union[str, PublicNetworkAccess]] = None,
purchase_plan: Optional[DiskPurchasePlanArgs] = None,
copy_completion_error: Optional[CopyCompletionErrorArgs] = None,
security_profile: Optional[DiskSecurityProfileArgs] = None,
sku: Optional[SnapshotSkuArgs] = None,
snapshot_name: Optional[str] = None,
supported_capabilities: Optional[SupportedCapabilitiesArgs] = None,
supports_hibernation: Optional[bool] = None,
tags: Optional[Mapping[str, str]] = None)
public Snapshot(String name, SnapshotArgs args)
public Snapshot(String name, SnapshotArgs args, CustomResourceOptions options)
type: azure-native:compute:Snapshot
properties: # The arguments to resource properties.
options: # Bag of options to control resource's behavior.
resource "azure-native_compute_snapshot" "name" {
# resource properties
}
Parameters
- name
string
- The unique name of the resource.
- args
SnapshotArgs
- The arguments to resource properties.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
str
- The unique name of the resource.
- args
SnapshotArgs
- The arguments to resource properties.
- opts
ResourceOptions
- Bag of options to control resource's behavior.
- ctx
Context
- Context object for the current deployment.
- name
string
- The unique name of the resource.
- args
SnapshotArgs
- The arguments to resource properties.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
string
- The unique name of the resource.
- args
SnapshotArgs
- The arguments to resource properties.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resource.
- args
SnapshotArgs
- The arguments to resource properties.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Constructor example
The following reference example uses placeholder values for all input properties.
var azure_nativeSnapshotResource = new AzureNative.Compute.Snapshot("azure-nativeSnapshotResource", new()
{
CreationData = new AzureNative.Compute.Inputs.CreationDataArgs
{
CreateOption = "string",
ElasticSanResourceId = "string",
GalleryImageReference = new AzureNative.Compute.Inputs.ImageDiskReferenceArgs
{
CommunityGalleryImageId = "string",
Id = "string",
Lun = 0,
SharedGalleryImageId = "string",
},
ImageReference = new AzureNative.Compute.Inputs.ImageDiskReferenceArgs
{
CommunityGalleryImageId = "string",
Id = "string",
Lun = 0,
SharedGalleryImageId = "string",
},
LogicalSectorSize = 0,
PerformancePlus = false,
ProvisionedBandwidthCopySpeed = "string",
SecurityDataUri = "string",
SourceResourceId = "string",
SourceUri = "string",
StorageAccountId = "string",
UploadSizeBytes = 0.0,
},
ResourceGroupName = "string",
Incremental = false,
OsType = AzureNative.Compute.OperatingSystemTypes.Windows,
DiskAccessId = "string",
DiskSizeGB = 0,
Encryption = new AzureNative.Compute.Inputs.EncryptionArgs
{
DiskEncryptionSetId = "string",
Type = "string",
},
EncryptionSettingsCollection = new AzureNative.Compute.Inputs.EncryptionSettingsCollectionArgs
{
Enabled = false,
EncryptionSettings = new[]
{
new AzureNative.Compute.Inputs.EncryptionSettingsElementArgs
{
DiskEncryptionKey = new AzureNative.Compute.Inputs.KeyVaultAndSecretReferenceArgs
{
SecretUrl = "string",
SourceVault = new AzureNative.Compute.Inputs.SourceVaultArgs
{
Id = "string",
},
},
KeyEncryptionKey = new AzureNative.Compute.Inputs.KeyVaultAndKeyReferenceArgs
{
KeyUrl = "string",
SourceVault = new AzureNative.Compute.Inputs.SourceVaultArgs
{
Id = "string",
},
},
},
},
EncryptionSettingsVersion = "string",
},
ExtendedLocation = new AzureNative.Compute.Inputs.ExtendedLocationArgs
{
Name = "string",
Type = "string",
},
HyperVGeneration = "string",
CompletionPercent = 0.0,
Location = "string",
NetworkAccessPolicy = "string",
DataAccessAuthMode = "string",
PublicNetworkAccess = "string",
PurchasePlan = new AzureNative.Compute.Inputs.DiskPurchasePlanArgs
{
Name = "string",
Product = "string",
Publisher = "string",
PromotionCode = "string",
},
CopyCompletionError = new AzureNative.Compute.Inputs.CopyCompletionErrorArgs
{
ErrorCode = "string",
ErrorMessage = "string",
},
SecurityProfile = new AzureNative.Compute.Inputs.DiskSecurityProfileArgs
{
SecureVMDiskEncryptionSetId = "string",
SecurityType = "string",
},
Sku = new AzureNative.Compute.Inputs.SnapshotSkuArgs
{
Name = "string",
},
SnapshotName = "string",
SupportedCapabilities = new AzureNative.Compute.Inputs.SupportedCapabilitiesArgs
{
AcceleratedNetwork = false,
Architecture = "string",
DiskControllerTypes = "string",
},
SupportsHibernation = false,
Tags =
{
{ "string", "string" },
},
});
example, err := compute.NewSnapshot(ctx, "azure-nativeSnapshotResource", &compute.SnapshotArgs{
CreationData: &compute.CreationDataArgs{
CreateOption: pulumi.String("string"),
ElasticSanResourceId: pulumi.String("string"),
GalleryImageReference: &compute.ImageDiskReferenceArgs{
CommunityGalleryImageId: pulumi.String("string"),
Id: pulumi.String("string"),
Lun: pulumi.Int(0),
SharedGalleryImageId: pulumi.String("string"),
},
ImageReference: &compute.ImageDiskReferenceArgs{
CommunityGalleryImageId: pulumi.String("string"),
Id: pulumi.String("string"),
Lun: pulumi.Int(0),
SharedGalleryImageId: pulumi.String("string"),
},
LogicalSectorSize: pulumi.Int(0),
PerformancePlus: pulumi.Bool(false),
ProvisionedBandwidthCopySpeed: pulumi.String("string"),
SecurityDataUri: pulumi.String("string"),
SourceResourceId: pulumi.String("string"),
SourceUri: pulumi.String("string"),
StorageAccountId: pulumi.String("string"),
UploadSizeBytes: pulumi.Float64(0),
},
ResourceGroupName: pulumi.String("string"),
Incremental: pulumi.Bool(false),
OsType: compute.OperatingSystemTypesWindows,
DiskAccessId: pulumi.String("string"),
DiskSizeGB: pulumi.Int(0),
Encryption: &compute.EncryptionArgs{
DiskEncryptionSetId: pulumi.String("string"),
Type: pulumi.String("string"),
},
EncryptionSettingsCollection: &compute.EncryptionSettingsCollectionArgs{
Enabled: pulumi.Bool(false),
EncryptionSettings: compute.EncryptionSettingsElementArray{
&compute.EncryptionSettingsElementArgs{
DiskEncryptionKey: &compute.KeyVaultAndSecretReferenceArgs{
SecretUrl: pulumi.String("string"),
SourceVault: &compute.SourceVaultArgs{
Id: pulumi.String("string"),
},
},
KeyEncryptionKey: &compute.KeyVaultAndKeyReferenceArgs{
KeyUrl: pulumi.String("string"),
SourceVault: &compute.SourceVaultArgs{
Id: pulumi.String("string"),
},
},
},
},
EncryptionSettingsVersion: pulumi.String("string"),
},
ExtendedLocation: &compute.ExtendedLocationArgs{
Name: pulumi.String("string"),
Type: pulumi.String("string"),
},
HyperVGeneration: pulumi.String("string"),
CompletionPercent: pulumi.Float64(0),
Location: pulumi.String("string"),
NetworkAccessPolicy: pulumi.String("string"),
DataAccessAuthMode: pulumi.String("string"),
PublicNetworkAccess: pulumi.String("string"),
PurchasePlan: &compute.DiskPurchasePlanArgs{
Name: pulumi.String("string"),
Product: pulumi.String("string"),
Publisher: pulumi.String("string"),
PromotionCode: pulumi.String("string"),
},
CopyCompletionError: &compute.CopyCompletionErrorArgs{
ErrorCode: pulumi.String("string"),
ErrorMessage: pulumi.String("string"),
},
SecurityProfile: &compute.DiskSecurityProfileArgs{
SecureVMDiskEncryptionSetId: pulumi.String("string"),
SecurityType: pulumi.String("string"),
},
Sku: &compute.SnapshotSkuArgs{
Name: pulumi.String("string"),
},
SnapshotName: pulumi.String("string"),
SupportedCapabilities: &compute.SupportedCapabilitiesArgs{
AcceleratedNetwork: pulumi.Bool(false),
Architecture: pulumi.String("string"),
DiskControllerTypes: pulumi.String("string"),
},
SupportsHibernation: pulumi.Bool(false),
Tags: pulumi.StringMap{
"string": pulumi.String("string"),
},
})
resource "azure-native_compute_snapshot" "azure-nativeSnapshotResource" {
lifecycle {
create_before_destroy = true
}
creation_data = {
create_option = "string"
elastic_san_resource_id = "string"
gallery_image_reference = {
community_gallery_image_id = "string"
id = "string"
lun = 0
shared_gallery_image_id = "string"
}
image_reference = {
community_gallery_image_id = "string"
id = "string"
lun = 0
shared_gallery_image_id = "string"
}
logical_sector_size = 0
performance_plus = false
provisioned_bandwidth_copy_speed = "string"
security_data_uri = "string"
source_resource_id = "string"
source_uri = "string"
storage_account_id = "string"
upload_size_bytes = 0
}
resource_group_name = "string"
incremental = false
os_type = "Windows"
disk_access_id = "string"
disk_size_gb = 0
encryption = {
disk_encryption_set_id = "string"
type = "string"
}
encryption_settings_collection = {
enabled = false
encryption_settings = [{
disk_encryption_key = {
secret_url = "string"
source_vault = {
id = "string"
}
}
key_encryption_key = {
key_url = "string"
source_vault = {
id = "string"
}
}
}]
encryption_settings_version = "string"
}
extended_location = {
name = "string"
type = "string"
}
hyper_v_generation = "string"
completion_percent = 0
location = "string"
network_access_policy = "string"
data_access_auth_mode = "string"
public_network_access = "string"
purchase_plan = {
name = "string"
product = "string"
publisher = "string"
promotion_code = "string"
}
copy_completion_error = {
error_code = "string"
error_message = "string"
}
security_profile = {
secure_vm_disk_encryption_set_id = "string"
security_type = "string"
}
sku = {
name = "string"
}
snapshot_name = "string"
supported_capabilities = {
accelerated_network = false
architecture = "string"
disk_controller_types = "string"
}
supports_hibernation = false
tags = {
"string" = "string"
}
}
var azure_nativeSnapshotResource = new com.pulumi.azurenative.compute.Snapshot("azure-nativeSnapshotResource", com.pulumi.azurenative.compute.SnapshotArgs.builder()
.creationData(com.pulumi.azurenative.compute.inputs.CreationDataArgs.builder()
.createOption("string")
.elasticSanResourceId("string")
.galleryImageReference(ImageDiskReferenceArgs.builder()
.communityGalleryImageId("string")
.id("string")
.lun(0)
.sharedGalleryImageId("string")
.build())
.imageReference(ImageDiskReferenceArgs.builder()
.communityGalleryImageId("string")
.id("string")
.lun(0)
.sharedGalleryImageId("string")
.build())
.logicalSectorSize(0)
.performancePlus(false)
.provisionedBandwidthCopySpeed("string")
.securityDataUri("string")
.sourceResourceId("string")
.sourceUri("string")
.storageAccountId("string")
.uploadSizeBytes(0.0)
.build())
.resourceGroupName("string")
.incremental(false)
.osType(com.pulumi.azurenative.compute.enums.OperatingSystemTypes.Windows)
.diskAccessId("string")
.diskSizeGB(0)
.encryption(com.pulumi.azurenative.compute.inputs.EncryptionArgs.builder()
.diskEncryptionSetId("string")
.type("string")
.build())
.encryptionSettingsCollection(EncryptionSettingsCollectionArgs.builder()
.enabled(false)
.encryptionSettings(EncryptionSettingsElementArgs.builder()
.diskEncryptionKey(KeyVaultAndSecretReferenceArgs.builder()
.secretUrl("string")
.sourceVault(SourceVaultArgs.builder()
.id("string")
.build())
.build())
.keyEncryptionKey(KeyVaultAndKeyReferenceArgs.builder()
.keyUrl("string")
.sourceVault(SourceVaultArgs.builder()
.id("string")
.build())
.build())
.build())
.encryptionSettingsVersion("string")
.build())
.extendedLocation(com.pulumi.azurenative.compute.inputs.ExtendedLocationArgs.builder()
.name("string")
.type("string")
.build())
.hyperVGeneration("string")
.completionPercent(0.0)
.location("string")
.networkAccessPolicy("string")
.dataAccessAuthMode("string")
.publicNetworkAccess("string")
.purchasePlan(DiskPurchasePlanArgs.builder()
.name("string")
.product("string")
.publisher("string")
.promotionCode("string")
.build())
.copyCompletionError(CopyCompletionErrorArgs.builder()
.errorCode("string")
.errorMessage("string")
.build())
.securityProfile(DiskSecurityProfileArgs.builder()
.secureVMDiskEncryptionSetId("string")
.securityType("string")
.build())
.sku(SnapshotSkuArgs.builder()
.name("string")
.build())
.snapshotName("string")
.supportedCapabilities(SupportedCapabilitiesArgs.builder()
.acceleratedNetwork(false)
.architecture("string")
.diskControllerTypes("string")
.build())
.supportsHibernation(false)
.tags(Map.of("string", "string"))
.build());
azure_native_snapshot_resource = azure_native.compute.Snapshot("azure-nativeSnapshotResource",
creation_data={
"create_option": "string",
"elastic_san_resource_id": "string",
"gallery_image_reference": {
"community_gallery_image_id": "string",
"id": "string",
"lun": 0,
"shared_gallery_image_id": "string",
},
"image_reference": {
"community_gallery_image_id": "string",
"id": "string",
"lun": 0,
"shared_gallery_image_id": "string",
},
"logical_sector_size": 0,
"performance_plus": False,
"provisioned_bandwidth_copy_speed": "string",
"security_data_uri": "string",
"source_resource_id": "string",
"source_uri": "string",
"storage_account_id": "string",
"upload_size_bytes": float(0),
},
resource_group_name="string",
incremental=False,
os_type=azure_native.compute.OperatingSystemTypes.WINDOWS,
disk_access_id="string",
disk_size_gb=0,
encryption={
"disk_encryption_set_id": "string",
"type": "string",
},
encryption_settings_collection={
"enabled": False,
"encryption_settings": [{
"disk_encryption_key": {
"secret_url": "string",
"source_vault": {
"id": "string",
},
},
"key_encryption_key": {
"key_url": "string",
"source_vault": {
"id": "string",
},
},
}],
"encryption_settings_version": "string",
},
extended_location={
"name": "string",
"type": "string",
},
hyper_v_generation="string",
completion_percent=float(0),
location="string",
network_access_policy="string",
data_access_auth_mode="string",
public_network_access="string",
purchase_plan={
"name": "string",
"product": "string",
"publisher": "string",
"promotion_code": "string",
},
copy_completion_error={
"error_code": "string",
"error_message": "string",
},
security_profile={
"secure_vm_disk_encryption_set_id": "string",
"security_type": "string",
},
sku={
"name": "string",
},
snapshot_name="string",
supported_capabilities={
"accelerated_network": False,
"architecture": "string",
"disk_controller_types": "string",
},
supports_hibernation=False,
tags={
"string": "string",
})
const azure_nativeSnapshotResource = new azure_native.compute.Snapshot("azure-nativeSnapshotResource", {
creationData: {
createOption: "string",
elasticSanResourceId: "string",
galleryImageReference: {
communityGalleryImageId: "string",
id: "string",
lun: 0,
sharedGalleryImageId: "string",
},
imageReference: {
communityGalleryImageId: "string",
id: "string",
lun: 0,
sharedGalleryImageId: "string",
},
logicalSectorSize: 0,
performancePlus: false,
provisionedBandwidthCopySpeed: "string",
securityDataUri: "string",
sourceResourceId: "string",
sourceUri: "string",
storageAccountId: "string",
uploadSizeBytes: 0,
},
resourceGroupName: "string",
incremental: false,
osType: azure_native.compute.OperatingSystemTypes.Windows,
diskAccessId: "string",
diskSizeGB: 0,
encryption: {
diskEncryptionSetId: "string",
type: "string",
},
encryptionSettingsCollection: {
enabled: false,
encryptionSettings: [{
diskEncryptionKey: {
secretUrl: "string",
sourceVault: {
id: "string",
},
},
keyEncryptionKey: {
keyUrl: "string",
sourceVault: {
id: "string",
},
},
}],
encryptionSettingsVersion: "string",
},
extendedLocation: {
name: "string",
type: "string",
},
hyperVGeneration: "string",
completionPercent: 0,
location: "string",
networkAccessPolicy: "string",
dataAccessAuthMode: "string",
publicNetworkAccess: "string",
purchasePlan: {
name: "string",
product: "string",
publisher: "string",
promotionCode: "string",
},
copyCompletionError: {
errorCode: "string",
errorMessage: "string",
},
securityProfile: {
secureVMDiskEncryptionSetId: "string",
securityType: "string",
},
sku: {
name: "string",
},
snapshotName: "string",
supportedCapabilities: {
acceleratedNetwork: false,
architecture: "string",
diskControllerTypes: "string",
},
supportsHibernation: false,
tags: {
string: "string",
},
});
type: azure-native:compute:Snapshot
properties:
completionPercent: 0
copyCompletionError:
errorCode: string
errorMessage: string
creationData:
createOption: string
elasticSanResourceId: string
galleryImageReference:
communityGalleryImageId: string
id: string
lun: 0
sharedGalleryImageId: string
imageReference:
communityGalleryImageId: string
id: string
lun: 0
sharedGalleryImageId: string
logicalSectorSize: 0
performancePlus: false
provisionedBandwidthCopySpeed: string
securityDataUri: string
sourceResourceId: string
sourceUri: string
storageAccountId: string
uploadSizeBytes: 0
dataAccessAuthMode: string
diskAccessId: string
diskSizeGB: 0
encryption:
diskEncryptionSetId: string
type: string
encryptionSettingsCollection:
enabled: false
encryptionSettings:
- diskEncryptionKey:
secretUrl: string
sourceVault:
id: string
keyEncryptionKey:
keyUrl: string
sourceVault:
id: string
encryptionSettingsVersion: string
extendedLocation:
name: string
type: string
hyperVGeneration: string
incremental: false
location: string
networkAccessPolicy: string
osType: Windows
publicNetworkAccess: string
purchasePlan:
name: string
product: string
promotionCode: string
publisher: string
resourceGroupName: string
securityProfile:
secureVMDiskEncryptionSetId: string
securityType: string
sku:
name: string
snapshotName: string
supportedCapabilities:
acceleratedNetwork: false
architecture: string
diskControllerTypes: string
supportsHibernation: false
tags:
string: string
Snapshot Resource Properties
To learn more about resource properties and how to use them, see Inputs and Outputs in the Architecture and Concepts docs.
In Python, inputs that are objects can be passed either as argument classes or as dictionary literals.
The Snapshot resource accepts the following input properties:
- CreationData
Pulumi.AzureNative.Compute.Inputs.CreationData
- Disk source information. CreationData information cannot be changed after the disk has been created.
- ResourceGroupName
string
- The name of the resource group. The name is case insensitive.
- CompletionPercent
double
- Percentage complete for the background copy when a resource is created via the CopyStart operation.
- CopyCompletionError
Pulumi.AzureNative.Compute.Inputs.CopyCompletionError
- Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
- DataAccessAuthMode
string | Pulumi.AzureNative.Compute.DataAccessAuthMode
- Additional authentication requirements when exporting or uploading to a disk or snapshot.
- DiskAccessId
string
- ARM id of the DiskAccess resource for using private endpoints on disks.
- DiskSizeGB
int
- If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.
- Encryption
Pulumi.AzureNative.Compute.Inputs.Encryption
- Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
- EncryptionSettingsCollection
Pulumi.AzureNative.Compute.Inputs.EncryptionSettingsCollection
- Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
- ExtendedLocation
Pulumi.AzureNative.Compute.Inputs.ExtendedLocation
- The extended location where the snapshot will be created. Extended location cannot be changed.
- HyperVGeneration
string | Pulumi.AzureNative.Compute.HyperVGeneration
- The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
- Incremental
bool
- Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.
- Location
string
- The geo-location where the resource lives
- NetworkAccessPolicy
string | Pulumi.AzureNative.Compute.NetworkAccessPolicy
- Policy for accessing the disk via network.
- OsType
Pulumi.AzureNative.Compute.OperatingSystemTypes
- The Operating System type.
- PublicNetworkAccess
string | Pulumi.AzureNative.Compute.PublicNetworkAccess
- Policy for controlling export on the disk.
- PurchasePlan
Pulumi.AzureNative.Compute.Inputs.DiskPurchasePlan
- Purchase plan information for the image from which the source disk for the snapshot was originally created.
- SecurityProfile
Pulumi.AzureNative.Compute.Inputs.DiskSecurityProfile
- Contains the security related information for the resource.
- Sku
Pulumi.AzureNative.Compute.Inputs.SnapshotSku
- The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot
- SnapshotName
string
- The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The max name length is 80 characters.
- SupportedCapabilities
Pulumi.AzureNative.Compute.Inputs.SupportedCapabilities
- List of supported capabilities for the image from which the source disk from the snapshot was originally created.
- SupportsHibernation
bool
- Indicates the OS on a snapshot supports hibernation.
- Tags
Dictionary<string, string>
- Resource tags.
- creation_data
object
- Disk source information. CreationData information cannot be changed after the disk has been created.
- resource_group_name
string
- The name of the resource group. The name is case insensitive.
- completion_percent
number
- Percentage complete for the background copy when a resource is created via the CopyStart operation.
- copy_completion_error
object
- Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
- data_access_auth_mode
string | "AzureActiveDirectory" | "None"
- Additional authentication requirements when exporting or uploading to a disk or snapshot.
- disk_access_id
string
- ARM id of the DiskAccess resource for using private endpoints on disks.
- disk_size_gb
number
- If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.
- encryption
object
- Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
- encryption_settings_collection
object
- Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
- extended_location
object
- The extended location where the snapshot will be created. Extended location cannot be changed.
- hyper_v_generation
string | "V1" | "V2"
- The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
- incremental
bool
- Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.
- location
string
- The geo-location where the resource lives
- network_access_policy
string | "AllowAll" | "AllowPrivate" | "DenyAll"
- Policy for accessing the disk via network.
- os_type
"Windows" | "Linux"
- The Operating System type.
- public_network_access
string | "Enabled" | "Disabled"
- Policy for controlling export on the disk.
- purchase_plan
object
- Purchase plan information for the image from which the source disk for the snapshot was originally created.
- security_profile
object
- Contains the security related information for the resource.
- sku
object
- The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot
- snapshot_name
string
- The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The max name length is 80 characters.
- supported_capabilities
object
- List of supported capabilities for the image from which the source disk from the snapshot was originally created.
- supports_hibernation
bool
- Indicates the OS on a snapshot supports hibernation.
- tags
map(string)
- Resource tags.
- creationData
CreationData
- Disk source information. CreationData information cannot be changed after the disk has been created.
- resourceGroupName
String
- The name of the resource group. The name is case insensitive.
- completionPercent
Double
- Percentage complete for the background copy when a resource is created via the CopyStart operation.
- copyCompletionError
CopyCompletionError
- Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
- dataAccessAuthMode
String | DataAccessAuthMode
- Additional authentication requirements when exporting or uploading to a disk or snapshot.
- diskAccessId
String
- ARM id of the DiskAccess resource for using private endpoints on disks.
- diskSizeGB
Integer
- If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.
- encryption
Encryption
- Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
- encryptionSettingsCollection
EncryptionSettingsCollection
- Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
- extendedLocation
ExtendedLocation
- The extended location where the snapshot will be created. Extended location cannot be changed.
- hyperVGeneration
String | HyperVGeneration
- The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
- incremental
Boolean
- Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.
- location
String
- The geo-location where the resource lives
- networkAccessPolicy
String | NetworkAccessPolicy
- Policy for accessing the disk via network.
- osType
OperatingSystemTypes
- The Operating System type.
- publicNetworkAccess
String | PublicNetworkAccess
- Policy for controlling export on the disk.
- purchasePlan
DiskPurchasePlan
- Purchase plan information for the image from which the source disk for the snapshot was originally created.
- securityProfile
DiskSecurityProfile
- Contains the security related information for the resource.
- sku
SnapshotSku
- The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot
- snapshotName
String
- The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The max name length is 80 characters.
- supportedCapabilities
SupportedCapabilities
- List of supported capabilities for the image from which the source disk from the snapshot was originally created.
- supportsHibernation
Boolean
- Indicates the OS on a snapshot supports hibernation.
- tags
Map<String,String>
- Resource tags.
- creationData
CreationData
- Disk source information. CreationData information cannot be changed after the disk has been created.
- resourceGroupName
string
- The name of the resource group. The name is case insensitive.
- completionPercent
number
- Percentage complete for the background copy when a resource is created via the CopyStart operation.
- copyCompletionError
CopyCompletionError
- Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
- dataAccessAuthMode
string | DataAccessAuthMode
- Additional authentication requirements when exporting or uploading to a disk or snapshot.
- diskAccessId
string
- ARM id of the DiskAccess resource for using private endpoints on disks.
- diskSizeGB
number
- If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.
- encryption
Encryption
- Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
- encryptionSettingsCollection
EncryptionSettingsCollection
- Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
- extendedLocation
ExtendedLocation
- The extended location where the snapshot will be created. Extended location cannot be changed.
- hyperVGeneration
string | HyperVGeneration
- The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
- incremental
boolean
- Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.
- location
string
- The geo-location where the resource lives
- networkAccessPolicy
string | NetworkAccessPolicy
- Policy for accessing the disk via network.
- osType
OperatingSystemTypes
- The Operating System type.
- publicNetworkAccess
string | PublicNetworkAccess
- Policy for controlling export on the disk.
- purchasePlan
DiskPurchasePlan
- Purchase plan information for the image from which the source disk for the snapshot was originally created.
- securityProfile
DiskSecurityProfile
- Contains the security related information for the resource.
- sku
SnapshotSku
- The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot
- snapshotName
string
- The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The max name length is 80 characters.
- supportedCapabilities
SupportedCapabilities
- List of supported capabilities for the image from which the source disk from the snapshot was originally created.
- supportsHibernation
boolean
- Indicates the OS on a snapshot supports hibernation.
- tags
{[key: string]: string}
- Resource tags.
- creation_data
CreationDataArgs
- Disk source information. CreationData information cannot be changed after the disk has been created.
- resource_group_name
str
- The name of the resource group. The name is case insensitive.
- completion_percent
float
- Percentage complete for the background copy when a resource is created via the CopyStart operation.
- copy_completion_error
CopyCompletionErrorArgs
- Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
- data_access_auth_mode
str | DataAccessAuthMode
- Additional authentication requirements when exporting or uploading to a disk or snapshot.
- disk_access_id
str
- ARM id of the DiskAccess resource for using private endpoints on disks.
- disk_size_gb
int
- If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.
- encryption
EncryptionArgs
- Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
- encryption_settings_collection
EncryptionSettingsCollectionArgs
- Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
- extended_location
ExtendedLocationArgs
- The extended location where the snapshot will be created. Extended location cannot be changed.
- hyper_v_generation
str | HyperVGeneration
- The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
- incremental
bool
- Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.
- location
str
- The geo-location where the resource lives
- network_access_policy
str | NetworkAccessPolicy
- Policy for accessing the disk via network.
- os_type
OperatingSystemTypes
- The Operating System type.
- public_network_access
str | PublicNetworkAccess
- Policy for controlling export on the disk.
- purchase_plan
DiskPurchasePlanArgs
- Purchase plan information for the image from which the source disk for the snapshot was originally created.
- security_profile
DiskSecurityProfileArgs
- Contains the security related information for the resource.
- sku
SnapshotSkuArgs
- The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot
- snapshot_name
str
- The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The max name length is 80 characters.
- supported_capabilities
SupportedCapabilitiesArgs
- List of supported capabilities for the image from which the source disk from the snapshot was originally created.
- supports_hibernation
bool
- Indicates the OS on a snapshot supports hibernation.
- tags
Mapping[str, str]
- Resource tags.
- creationData
Property Map
- Disk source information. CreationData information cannot be changed after the disk has been created.
- resourceGroupName
String
- The name of the resource group. The name is case insensitive.
- completionPercent
Number
- Percentage complete for the background copy when a resource is created via the CopyStart operation.
- copyCompletionError
Property Map
- Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
- dataAccessAuthMode
String | "AzureActiveDirectory" | "None"
- Additional authentication requirements when exporting or uploading to a disk or snapshot.
- diskAccessId
String
- ARM id of the DiskAccess resource for using private endpoints on disks.
- diskSizeGB
Number
- If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size.
- encryption
Property Map
- Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys.
- encryptionSettingsCollection
Property Map
- Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot.
- extendedLocation
Property Map
- The extended location where the snapshot will be created. Extended location cannot be changed.
- hyperVGeneration
String | "V1" | "V2"
- The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
- incremental
Boolean
- Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed.
- location
String
- The geo-location where the resource lives
- networkAccessPolicy
String | "AllowAll" | "AllowPrivate" | "DenyAll"
- Policy for accessing the disk via network.
- osType
"Windows" | "Linux"
- The Operating System type.
- publicNetworkAccess
String | "Enabled" | "Disabled"
- Policy for controlling export on the disk.
- purchasePlan
Property Map
- Purchase plan information for the image from which the source disk for the snapshot was originally created.
- securityProfile
Property Map
- Contains the security related information for the resource.
- sku
Property Map
- The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot
- snapshotName
String
- The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9, _ and -. The max name length is 80 characters.
- supportedCapabilities
Property Map
- List of supported capabilities for the image from which the source disk from the snapshot was originally created.
- supportsHibernation
Boolean
- Indicates the OS on a snapshot supports hibernation.
- tags
Map<String>
- Resource tags.
Outputs
All input properties are implicitly available as output properties. Additionally, the Snapshot resource produces the following output properties:
- AzureApiVersion
string
- The Azure API version of the resource.
- DiskSizeBytes
double
- The size of the disk in bytes. This field is read only.
- DiskState
string
- The state of the snapshot.
- Id
string
- The provider-assigned unique ID for this managed resource.
- IncrementalSnapshotFamilyId
string
- Incremental snapshots for a disk share an incremental snapshot family id. The Get Page Range Diff API can only be called on incremental snapshots with the same family id.
- ManagedBy
string
- Unused. Always Null.
- Name
string
- The name of the resource
- ProvisioningState
string
- The disk provisioning state.
- SystemData
Pulumi.AzureNative.Compute.Outputs.SystemDataResponse
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- TimeCreated
string
- The time when the snapshot was created.
- Type
string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- UniqueId
string
- Unique Guid identifying the resource.
- AzureApiVersion
string
- The Azure API version of the resource.
- DiskSizeBytes
float64
- The size of the disk in bytes. This field is read only.
- DiskState
string
- The state of the snapshot.
- Id
string
- The provider-assigned unique ID for this managed resource.
- IncrementalSnapshotFamilyId
string
- Incremental snapshots for a disk share an incremental snapshot family id. The Get Page Range Diff API can only be called on incremental snapshots with the same family id.
- ManagedBy
string
- Unused. Always Null.
- Name
string
- The name of the resource
- ProvisioningState
string
- The disk provisioning state.
- SystemData
SystemDataResponse
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- TimeCreated
string
- The time when the snapshot was created.
- Type
string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- UniqueId
string
- Unique Guid identifying the resource.
- azure_api_version
string
- The Azure API version of the resource.
- disk_size_bytes
number
- The size of the disk in bytes. This field is read only.
- disk_state
string
- The state of the snapshot.
- id
string
- The provider-assigned unique ID for this managed resource.
- incremental_snapshot_family_id
string
- Incremental snapshots for a disk share an incremental snapshot family id. The Get Page Range Diff API can only be called on incremental snapshots with the same family id.
- managed_by
string
- Unused. Always Null.
- name
string
- The name of the resource
- provisioning_state
string
- The disk provisioning state.
- system_data
object
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- time_created
string
- The time when the snapshot was created.
- type
string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- unique_id
string
- Unique Guid identifying the resource.
- azureApiVersion
String
- The Azure API version of the resource.
- diskSizeBytes
Double
- The size of the disk in bytes. This field is read only.
- diskState
String
- The state of the snapshot.
- id
String
- The provider-assigned unique ID for this managed resource.
- incrementalSnapshotFamilyId
String
- Incremental snapshots for a disk share an incremental snapshot family id. The Get Page Range Diff API can only be called on incremental snapshots with the same family id.
- managedBy
String
- Unused. Always Null.
- name
String
- The name of the resource
- provisioningState
String
- The disk provisioning state.
- systemData
SystemDataResponse
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- timeCreated
String
- The time when the snapshot was created.
- type
String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- uniqueId
String
- Unique Guid identifying the resource.
- azureApiVersion
string
- The Azure API version of the resource.
- diskSizeBytes
number
- The size of the disk in bytes. This field is read only.
- diskState
string
- The state of the snapshot.
- id
string
- The provider-assigned unique ID for this managed resource.
- incrementalSnapshotFamilyId
string
- Incremental snapshots for a disk share an incremental snapshot family id. The Get Page Range Diff API can only be called on incremental snapshots with the same family id.
- managedBy
string
- Unused. Always Null.
- name
string
- The name of the resource
- provisioningState
string
- The disk provisioning state.
- systemData
SystemDataResponse
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- timeCreated
string
- The time when the snapshot was created.
- type
string
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- uniqueId
string
- Unique Guid identifying the resource.
- azure_api_version
str
- The Azure API version of the resource.
- disk_size_bytes
float
- The size of the disk in bytes. This field is read only.
- disk_state
str
- The state of the snapshot.
- id
str
- The provider-assigned unique ID for this managed resource.
- incremental_snapshot_family_id
str
- Incremental snapshots for a disk share an incremental snapshot family id. The Get Page Range Diff API can only be called on incremental snapshots with the same family id.
- managed_by
str
- Unused. Always Null.
- name
str
- The name of the resource
- provisioning_state
str
- The disk provisioning state.
- system_data
SystemDataResponse
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- time_created
str
- The time when the snapshot was created.
- type
str
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- unique_id
str
- Unique Guid identifying the resource.
- azureApiVersion
String
- The Azure API version of the resource.
- diskSizeBytes
Number
- The size of the disk in bytes. This field is read only.
- diskState
String
- The state of the snapshot.
- id
String
- The provider-assigned unique ID for this managed resource.
- incrementalSnapshotFamilyId
String
- Incremental snapshots for a disk share an incremental snapshot family id. The Get Page Range Diff API can only be called on incremental snapshots with the same family id.
- managedBy
String
- Unused. Always Null.
- name
String
- The name of the resource
- provisioningState
String
- The disk provisioning state.
- systemData
Property Map
- Azure Resource Manager metadata containing createdBy and modifiedBy information.
- timeCreated
String
- The time when the snapshot was created.
- type
String
- The type of the resource. E.g. "Microsoft.Compute/virtualMachines" or "Microsoft.Storage/storageAccounts"
- uniqueId
String
- Unique Guid identifying the resource.
Look up Existing Snapshot Resource
Get an existing Snapshot resource’s state with the given name, ID, and optional extra properties used to qualify the lookup.
public static Snapshot get(String name, Output<String> id, CustomResourceOptions options)
resources: existingSnapshot: type: azure-native:compute:Snapshot get: id: ${id}
import {
to = azure-native_compute_snapshot.example
id = "${id}"
}
- name
string
- The unique name of the resulting resource.
- id
Input<ID>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- resource_name
str
- The unique name of the resulting resource.
- id
str
- The unique provider ID of the resource to look up.
- opts
ResourceOptions
- Bag of options to control resource's behavior.
- ctx
Context
- Context object for the current deployment.
- name
string
- The unique name of the resulting resource.
- id
IDInput
- The unique provider ID of the resource to look up.
- state
SnapshotState
- Pass nil. This resource has no state arguments.
- opts
ResourceOption
- Bag of options to control resource's behavior.
- name
string
- The unique name of the resulting resource.
- id
Input<string>
- The unique provider ID of the resource to look up.
- opts
CustomResourceOptions
- Bag of options to control resource's behavior.
- name
String
- The unique name of the resulting resource.
- id
Output<String>
- The unique provider ID of the resource to look up.
- options
CustomResourceOptions
- Bag of options to control resource's behavior.
Supporting Types
Architecture
CPU architecture supported by an OS disk.
| Name | Value |
|---|
| X64 | x64 |
| Arm64 | Arm64 |
| Name | Value |
|---|
| ArchitectureX64 | x64 |
| ArchitectureArm64 | Arm64 |
| Name | Value |
|---|
| X64 | x64 |
| Arm64 | Arm64 |
| Name | Value |
|---|
| X64 | x64 |
| Arm64 | Arm64 |
| Name | Value |
|---|
| X64 | x64 |
| ARM64 | Arm64 |
CopyCompletionError, CopyCompletionErrorArgs
Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
- ErrorCode
string | CopyCompletionErrorReason
- Indicates the error code if the background copy of a resource created via the CopyStart operation fails.
- ErrorMessage
string
- Indicates the error message if the background copy of a resource created via the CopyStart operation fails.
- error_code
string | "CopySourceNotFound"
- Indicates the error code if the background copy of a resource created via the CopyStart operation fails.
- error_message
string
- Indicates the error message if the background copy of a resource created via the CopyStart operation fails.
- errorCode
String | CopyCompletionErrorReason
- Indicates the error code if the background copy of a resource created via the CopyStart operation fails.
- errorMessage
String
- Indicates the error message if the background copy of a resource created via the CopyStart operation fails.
- errorCode
string | CopyCompletionErrorReason
- Indicates the error code if the background copy of a resource created via the CopyStart operation fails.
- errorMessage
string
- Indicates the error message if the background copy of a resource created via the CopyStart operation fails.
- error_code
str | CopyCompletionErrorReason
- Indicates the error code if the background copy of a resource created via the CopyStart operation fails.
- error_message
str
- Indicates the error message if the background copy of a resource created via the CopyStart operation fails.
- errorCode
String | "CopySourceNotFound"
- Indicates the error code if the background copy of a resource created via the CopyStart operation fails.
- errorMessage
String
- Indicates the error message if the background copy of a resource created via the CopyStart operation fails.
CopyCompletionErrorReason
Indicates the error code if the background copy of a resource created via the CopyStart operation fails.
| Name | Value | Description |
|---|
| CopySourceNotFound | CopySourceNotFound | Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress. |
| Name | Value | Description |
|---|
| CopyCompletionErrorReasonCopySourceNotFound | CopySourceNotFound | Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress. |
| Value | Description |
|---|
CopySourceNotFound | Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress. |
| Name | Value | Description |
|---|
| CopySourceNotFound | CopySourceNotFound | Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress. |
| Name | Value | Description |
|---|
| CopySourceNotFound | CopySourceNotFound | Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress. |
| Name | Value | Description |
|---|
| COPY_SOURCE_NOT_FOUND | CopySourceNotFound | Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress. |
| Value | Description |
|---|
CopySourceNotFound | Indicates that the source snapshot was deleted while the background copy of the resource created via CopyStart operation was in progress. |
CopyCompletionErrorResponse
Indicates the error details if the background copy of a resource created via the CopyStart operation fails.
- ErrorCode
string
- Indicates the error code if the background copy of a resource created via the CopyStart operation fails.
- ErrorMessage
string
- Indicates the error message if the background copy of a resource created via the CopyStart operation fails.
- ErrorCode
string
- Indicates the error code if the background copy of a resource created via the CopyStart operation fails.
- ErrorMessage
string
- Indicates the error message if the background copy of a resource created via the CopyStart operation fails.
- error_code
string
- Indicates the error code if the background copy of a resource created via the CopyStart operation fails.
- error_message
string
- Indicates the error message if the background copy of a resource created via the CopyStart operation fails.
- errorCode
String
- Indicates the error code if the background copy of a resource created via the CopyStart operation fails.
- errorMessage
String
- Indicates the error message if the background copy of a resource created via the CopyStart operation fails.
- errorCode
string
- Indicates the error code if the background copy of a resource created via the CopyStart operation fails.
- errorMessage
string
- Indicates the error message if the background copy of a resource created via the CopyStart operation fails.
- error_code
str
- Indicates the error code if the background copy of a resource created via the CopyStart operation fails.
- error_message
str
- Indicates the error message if the background copy of a resource created via the CopyStart operation fails.
- errorCode
String
- Indicates the error code if the background copy of a resource created via the CopyStart operation fails.
- errorMessage
String
- Indicates the error message if the background copy of a resource created via the CopyStart operation fails.
CreationData, CreationDataArgs
Data used when creating a disk.
- CreateOption
string | DiskCreateOption
- This enumerates the possible sources of a disk's creation.
- ElasticSanResourceId
string
- Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot.
- GalleryImageReference
ImageDiskReference
- Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk.
- ImageReference
ImageDiskReference
- Disk source information for PIR or user images.
- LogicalSectorSize
int
- Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.
- PerformancePlus
bool
- Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled.
- ProvisionedBandwidthCopySpeed
string | ProvisionedBandwidthCopyOption
- If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.
- SecurityDataUri
string
- If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.
- SourceResourceId
string
- If createOption is Copy, this is the ARM id of the source snapshot or disk.
- SourceUri
string
- If createOption is Import, this is the URI of a blob to be imported into a managed disk.
- StorageAccountId
string
- Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.
- UploadSizeBytes
float64
- If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer).
- createOption
String | DiskCreateOption
- This enumerates the possible sources of a disk's creation.
- elasticSanResourceId
String
- Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot.
- galleryImageReference
ImageDiskReference
- Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk.
- imageReference
ImageDiskReference
- Disk source information for PIR or user images.
- logicalSectorSize
Integer
- Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.
- performancePlus
Boolean
- Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled.
- provisionedBandwidthCopySpeed
String | ProvisionedBandwidthCopyOption
- If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.
- securityDataUri
String
- If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.
- sourceResourceId
String
- If createOption is Copy, this is the ARM id of the source snapshot or disk.
- sourceUri
String
- If createOption is Import, this is the URI of a blob to be imported into a managed disk.
- storageAccountId
String
- Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.
- uploadSizeBytes
Double
- If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer).
- createOption
string | DiskCreateOption
- This enumerates the possible sources of a disk's creation.
- elasticSanResourceId
string
- Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot.
- galleryImageReference
ImageDiskReference
- Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk.
- imageReference
ImageDiskReference
- Disk source information for PIR or user images.
- logicalSectorSize
number
- Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.
- performancePlus
boolean
- Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled.
- provisionedBandwidthCopySpeed
string | ProvisionedBandwidthCopyOption
- If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.
- securityDataUri
string
- If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.
- sourceResourceId
string
- If createOption is Copy, this is the ARM id of the source snapshot or disk.
- sourceUri
string
- If createOption is Import, this is the URI of a blob to be imported into a managed disk.
- storageAccountId
string
- Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.
- uploadSizeBytes
number
- If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer).
- create_option
str | DiskCreateOption
- This enumerates the possible sources of a disk's creation.
- elastic_san_resource_id
str
- Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot.
- gallery_image_reference
ImageDiskReference
- Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk.
- image_reference
ImageDiskReference
- Disk source information for PIR or user images.
- logical_sector_size
int
- Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.
- performance_plus
bool
- Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled.
- provisioned_bandwidth_copy_speed
str | ProvisionedBandwidthCopyOption
- If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.
- security_data_uri
str
- If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.
- source_resource_id
str
- If createOption is Copy, this is the ARM id of the source snapshot or disk.
- source_uri
str
- If createOption is Import, this is the URI of a blob to be imported into a managed disk.
- storage_account_id
str
- Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.
- upload_size_bytes
float
- If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer).
CreationDataResponse
Data used when creating a disk.
- CreateOption
string
- This enumerates the possible sources of a disk's creation.
- SourceUniqueId
string
- If this field is set, this is the unique id identifying the source of this resource.
- ElasticSanResourceId
string
- Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot.
- GalleryImageReference
Pulumi.AzureNative.Compute.Inputs.ImageDiskReferenceResponse
- Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk.
- ImageReference
Pulumi.AzureNative.Compute.Inputs.ImageDiskReferenceResponse
- Disk source information for PIR or user images.
- LogicalSectorSize
int
- Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.
- PerformancePlus
bool
- Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled.
- ProvisionedBandwidthCopySpeed
string
- If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.
- SecurityDataUri
string
- If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.
- SourceResourceId
string
- If createOption is Copy, this is the ARM id of the source snapshot or disk.
- SourceUri
string
- If createOption is Import, this is the URI of a blob to be imported into a managed disk.
- StorageAccountId
string
- Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.
- UploadSizeBytes
double
- If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer).
- CreateOption
string
- This enumerates the possible sources of a disk's creation.
- SourceUniqueId
string
- If this field is set, this is the unique id identifying the source of this resource.
- ElasticSanResourceId
string
- Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot.
- GalleryImageReference
ImageDiskReferenceResponse
- Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk.
- ImageReference
ImageDiskReferenceResponse
- Disk source information for PIR or user images.
- LogicalSectorSize
int
- Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.
- PerformancePlus
bool
- Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled.
- ProvisionedBandwidthCopySpeed
string
- If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.
- SecurityDataUri
string
- If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.
- SourceResourceId
string
- If createOption is Copy, this is the ARM id of the source snapshot or disk.
- SourceUri
string
- If createOption is Import, this is the URI of a blob to be imported into a managed disk.
- StorageAccountId
string
- Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.
- UploadSizeBytes
float64
- If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer).
- create_option
string
- This enumerates the possible sources of a disk's creation.
- source_unique_id
string
- If this field is set, this is the unique id identifying the source of this resource.
- elastic_san_resource_id
string
- Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot.
- gallery_image_reference
object
- Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk.
- image_reference
object
- Disk source information for PIR or user images.
- logical_sector_size
number
- Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.
- performance_plus
bool
- Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled.
- provisioned_bandwidth_copy_speed
string
- If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.
- security_data_uri
string
- If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.
- source_resource_id
string
- If createOption is Copy, this is the ARM id of the source snapshot or disk.
- source_uri
string
- If createOption is Import, this is the URI of a blob to be imported into a managed disk.
- storage_account_id
string
- Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.
- upload_size_bytes
number
- If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer).
- createOption
String
- This enumerates the possible sources of a disk's creation.
- sourceUniqueId
String
- If this field is set, this is the unique id identifying the source of this resource.
- elasticSanResourceId
String
- Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot.
- galleryImageReference
ImageDiskReferenceResponse
- Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk.
- imageReference
ImageDiskReferenceResponse
- Disk source information for PIR or user images.
- logicalSectorSize
Integer
- Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.
- performancePlus
Boolean
- Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled.
- provisionedBandwidthCopySpeed
String
- If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.
- securityDataUri
String
- If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.
- sourceResourceId
String
- If createOption is Copy, this is the ARM id of the source snapshot or disk.
- sourceUri
String
- If createOption is Import, this is the URI of a blob to be imported into a managed disk.
- storageAccountId
String
- Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.
- uploadSizeBytes
Double
- If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer).
- createOption
string
- This enumerates the possible sources of a disk's creation.
- sourceUniqueId
string
- If this field is set, this is the unique id identifying the source of this resource.
- elasticSanResourceId
string
- Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot.
- galleryImageReference
ImageDiskReferenceResponse
- Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk.
- imageReference
ImageDiskReferenceResponse
- Disk source information for PIR or user images.
- logicalSectorSize
number
- Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.
- performancePlus
boolean
- Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled.
- provisionedBandwidthCopySpeed
string
- If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.
- securityDataUri
string
- If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.
- sourceResourceId
string
- If createOption is Copy, this is the ARM id of the source snapshot or disk.
- sourceUri
string
- If createOption is Import, this is the URI of a blob to be imported into a managed disk.
- storageAccountId
string
- Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.
- uploadSizeBytes
number
- If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer).
- create_option
str
- This enumerates the possible sources of a disk's creation.
- source_unique_id
str
- If this field is set, this is the unique id identifying the source of this resource.
- elastic_san_resource_id
str
- Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot.
- gallery_image_reference
ImageDiskReferenceResponse
- Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk.
- image_reference
ImageDiskReferenceResponse
- Disk source information for PIR or user images.
- logical_sector_size
int
- Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.
- performance_plus
bool
- Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled.
- provisioned_bandwidth_copy_speed
str
- If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.
- security_data_uri
str
- If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.
- source_resource_id
str
- If createOption is Copy, this is the ARM id of the source snapshot or disk.
- source_uri
str
- If createOption is Import, this is the URI of a blob to be imported into a managed disk.
- storage_account_id
str
- Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.
- upload_size_bytes
float
- If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer).
- createOption
String
- This enumerates the possible sources of a disk's creation.
- sourceUniqueId
String
- If this field is set, this is the unique id identifying the source of this resource.
- elasticSanResourceId
String
- Required if createOption is CopyFromSanSnapshot. This is the ARM id of the source elastic san volume snapshot.
- galleryImageReference
Property Map
- Required if creating from a Gallery Image. The id/sharedGalleryImageId/communityGalleryImageId of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk.
- imageReference
Property Map
- Disk source information for PIR or user images.
- logicalSectorSize
Number
- Logical sector size in bytes for Ultra disks. Supported values are 512 ad 4096. 4096 is the default.
- performancePlus
Boolean
- Set this flag to true to get a boost on the performance target of the disk deployed, see here on the respective performance target. This flag can only be set on disk creation time and cannot be disabled after enabled.
- provisionedBandwidthCopySpeed
String
- If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.
- securityDataUri
String
- If createOption is ImportSecure, this is the URI of a blob to be imported into VM guest state.
- sourceResourceId
String
- If createOption is Copy, this is the ARM id of the source snapshot or disk.
- sourceUri
String
- If createOption is Import, this is the URI of a blob to be imported into a managed disk.
- storageAccountId
String
- Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk.
- uploadSizeBytes
Number
- If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer).
DataAccessAuthMode
Additional authentication requirements when exporting or uploading to a disk or snapshot.
| Name | Value | Description |
|---|
| AzureActiveDirectory | AzureActiveDirectory | When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. |
| None | None | No additional authentication would be performed when accessing export/upload URL. |
| Name | Value | Description |
|---|
| DataAccessAuthModeAzureActiveDirectory | AzureActiveDirectory | When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. |
| DataAccessAuthModeNone | None | No additional authentication would be performed when accessing export/upload URL. |
| Value | Description |
|---|
AzureActiveDirectory | When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. |
None | No additional authentication would be performed when accessing export/upload URL. |
| Name | Value | Description |
|---|
| AzureActiveDirectory | AzureActiveDirectory | When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. |
| None | None | No additional authentication would be performed when accessing export/upload URL. |
| Name | Value | Description |
|---|
| AzureActiveDirectory | AzureActiveDirectory | When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. |
| None | None | No additional authentication would be performed when accessing export/upload URL. |
| Name | Value | Description |
|---|
| AZURE_ACTIVE_DIRECTORY | AzureActiveDirectory | When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. |
| NONE | None | No additional authentication would be performed when accessing export/upload URL. |
| Value | Description |
|---|
AzureActiveDirectory | When export/upload URL is used, the system checks if the user has an identity in Azure Active Directory and has necessary permissions to export/upload the data. Please refer to aka.ms/DisksAzureADAuth. |
None | No additional authentication would be performed when accessing export/upload URL. |
DiskCreateOption
This enumerates the possible sources of a disk's creation.
| Name | Value | Description |
|---|
| Empty | Empty | Create an empty data disk of a size given by diskSizeGB. |
| Attach | Attach | Disk will be attached to a VM. |
| FromImage | FromImage | Create a new disk from a platform image specified by the given imageReference or galleryImageReference. |
| Import | Import | Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. |
| Copy | Copy | Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. |
| Restore | Restore | Create a new disk by copying from a backup recovery point. |
| Upload | Upload | Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. |
| CopyStart | CopyStart | Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. |
| ImportSecure | ImportSecure | Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. |
| UploadPreparedSecure | UploadPreparedSecure | Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. |
| CopyFromSanSnapshot | CopyFromSanSnapshot | Create a new disk by exporting from elastic san volume snapshot |
| Name | Value | Description |
|---|
| DiskCreateOptionEmpty | Empty | Create an empty data disk of a size given by diskSizeGB. |
| DiskCreateOptionAttach | Attach | Disk will be attached to a VM. |
| DiskCreateOptionFromImage | FromImage | Create a new disk from a platform image specified by the given imageReference or galleryImageReference. |
| DiskCreateOptionImport | Import | Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. |
| DiskCreateOptionCopy | Copy | Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. |
| DiskCreateOptionRestore | Restore | Create a new disk by copying from a backup recovery point. |
| DiskCreateOptionUpload | Upload | Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. |
| DiskCreateOptionCopyStart | CopyStart | Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. |
| DiskCreateOptionImportSecure | ImportSecure | Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. |
| DiskCreateOptionUploadPreparedSecure | UploadPreparedSecure | Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. |
| DiskCreateOptionCopyFromSanSnapshot | CopyFromSanSnapshot | Create a new disk by exporting from elastic san volume snapshot |
| Value | Description |
|---|
Empty | Create an empty data disk of a size given by diskSizeGB. |
Attach | Disk will be attached to a VM. |
FromImage | Create a new disk from a platform image specified by the given imageReference or galleryImageReference. |
Import | Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. |
Copy | Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. |
Restore | Create a new disk by copying from a backup recovery point. |
Upload | Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. |
CopyStart | Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. |
ImportSecure | Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. |
UploadPreparedSecure | Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. |
CopyFromSanSnapshot | Create a new disk by exporting from elastic san volume snapshot |
| Name | Value | Description |
|---|
| Empty | Empty | Create an empty data disk of a size given by diskSizeGB. |
| Attach | Attach | Disk will be attached to a VM. |
| FromImage | FromImage | Create a new disk from a platform image specified by the given imageReference or galleryImageReference. |
| Import | Import | Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. |
| Copy | Copy | Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. |
| Restore | Restore | Create a new disk by copying from a backup recovery point. |
| Upload | Upload | Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. |
| CopyStart | CopyStart | Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. |
| ImportSecure | ImportSecure | Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. |
| UploadPreparedSecure | UploadPreparedSecure | Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. |
| CopyFromSanSnapshot | CopyFromSanSnapshot | Create a new disk by exporting from elastic san volume snapshot |
| Name | Value | Description |
|---|
| Empty | Empty | Create an empty data disk of a size given by diskSizeGB. |
| Attach | Attach | Disk will be attached to a VM. |
| FromImage | FromImage | Create a new disk from a platform image specified by the given imageReference or galleryImageReference. |
| Import | Import | Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. |
| Copy | Copy | Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. |
| Restore | Restore | Create a new disk by copying from a backup recovery point. |
| Upload | Upload | Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. |
| CopyStart | CopyStart | Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. |
| ImportSecure | ImportSecure | Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. |
| UploadPreparedSecure | UploadPreparedSecure | Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. |
| CopyFromSanSnapshot | CopyFromSanSnapshot | Create a new disk by exporting from elastic san volume snapshot |
| Name | Value | Description |
|---|
| EMPTY | Empty | Create an empty data disk of a size given by diskSizeGB. |
| ATTACH | Attach | Disk will be attached to a VM. |
| FROM_IMAGE | FromImage | Create a new disk from a platform image specified by the given imageReference or galleryImageReference. |
| IMPORT_ | Import | Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. |
| COPY | Copy | Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. |
| RESTORE | Restore | Create a new disk by copying from a backup recovery point. |
| UPLOAD | Upload | Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. |
| COPY_START | CopyStart | Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. |
| IMPORT_SECURE | ImportSecure | Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. |
| UPLOAD_PREPARED_SECURE | UploadPreparedSecure | Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. |
| COPY_FROM_SAN_SNAPSHOT | CopyFromSanSnapshot | Create a new disk by exporting from elastic san volume snapshot |
| Value | Description |
|---|
Empty | Create an empty data disk of a size given by diskSizeGB. |
Attach | Disk will be attached to a VM. |
FromImage | Create a new disk from a platform image specified by the given imageReference or galleryImageReference. |
Import | Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId. |
Copy | Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId. |
Restore | Create a new disk by copying from a backup recovery point. |
Upload | Create a new disk by obtaining a write token and using it to directly upload the contents of the disk. |
CopyStart | Create a new disk by using a deep copy process, where the resource creation is considered complete only after all data has been copied from the source. |
ImportSecure | Similar to Import create option. Create a new Trusted Launch VM or Confidential VM supported disk by importing additional blobs for VM guest state specified by securityDataUri and VM metadata specified by securityMetadataUri in storage account specified by storageAccountId. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. |
UploadPreparedSecure | Similar to Upload create option. Create a new Trusted Launch VM or Confidential VM supported disk and upload using write token in disk, VM guest state and VM metadata. The VM metadata is optional and only required for certain Confidential VM configurations and not required for Trusted Launch VM. |
CopyFromSanSnapshot | Create a new disk by exporting from elastic san volume snapshot |
DiskPurchasePlan, DiskPurchasePlanArgs
Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.
- Name
string
- The plan ID.
- Product
string
- Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
- Publisher
string
- The publisher ID.
- PromotionCode
string
- The Offer Promotion Code.
- Name
string
- The plan ID.
- Product
string
- Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
- Publisher
string
- The publisher ID.
- PromotionCode
string
- The Offer Promotion Code.
- name
string
- The plan ID.
- product
string
- Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
- publisher
string
- The publisher ID.
- promotion_code
string
- The Offer Promotion Code.
- name
String
- The plan ID.
- product
String
- Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
- publisher
String
- The publisher ID.
- promotionCode
String
- The Offer Promotion Code.
- name
string
- The plan ID.
- product
string
- Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
- publisher
string
- The publisher ID.
- promotionCode
string
- The Offer Promotion Code.
- name
str
- The plan ID.
- product
str
- Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
- publisher
str
- The publisher ID.
- promotion_code
str
- The Offer Promotion Code.
- name
String
- The plan ID.
- product
String
- Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
- publisher
String
- The publisher ID.
- promotionCode
String
- The Offer Promotion Code.
DiskPurchasePlanResponse
Used for establishing the purchase context of any 3rd Party artifact through MarketPlace.
- Name
string
- The plan ID.
- Product
string
- Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
- Publisher
string
- The publisher ID.
- PromotionCode
string
- The Offer Promotion Code.
- Name
string
- The plan ID.
- Product
string
- Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
- Publisher
string
- The publisher ID.
- PromotionCode
string
- The Offer Promotion Code.
- name
string
- The plan ID.
- product
string
- Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
- publisher
string
- The publisher ID.
- promotion_code
string
- The Offer Promotion Code.
- name
String
- The plan ID.
- product
String
- Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
- publisher
String
- The publisher ID.
- promotionCode
String
- The Offer Promotion Code.
- name
string
- The plan ID.
- product
string
- Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
- publisher
string
- The publisher ID.
- promotionCode
string
- The Offer Promotion Code.
- name
str
- The plan ID.
- product
str
- Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
- publisher
str
- The publisher ID.
- promotion_code
str
- The Offer Promotion Code.
- name
String
- The plan ID.
- product
String
- Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element.
- publisher
String
- The publisher ID.
- promotionCode
String
- The Offer Promotion Code.
DiskSecurityProfile, DiskSecurityProfileArgs
Contains the security related information for the resource.
DiskSecurityProfileResponse
Contains the security related information for the resource.
- SecureVMDiskEncryptionSetId
string
- ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key
- SecurityType
string
- Specifies the SecurityType of the VM. Applicable for OS disks only.
- SecureVMDiskEncryptionSetId
string
- ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key
- SecurityType
string
- Specifies the SecurityType of the VM. Applicable for OS disks only.
- secure_vm_disk_encryption_set_id
string
- ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key
- security_type
string
- Specifies the SecurityType of the VM. Applicable for OS disks only.
- secureVMDiskEncryptionSetId
String
- ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key
- securityType
String
- Specifies the SecurityType of the VM. Applicable for OS disks only.
- secureVMDiskEncryptionSetId
string
- ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key
- securityType
string
- Specifies the SecurityType of the VM. Applicable for OS disks only.
- secure_vm_disk_encryption_set_id
str
- ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key
- security_type
str
- Specifies the SecurityType of the VM. Applicable for OS disks only.
- secureVMDiskEncryptionSetId
String
- ResourceId of the disk encryption set associated to Confidential VM supported disk encrypted with customer managed key
- securityType
String
- Specifies the SecurityType of the VM. Applicable for OS disks only.
DiskSecurityTypes
Specifies the SecurityType of the VM. Applicable for OS disks only.
| Name | Value | Description |
|---|
| TrustedLaunch | TrustedLaunch | Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) |
| ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey | ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey | Indicates Confidential VM disk with only VM guest state encrypted |
| ConfidentialVM_DiskEncryptedWithPlatformKey | ConfidentialVM_DiskEncryptedWithPlatformKey | Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key |
| ConfidentialVM_DiskEncryptedWithCustomerKey | ConfidentialVM_DiskEncryptedWithCustomerKey | Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key |
| ConfidentialVM_NonPersistedTPM | ConfidentialVM_NonPersistedTPM | Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. |
| Name | Value | Description |
|---|
| DiskSecurityTypesTrustedLaunch | TrustedLaunch | Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) |
| DiskSecurityTypes_ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey | ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey | Indicates Confidential VM disk with only VM guest state encrypted |
| DiskSecurityTypes_ConfidentialVM_DiskEncryptedWithPlatformKey | ConfidentialVM_DiskEncryptedWithPlatformKey | Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key |
| DiskSecurityTypes_ConfidentialVM_DiskEncryptedWithCustomerKey | ConfidentialVM_DiskEncryptedWithCustomerKey | Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key |
| DiskSecurityTypes_ConfidentialVM_NonPersistedTPM | ConfidentialVM_NonPersistedTPM | Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. |
| Value | Description |
|---|
TrustedLaunch | Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) |
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey | Indicates Confidential VM disk with only VM guest state encrypted |
ConfidentialVM_DiskEncryptedWithPlatformKey | Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key |
ConfidentialVM_DiskEncryptedWithCustomerKey | Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key |
ConfidentialVM_NonPersistedTPM | Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. |
| Name | Value | Description |
|---|
| TrustedLaunch | TrustedLaunch | Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) |
| ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey | ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey | Indicates Confidential VM disk with only VM guest state encrypted |
| ConfidentialVM_DiskEncryptedWithPlatformKey | ConfidentialVM_DiskEncryptedWithPlatformKey | Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key |
| ConfidentialVM_DiskEncryptedWithCustomerKey | ConfidentialVM_DiskEncryptedWithCustomerKey | Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key |
| ConfidentialVM_NonPersistedTPM | ConfidentialVM_NonPersistedTPM | Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. |
| Name | Value | Description |
|---|
| TrustedLaunch | TrustedLaunch | Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) |
| ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey | ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey | Indicates Confidential VM disk with only VM guest state encrypted |
| ConfidentialVM_DiskEncryptedWithPlatformKey | ConfidentialVM_DiskEncryptedWithPlatformKey | Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key |
| ConfidentialVM_DiskEncryptedWithCustomerKey | ConfidentialVM_DiskEncryptedWithCustomerKey | Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key |
| ConfidentialVM_NonPersistedTPM | ConfidentialVM_NonPersistedTPM | Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. |
| Name | Value | Description |
|---|
| TRUSTED_LAUNCH | TrustedLaunch | Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) |
| CONFIDENTIAL_V_M_VM_GUEST_STATE_ONLY_ENCRYPTED_WITH_PLATFORM_KEY | ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey | Indicates Confidential VM disk with only VM guest state encrypted |
| CONFIDENTIAL_V_M_DISK_ENCRYPTED_WITH_PLATFORM_KEY | ConfidentialVM_DiskEncryptedWithPlatformKey | Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key |
| CONFIDENTIAL_V_M_DISK_ENCRYPTED_WITH_CUSTOMER_KEY | ConfidentialVM_DiskEncryptedWithCustomerKey | Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key |
| CONFIDENTIAL_V_M_NON_PERSISTED_TPM | ConfidentialVM_NonPersistedTPM | Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. |
| Value | Description |
|---|
TrustedLaunch | Trusted Launch provides security features such as secure boot and virtual Trusted Platform Module (vTPM) |
ConfidentialVM_VMGuestStateOnlyEncryptedWithPlatformKey | Indicates Confidential VM disk with only VM guest state encrypted |
ConfidentialVM_DiskEncryptedWithPlatformKey | Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a platform managed key |
ConfidentialVM_DiskEncryptedWithCustomerKey | Indicates Confidential VM disk with both OS disk and VM guest state encrypted with a customer managed key |
ConfidentialVM_NonPersistedTPM | Indicates Confidential VM disk with a ephemeral vTPM. vTPM state is not persisted across VM reboots. |
Encryption, EncryptionArgs
Encryption at rest settings for disk or snapshot
EncryptionResponse
Encryption at rest settings for disk or snapshot
- DiskEncryptionSetId
string
- ResourceId of the disk encryption set to use for enabling encryption at rest.
- Type
string
- The type of key used to encrypt the data of the disk.
- DiskEncryptionSetId
string
- ResourceId of the disk encryption set to use for enabling encryption at rest.
- Type
string
- The type of key used to encrypt the data of the disk.
- disk_encryption_set_id
string
- ResourceId of the disk encryption set to use for enabling encryption at rest.
- type
string
- The type of key used to encrypt the data of the disk.
- diskEncryptionSetId
String
- ResourceId of the disk encryption set to use for enabling encryption at rest.
- type
String
- The type of key used to encrypt the data of the disk.
- diskEncryptionSetId
string
- ResourceId of the disk encryption set to use for enabling encryption at rest.
- type
string
- The type of key used to encrypt the data of the disk.
- disk_encryption_set_id
str
- ResourceId of the disk encryption set to use for enabling encryption at rest.
- type
str
- The type of key used to encrypt the data of the disk.
- diskEncryptionSetId
String
- ResourceId of the disk encryption set to use for enabling encryption at rest.
- type
String
- The type of key used to encrypt the data of the disk.
EncryptionSettingsCollection, EncryptionSettingsCollectionArgs
Encryption settings for disk or snapshot
- Enabled
bool
- Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.
- EncryptionSettings
List<Pulumi.AzureNative.Compute.Inputs.EncryptionSettingsElement>
- A collection of encryption settings, one for each disk volume.
- EncryptionSettingsVersion
string
- Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption.
- Enabled
bool
- Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.
- EncryptionSettings
[]EncryptionSettingsElement
- A collection of encryption settings, one for each disk volume.
- EncryptionSettingsVersion
string
- Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption.
- enabled
bool
- Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.
- encryption_settings
list(object)
- A collection of encryption settings, one for each disk volume.
- encryption_settings_version
string
- Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption.
- enabled
Boolean
- Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.
- encryptionSettings
List<EncryptionSettingsElement>
- A collection of encryption settings, one for each disk volume.
- encryptionSettingsVersion
String
- Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption.
- enabled
boolean
- Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.
- encryptionSettings
EncryptionSettingsElement[]
- A collection of encryption settings, one for each disk volume.
- encryptionSettingsVersion
string
- Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption.
- enabled
bool
- Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.
- encryption_settings
Sequence[EncryptionSettingsElement]
- A collection of encryption settings, one for each disk volume.
- encryption_settings_version
str
- Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption.
- enabled
Boolean
- Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.
- encryptionSettings
List<Property Map>
- A collection of encryption settings, one for each disk volume.
- encryptionSettingsVersion
String
- Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption.
EncryptionSettingsCollectionResponse
Encryption settings for disk or snapshot
- Enabled
bool
- Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.
- EncryptionSettings
List<Pulumi.AzureNative.Compute.Inputs.EncryptionSettingsElementResponse>
- A collection of encryption settings, one for each disk volume.
- EncryptionSettingsVersion
string
- Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption.
- Enabled
bool
- Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.
- EncryptionSettings
[]EncryptionSettingsElementResponse
- A collection of encryption settings, one for each disk volume.
- EncryptionSettingsVersion
string
- Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption.
- enabled
bool
- Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.
- encryption_settings
list(object)
- A collection of encryption settings, one for each disk volume.
- encryption_settings_version
string
- Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption.
- enabled
Boolean
- Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.
- encryptionSettings
List<EncryptionSettingsElementResponse>
- A collection of encryption settings, one for each disk volume.
- encryptionSettingsVersion
String
- Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption.
- enabled
boolean
- Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.
- encryptionSettings
EncryptionSettingsElementResponse[]
- A collection of encryption settings, one for each disk volume.
- encryptionSettingsVersion
string
- Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption.
- enabled
bool
- Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.
- encryption_settings
Sequence[EncryptionSettingsElementResponse]
- A collection of encryption settings, one for each disk volume.
- encryption_settings_version
str
- Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption.
- enabled
Boolean
- Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged.
- encryptionSettings
List<Property Map>
- A collection of encryption settings, one for each disk volume.
- encryptionSettingsVersion
String
- Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption.
EncryptionSettingsElement, EncryptionSettingsElementArgs
Encryption settings for one disk volume.
- disk_encryption_key
object
- Key Vault Secret Url and vault id of the disk encryption key
- key_encryption_key
object
- Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key.
EncryptionSettingsElementResponse
Encryption settings for one disk volume.
- disk_encryption_key
object
- Key Vault Secret Url and vault id of the disk encryption key
- key_encryption_key
object
- Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key.
EncryptionType
The type of key used to encrypt the data of the disk.
| Name | Value | Description |
|---|
| EncryptionAtRestWithPlatformKey | EncryptionAtRestWithPlatformKey | Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. |
| EncryptionAtRestWithCustomerKey | EncryptionAtRestWithCustomerKey | Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. |
| EncryptionAtRestWithPlatformAndCustomerKeys | EncryptionAtRestWithPlatformAndCustomerKeys | Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. |
| Name | Value | Description |
|---|
| EncryptionTypeEncryptionAtRestWithPlatformKey | EncryptionAtRestWithPlatformKey | Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. |
| EncryptionTypeEncryptionAtRestWithCustomerKey | EncryptionAtRestWithCustomerKey | Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. |
| EncryptionTypeEncryptionAtRestWithPlatformAndCustomerKeys | EncryptionAtRestWithPlatformAndCustomerKeys | Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. |
| Value | Description |
|---|
EncryptionAtRestWithPlatformKey | Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. |
EncryptionAtRestWithCustomerKey | Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. |
EncryptionAtRestWithPlatformAndCustomerKeys | Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. |
| Name | Value | Description |
|---|
| EncryptionAtRestWithPlatformKey | EncryptionAtRestWithPlatformKey | Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. |
| EncryptionAtRestWithCustomerKey | EncryptionAtRestWithCustomerKey | Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. |
| EncryptionAtRestWithPlatformAndCustomerKeys | EncryptionAtRestWithPlatformAndCustomerKeys | Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. |
| Name | Value | Description |
|---|
| EncryptionAtRestWithPlatformKey | EncryptionAtRestWithPlatformKey | Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. |
| EncryptionAtRestWithCustomerKey | EncryptionAtRestWithCustomerKey | Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. |
| EncryptionAtRestWithPlatformAndCustomerKeys | EncryptionAtRestWithPlatformAndCustomerKeys | Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. |
| Name | Value | Description |
|---|
| ENCRYPTION_AT_REST_WITH_PLATFORM_KEY | EncryptionAtRestWithPlatformKey | Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. |
| ENCRYPTION_AT_REST_WITH_CUSTOMER_KEY | EncryptionAtRestWithCustomerKey | Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. |
| ENCRYPTION_AT_REST_WITH_PLATFORM_AND_CUSTOMER_KEYS | EncryptionAtRestWithPlatformAndCustomerKeys | Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. |
| Value | Description |
|---|
EncryptionAtRestWithPlatformKey | Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets. |
EncryptionAtRestWithCustomerKey | Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer. |
EncryptionAtRestWithPlatformAndCustomerKeys | Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed. |
ExtendedLocation, ExtendedLocationArgs
The complex type of the extended location.
- name
string
- The name of the extended location.
- type
string | "EdgeZone"
- The type of the extended location.
- name
String
- The name of the extended location.
- type
String | "EdgeZone"
- The type of the extended location.
ExtendedLocationResponse
The complex type of the extended location.
- Name
string
- The name of the extended location.
- Type
string
- The type of the extended location.
- Name
string
- The name of the extended location.
- Type
string
- The type of the extended location.
- name
string
- The name of the extended location.
- type
string
- The type of the extended location.
- name
String
- The name of the extended location.
- type
String
- The type of the extended location.
- name
string
- The name of the extended location.
- type
string
- The type of the extended location.
- name
str
- The name of the extended location.
- type
str
- The type of the extended location.
- name
String
- The name of the extended location.
- type
String
- The type of the extended location.
ExtendedLocationTypes
The type of the extended location.
| Name | Value |
|---|
| EdgeZone | EdgeZone |
| Name | Value |
|---|
| ExtendedLocationTypesEdgeZone | EdgeZone |
| Name | Value |
|---|
| EdgeZone | EdgeZone |
| Name | Value |
|---|
| EdgeZone | EdgeZone |
| Name | Value |
|---|
| EDGE_ZONE | EdgeZone |
HyperVGeneration
The hypervisor generation of the Virtual Machine. Applicable to OS disks only.
| Name | Value |
|---|
| HyperVGenerationV1 | V1 |
| HyperVGenerationV2 | V2 |
ImageDiskReference, ImageDiskReferenceArgs
The source image used for creating the disk.
-
string
- A relative uri containing a community Azure Compute Gallery image reference.
- Id
string
- A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.
- Lun
int
- If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.
- SharedGalleryImageId
string
- A relative uri containing a direct shared Azure Compute Gallery image reference.
-
string
- A relative uri containing a community Azure Compute Gallery image reference.
- Id
string
- A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.
- Lun
int
- If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.
- SharedGalleryImageId
string
- A relative uri containing a direct shared Azure Compute Gallery image reference.
-
string
- A relative uri containing a community Azure Compute Gallery image reference.
- id
string
- A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.
- lun
number
- If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.
- shared_gallery_image_id
string
- A relative uri containing a direct shared Azure Compute Gallery image reference.
-
String
- A relative uri containing a community Azure Compute Gallery image reference.
- id
String
- A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.
- lun
Integer
- If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.
- sharedGalleryImageId
String
- A relative uri containing a direct shared Azure Compute Gallery image reference.
-
string
- A relative uri containing a community Azure Compute Gallery image reference.
- id
string
- A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.
- lun
number
- If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.
- sharedGalleryImageId
string
- A relative uri containing a direct shared Azure Compute Gallery image reference.
-
str
- A relative uri containing a community Azure Compute Gallery image reference.
- id
str
- A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.
- lun
int
- If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.
- shared_gallery_image_id
str
- A relative uri containing a direct shared Azure Compute Gallery image reference.
-
String
- A relative uri containing a community Azure Compute Gallery image reference.
- id
String
- A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.
- lun
Number
- If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.
- sharedGalleryImageId
String
- A relative uri containing a direct shared Azure Compute Gallery image reference.
ImageDiskReferenceResponse
The source image used for creating the disk.
-
string
- A relative uri containing a community Azure Compute Gallery image reference.
- Id
string
- A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.
- Lun
int
- If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.
- SharedGalleryImageId
string
- A relative uri containing a direct shared Azure Compute Gallery image reference.
-
string
- A relative uri containing a community Azure Compute Gallery image reference.
- Id
string
- A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.
- Lun
int
- If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.
- SharedGalleryImageId
string
- A relative uri containing a direct shared Azure Compute Gallery image reference.
-
string
- A relative uri containing a community Azure Compute Gallery image reference.
- id
string
- A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.
- lun
number
- If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.
- shared_gallery_image_id
string
- A relative uri containing a direct shared Azure Compute Gallery image reference.
-
String
- A relative uri containing a community Azure Compute Gallery image reference.
- id
String
- A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.
- lun
Integer
- If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.
- sharedGalleryImageId
String
- A relative uri containing a direct shared Azure Compute Gallery image reference.
-
string
- A relative uri containing a community Azure Compute Gallery image reference.
- id
string
- A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.
- lun
number
- If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.
- sharedGalleryImageId
string
- A relative uri containing a direct shared Azure Compute Gallery image reference.
-
str
- A relative uri containing a community Azure Compute Gallery image reference.
- id
str
- A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.
- lun
int
- If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.
- shared_gallery_image_id
str
- A relative uri containing a direct shared Azure Compute Gallery image reference.
-
String
- A relative uri containing a community Azure Compute Gallery image reference.
- id
String
- A relative uri containing either a Platform Image Repository, user image, or Azure Compute Gallery image reference.
- lun
Number
- If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null.
- sharedGalleryImageId
String
- A relative uri containing a direct shared Azure Compute Gallery image reference.
KeyVaultAndKeyReference, KeyVaultAndKeyReferenceArgs
Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey
- key_url
string
- Url pointing to a key or secret in KeyVault
- source_vault
object
- Resource id of the KeyVault containing the key or secret
KeyVaultAndKeyReferenceResponse
Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey
- key_url
string
- Url pointing to a key or secret in KeyVault
- source_vault
object
- Resource id of the KeyVault containing the key or secret
KeyVaultAndSecretReference, KeyVaultAndSecretReferenceArgs
Key Vault Secret Url and vault id of the encryption key
KeyVaultAndSecretReferenceResponse
Key Vault Secret Url and vault id of the encryption key
NetworkAccessPolicy
Policy for accessing the disk via network.
| Name | Value | Description |
|---|
| AllowAll | AllowAll | The disk can be exported or uploaded to from any network. |
| AllowPrivate | AllowPrivate | The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. |
| DenyAll | DenyAll | The disk cannot be exported. |
| Name | Value | Description |
|---|
| NetworkAccessPolicyAllowAll | AllowAll | The disk can be exported or uploaded to from any network. |
| NetworkAccessPolicyAllowPrivate | AllowPrivate | The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. |
| NetworkAccessPolicyDenyAll | DenyAll | The disk cannot be exported. |
| Value | Description |
|---|
AllowAll | The disk can be exported or uploaded to from any network. |
AllowPrivate | The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. |
DenyAll | The disk cannot be exported. |
| Name | Value | Description |
|---|
| AllowAll | AllowAll | The disk can be exported or uploaded to from any network. |
| AllowPrivate | AllowPrivate | The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. |
| DenyAll | DenyAll | The disk cannot be exported. |
| Name | Value | Description |
|---|
| AllowAll | AllowAll | The disk can be exported or uploaded to from any network. |
| AllowPrivate | AllowPrivate | The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. |
| DenyAll | DenyAll | The disk cannot be exported. |
| Name | Value | Description |
|---|
| ALLOW_ALL | AllowAll | The disk can be exported or uploaded to from any network. |
| ALLOW_PRIVATE | AllowPrivate | The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. |
| DENY_ALL | DenyAll | The disk cannot be exported. |
| Value | Description |
|---|
AllowAll | The disk can be exported or uploaded to from any network. |
AllowPrivate | The disk can be exported or uploaded to using a DiskAccess resource's private endpoints. |
DenyAll | The disk cannot be exported. |
OperatingSystemTypes
This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD. Possible values are: Windows, Linux.
| Name | Value |
|---|
| Windows | Windows |
| Linux | Linux |
| Name | Value |
|---|
| OperatingSystemTypesWindows | Windows |
| OperatingSystemTypesLinux | Linux |
| Name | Value |
|---|
| Windows | Windows |
| Linux | Linux |
| Name | Value |
|---|
| Windows | Windows |
| Linux | Linux |
| Name | Value |
|---|
| WINDOWS | Windows |
| LINUX | Linux |
ProvisionedBandwidthCopyOption
If this field is set on a snapshot and createOption is CopyStart, the snapshot will be copied at a quicker speed.
| Name | Value |
|---|
| None | None |
| Enhanced | Enhanced |
| Name | Value |
|---|
| ProvisionedBandwidthCopyOptionNone | None |
| ProvisionedBandwidthCopyOptionEnhanced | Enhanced |
| Name | Value |
|---|
| None | None |
| Enhanced | Enhanced |
| Name | Value |
|---|
| None | None |
| Enhanced | Enhanced |
| Name | Value |
|---|
| NONE | None |
| ENHANCED | Enhanced |
PublicNetworkAccess
Policy for controlling export on the disk.
| Name | Value | Description |
|---|
| Enabled | Enabled | You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. |
| Disabled | Disabled | You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. |
| Name | Value | Description |
|---|
| PublicNetworkAccessEnabled | Enabled | You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. |
| PublicNetworkAccessDisabled | Disabled | You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. |
| Value | Description |
|---|
Enabled | You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. |
Disabled | You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. |
| Name | Value | Description |
|---|
| Enabled | Enabled | You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. |
| Disabled | Disabled | You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. |
| Name | Value | Description |
|---|
| Enabled | Enabled | You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. |
| Disabled | Disabled | You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. |
| Name | Value | Description |
|---|
| ENABLED | Enabled | You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. |
| DISABLED | Disabled | You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. |
| Value | Description |
|---|
Enabled | You can generate a SAS URI to access the underlying data of the disk publicly on the internet when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. |
Disabled | You cannot access the underlying data of the disk publicly on the internet even when NetworkAccessPolicy is set to AllowAll. You can access the data via the SAS URI only from your trusted Azure VNET when NetworkAccessPolicy is set to AllowPrivate. |
SnapshotSku, SnapshotSkuArgs
The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot
SnapshotSkuResponse
The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS. This is an optional parameter for incremental snapshot and the default behavior is the SKU will be set to the same sku as the previous snapshot
- Tier
string
- The sku tier.
- Name
string
- The sku name.
- Tier
string
- The sku tier.
- Name
string
- The sku name.
- tier
string
- The sku tier.
- name
string
- The sku name.
- tier
String
- The sku tier.
- name
String
- The sku name.
- tier
string
- The sku tier.
- name
string
- The sku name.
- tier
str
- The sku tier.
- name
str
- The sku name.
- tier
String
- The sku tier.
- name
String
- The sku name.
SnapshotStorageAccountTypes
The sku name.
| Name | Value | Description |
|---|
| Standard_LRS | Standard_LRS | Standard HDD locally redundant storage |
| Premium_LRS | Premium_LRS | Premium SSD locally redundant storage |
| Standard_ZRS | Standard_ZRS | Standard zone redundant storage |
| Name | Value | Description |
|---|
| SnapshotStorageAccountTypes_Standard_LRS | Standard_LRS | Standard HDD locally redundant storage |
| SnapshotStorageAccountTypes_Premium_LRS | Premium_LRS | Premium SSD locally redundant storage |
| SnapshotStorageAccountTypes_Standard_ZRS | Standard_ZRS | Standard zone redundant storage |
| Value | Description |
|---|
Standard_LRS | Standard HDD locally redundant storage |
Premium_LRS | Premium SSD locally redundant storage |
Standard_ZRS | Standard zone redundant storage |
| Name | Value | Description |
|---|
| Standard_LRS | Standard_LRS | Standard HDD locally redundant storage |
| Premium_LRS | Premium_LRS | Premium SSD locally redundant storage |
| Standard_ZRS | Standard_ZRS | Standard zone redundant storage |
| Name | Value | Description |
|---|
| Standard_LRS | Standard_LRS | Standard HDD locally redundant storage |
| Premium_LRS | Premium_LRS | Premium SSD locally redundant storage |
| Standard_ZRS | Standard_ZRS | Standard zone redundant storage |
| Name | Value | Description |
|---|
| STANDARD_LRS | Standard_LRS | Standard HDD locally redundant storage |
| PREMIUM_LRS | Premium_LRS | Premium SSD locally redundant storage |
| STANDARD_ZRS | Standard_ZRS | Standard zone redundant storage |
| Value | Description |
|---|
Standard_LRS | Standard HDD locally redundant storage |
Premium_LRS | Premium SSD locally redundant storage |
Standard_ZRS | Standard zone redundant storage |
SourceVault, SourceVaultArgs
The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}
SourceVaultResponse
The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}
SupportedCapabilities, SupportedCapabilitiesArgs
List of supported capabilities persisted on the disk resource for VM use.
- AcceleratedNetwork
bool
- True if the image from which the OS disk is created supports accelerated networking.
- Architecture
string | Architecture
- CPU architecture supported by an OS disk.
- DiskControllerTypes
string
- The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI.
- acceleratedNetwork
Boolean
- True if the image from which the OS disk is created supports accelerated networking.
- architecture
String | Architecture
- CPU architecture supported by an OS disk.
- diskControllerTypes
String
- The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI.
- acceleratedNetwork
boolean
- True if the image from which the OS disk is created supports accelerated networking.
- architecture
string | Architecture
- CPU architecture supported by an OS disk.
- diskControllerTypes
string
- The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI.
SupportedCapabilitiesResponse
List of supported capabilities persisted on the disk resource for VM use.
- AcceleratedNetwork
bool
- True if the image from which the OS disk is created supports accelerated networking.
- Architecture
string
- CPU architecture supported by an OS disk.
- DiskControllerTypes
string
- The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI.
- AcceleratedNetwork
bool
- True if the image from which the OS disk is created supports accelerated networking.
- Architecture
string
- CPU architecture supported by an OS disk.
- DiskControllerTypes
string
- The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI.
- accelerated_network
bool
- True if the image from which the OS disk is created supports accelerated networking.
- architecture
string
- CPU architecture supported by an OS disk.
- disk_controller_types
string
- The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI.
- acceleratedNetwork
Boolean
- True if the image from which the OS disk is created supports accelerated networking.
- architecture
String
- CPU architecture supported by an OS disk.
- diskControllerTypes
String
- The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI.
- acceleratedNetwork
boolean
- True if the image from which the OS disk is created supports accelerated networking.
- architecture
string
- CPU architecture supported by an OS disk.
- diskControllerTypes
string
- The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI.
- accelerated_network
bool
- True if the image from which the OS disk is created supports accelerated networking.
- architecture
str
- CPU architecture supported by an OS disk.
- disk_controller_types
str
- The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI.
- acceleratedNetwork
Boolean
- True if the image from which the OS disk is created supports accelerated networking.
- architecture
String
- CPU architecture supported by an OS disk.
- diskControllerTypes
String
- The disk controllers that an OS disk supports. If set it can be SCSI or SCSI, NVME or NVME, SCSI.
SystemDataResponse
Metadata pertaining to creation and last modification of the resource.
- CreatedAt
string
- The timestamp of resource creation (UTC).
- CreatedBy
string
- The identity that created the resource.
- CreatedByType
string
- The type of identity that created the resource.
- LastModifiedAt
string
- The timestamp of resource last modification (UTC)
- LastModifiedBy
string
- The identity that last modified the resource.
- LastModifiedByType
string
- The type of identity that last modified the resource.
- CreatedAt
string
- The timestamp of resource creation (UTC).
- CreatedBy
string
- The identity that created the resource.
- CreatedByType
string
- The type of identity that created the resource.
- LastModifiedAt
string
- The timestamp of resource last modification (UTC)
- LastModifiedBy
string
- The identity that last modified the resource.
- LastModifiedByType
string
- The type of identity that last modified the resource.
- createdAt
String
- The timestamp of resource creation (UTC).
- createdBy
String
- The identity that created the resource.
- createdByType
String
- The type of identity that created the resource.
- lastModifiedAt
String
- The timestamp of resource last modification (UTC)
- lastModifiedBy
String
- The identity that last modified the resource.
- lastModifiedByType
String
- The type of identity that last modified the resource.
- createdAt
string
- The timestamp of resource creation (UTC).
- createdBy
string
- The identity that created the resource.
- createdByType
string
- The type of identity that created the resource.
- lastModifiedAt
string
- The timestamp of resource last modification (UTC)
- lastModifiedBy
string
- The identity that last modified the resource.
- lastModifiedByType
string
- The type of identity that last modified the resource.
- createdAt
String
- The timestamp of resource creation (UTC).
- createdBy
String
- The identity that created the resource.
- createdByType
String
- The type of identity that created the resource.
- lastModifiedAt
String
- The timestamp of resource last modification (UTC)
- lastModifiedBy
String
- The identity that last modified the resource.
- lastModifiedByType
String
- The type of identity that last modified the resource.
Import
An existing resource can be imported using its type token, name, and identifier, e.g.
$ pulumi import azure-native:compute:Snapshot mySnapshot2 /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}
To learn more about importing existing cloud resources, see Importing resources.
Package Details
- Repository
- Azure Native pulumi/pulumi-azure-native
- License
- Apache-2.0