Virtual Machine Templates - Get

Reference

Service:: Azure Arc enabled VMware

API Version:: 2023-12-01

Gets a virtual machine template.
Implements virtual machine template GET method.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineTemplates/{virtualMachineTemplateName}?api-version=2023-12-01

URI Parameters

Name	In	Required	Type	Description
resourceGroupName	path	True	string	The Resource Group Name.
subscriptionId	path	True	string	The Subscription ID.
virtualMachineTemplateName	path	True	string	Name of the virtual machine template resource.
api-version	query	True	string	Client Api Version.

Responses

Name	Type	Description
200 OK	VirtualMachineTemplate	Success
Other Status Codes	ErrorResponse	Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name	Description
user_impersonation	impersonate your user account

Examples

GetVirtualMachineTemplate

GET https://management.azure.com/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineTemplates/WebFrontEndTemplate?api-version=2023-12-01

using Azure;
using Azure.ResourceManager;
using System;
using System.Threading.Tasks;
using Azure.Core;
using Azure.Identity;
using Azure.ResourceManager.ConnectedVMwarevSphere.Models;
using Azure.ResourceManager.Resources;
using Azure.ResourceManager.ConnectedVMwarevSphere;

// Generated from example definition: specification/connectedvmware/resource-manager/Microsoft.ConnectedVMwarevSphere/stable/2023-12-01/examples/GetVirtualMachineTemplate.json
// this example is just showing the usage of "VirtualMachineTemplates_Get" operation, for the dependent resources, they will have to be created separately.

// get your azure access token, for more details of how Azure SDK get your access token, please refer to https://learn.microsoft.com/en-us/dotnet/azure/sdk/authentication?tabs=command-line
TokenCredential cred = new DefaultAzureCredential();
// authenticate your client
ArmClient client = new ArmClient(cred);

// this example assumes you already have this VMwareVmTemplateResource created on azure
// for more information of creating VMwareVmTemplateResource, please refer to the document of VMwareVmTemplateResource
string subscriptionId = "fd3c3665-1729-4b7b-9a38-238e83b0f98b";
string resourceGroupName = "testrg";
string virtualMachineTemplateName = "WebFrontEndTemplate";
ResourceIdentifier vMwareVmTemplateResourceId = VMwareVmTemplateResource.CreateResourceIdentifier(subscriptionId, resourceGroupName, virtualMachineTemplateName);
VMwareVmTemplateResource vMwareVmTemplate = client.GetVMwareVmTemplateResource(vMwareVmTemplateResourceId);

// invoke the operation
VMwareVmTemplateResource result = await vMwareVmTemplate.GetAsync();

// the variable result is a resource, you could call other operations on this instance as well
// but just for demo, we get its data from this resource instance
VMwareVmTemplateData resourceData = result.Data;
// for demo we just print out the id
Console.WriteLine($"Succeeded on id: {resourceData.Id}");

To use the Azure SDK library in your project, see this documentation. To provide feedback on this code sample, open a GitHub issue

Sample response

Status code:: 200

{
  "id": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ConnectedVMwarevSphere/VirtualMachineTemplates/WebFrontEndTemplate",
  "name": "WebFrontEndTemplate",
  "type": "Microsoft.ConnectedVMwarevSphere/VirtualMachineTemplates",
  "location": "East US",
  "extendedLocation": {
    "type": "customLocation",
    "name": "/subscriptions/a5015e1c-867f-4533-8541-85cd470d0cfb/resourceGroups/demoRG/providers/Microsoft.ExtendedLocation/customLocations/contoso"
  },
  "properties": {
    "vCenterId": "/subscriptions/fd3c3665-1729-4b7b-9a38-238e83b0f98b/resourceGroups/testrg/providers/Microsoft.ConnectedVMwarevSphere/VCenters/ContosoVCenter",
    "moRefId": "aaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee",
    "provisioningState": "Succeeded"
  }
}

Definitions

Name	Description
createdByType	The type of identity that created the resource.
DiskMode	Defines the different types of disk modes.
DiskType	Defines the different types of disks.
ErrorAdditionalInfo	The resource management error additional info.
ErrorDetail	The error detail.
ErrorResponse	Error response
ExtendedLocation	The extended location.
FirmwareType	Firmware type
IPAddressAllocationMethod	IP address allocation method.
NetworkInterface	Network Interface model
NicIPAddressSettings	IP address information for a virtual network adapter reported by the fabric.
NicIPSettings	Defines the network interface ip settings.
NICType	NIC type
OsType	Defines the different types of VM guest operating systems.
PowerOnBootOption	Defines the options for power on boot.
ProvisioningState	Gets the provisioning state.
ResourceStatus	The resource status information.
systemData	Metadata pertaining to creation and last modification of the resource.
VirtualDisk	Virtual disk model
VirtualMachineTemplate	Define the virtualMachineTemplate.

createdByType

The type of identity that created the resource.

Name	Type	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DiskMode

Defines the different types of disk modes.

Name	Type	Description
independent_nonpersistent	string
independent_persistent	string
persistent	string

DiskType

Defines the different types of disks.

Name	Type	Description
flat	string
pmem	string
rawphysical	string
rawvirtual	string
sesparse	string
sparse	string
unknown	string

ErrorAdditionalInfo

The resource management error additional info.

Name	Type	Description
info	object	The additional info.
type	string	The additional info type.

ErrorDetail

The error detail.

Name	Type	Description
additionalInfo	ErrorAdditionalInfo[]	The error additional info.
code	string	The error code.
details	ErrorDetail[]	The error details.
message	string	The error message.
target	string	The error target.

ErrorResponse

Error response

Name	Type	Description
error	ErrorDetail	The error object.

ExtendedLocation

The extended location.

Name	Type	Description
name	string	The extended location name.
type	string	The extended location type.

FirmwareType

Firmware type

Name	Type	Description
bios	string
efi	string

IPAddressAllocationMethod

IP address allocation method.

Name	Type	Description
dynamic	string
linklayer	string
other	string
random	string
static	string
unset	string

NetworkInterface

Network Interface model

Name	Type	Description
deviceKey	integer	Gets or sets the device key value.
ipAddresses	string[]	Gets or sets the nic ip addresses.
ipSettings	NicIPSettings	Gets or sets the ipsettings.
label	string	Gets or sets the label of the virtual network in vCenter that the nic is connected to.
macAddress	string	Gets or sets the NIC MAC address.
name	string	Gets or sets the name of the network interface.
networkId	string	Gets or sets the ARM Id of the network resource to connect the virtual machine.
networkMoName	string	Gets or sets the name of the virtual network in vCenter that the nic is connected to.
networkMoRefId	string	Gets or sets the vCenter MoRef (Managed Object Reference) ID of the virtual network that the nic is connected to.
nicType	NICType	NIC type
powerOnBoot	PowerOnBootOption	Gets or sets the power on boot.

NicIPAddressSettings

IP address information for a virtual network adapter reported by the fabric.

Name	Type	Description
allocationMethod	string	Gets the ip address allocation method.
ipAddress	string	Gets the ip address for the nic.
subnetMask	string	Gets the mask.

NicIPSettings

Defines the network interface ip settings.

Name	Type	Description
allocationMethod	IPAddressAllocationMethod	Gets or sets the nic allocation method.
dnsServers	string[]	Gets or sets the dns servers.
gateway	string[]	Gets or sets the gateway.
ipAddress	string	Gets or sets the ip address for the nic.
ipAddressInfo	NicIPAddressSettings[]	Gets or sets the IP address information being reported for this NIC. This contains the same IPv4 information above plus IPV6 information.
primaryWinsServer	string	Gets or sets the primary server.
secondaryWinsServer	string	Gets or sets the secondary server.
subnetMask	string	Gets or sets the mask.

NICType

NIC type

Name	Type	Description
e1000	string
e1000e	string
pcnet32	string
vmxnet	string
vmxnet2	string
vmxnet3	string

OsType

Defines the different types of VM guest operating systems.

Name	Type	Description
Linux	string
Other	string
Windows	string

PowerOnBootOption

Defines the options for power on boot.

Name	Type	Description
disabled	string
enabled	string

ProvisioningState

Gets the provisioning state.

Name	Type	Description
Accepted	string
Canceled	string
Created	string
Deleting	string
Failed	string
Provisioning	string
Succeeded	string
Updating	string

ResourceStatus

The resource status information.

Name	Type	Description
lastUpdatedAt	string	The last update time for this condition.
message	string	A human readable message indicating details about the status.
reason	string	The reason for the condition's status.
severity	string	Severity with which to treat failures of this type of condition.
status	string	Status of the condition.
type	string	The type of the condition.

systemData

Metadata pertaining to creation and last modification of the resource.

Name	Type	Description
createdAt	string	The timestamp of resource creation (UTC).
createdBy	string	The identity that created the resource.
createdByType	createdByType	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	createdByType	The type of identity that last modified the resource.

VirtualDisk

Virtual disk model

Name	Type	Description
controllerKey	integer	Gets or sets the controller id.
deviceKey	integer	Gets or sets the device key value.
deviceName	string	Gets or sets the device name.
diskMode	DiskMode	Gets or sets the disk mode.
diskObjectId	string	Gets or sets the disk object id.
diskSizeGB	integer	Gets or sets the disk total size.
diskType	DiskType	Gets or sets the disk backing type.
label	string	Gets or sets the label of the virtual disk in vCenter.
name	string	Gets or sets the name of the virtual disk.
unitNumber	integer	Gets or sets the unit number of the disk on the controller.