swagger: '2.0' info: version: 2020-08-01-preview title: Microsoft Azure AccessControlClient AccessConnector VirtualMachineTemplates API schemes: - https tags: - name: VirtualMachineTemplates paths: ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineTemplates/{virtualMachineTemplateName} : put: tags: - VirtualMachineTemplates operationId: microsoftAzureVirtualmachinetemplatesCreate description: Create Or Update virtual machine template. x-ms-examples: CreateVirtualMachineTemplate: $ref: ./examples/CreateVirtualMachineTemplate.json summary: Microsoft Azure Implements Virtual Machine Template Put Method consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: virtualMachineTemplateName description: Name of the virtual machine template resource. required: true type: string - $ref: '#/parameters/api-version' - in: body name: body description: Request payload. schema: $ref: '#/definitions/VirtualMachineTemplate' responses: '200': description: Arm resource update successful. schema: $ref: '#/definitions/VirtualMachineTemplate' '201': description: Created schema: $ref: '#/definitions/VirtualMachineTemplate' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation get: tags: - VirtualMachineTemplates operationId: microsoftAzureVirtualmachinetemplatesGet summary: Microsoft Azure Gets A Virtual Machine Template description: Implements virtual machine template GET method. x-ms-examples: GetVirtualMachineTemplate: $ref: ./examples/GetVirtualMachineTemplate.json produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: virtualMachineTemplateName description: Name of the virtual machine template resource. required: true type: string - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/VirtualMachineTemplate' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse patch: tags: - VirtualMachineTemplates operationId: microsoftAzureVirtualmachinetemplatesUpdate summary: Microsoft Azure Updates A Virtual Machine Template description: API to update certain properties of the virtual machine template resource. x-ms-examples: UpdateVirtualMachineTemplate: $ref: ./examples/UpdateVirtualMachineTemplate.json consumes: - application/json produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: virtualMachineTemplateName required: true type: string description: Name of the virtual machine template resource. - $ref: '#/parameters/api-version' - in: body name: body description: Resource properties to update. schema: $ref: '#/definitions/ResourcePatch' responses: '200': description: Arm resource update successful. schema: $ref: '#/definitions/VirtualMachineTemplate' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse delete: tags: - VirtualMachineTemplates operationId: microsoftAzureVirtualmachinetemplatesDelete summary: Microsoft Azure Deletes An Virtual Machine Template description: Implements virtual machine template DELETE method. x-ms-examples: DeleteVirtualMachineTemplate: $ref: ./examples/DeleteVirtualMachineTemplate.json produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - in: path name: virtualMachineTemplateName required: true type: string description: Name of the virtual machine template resource. - $ref: '#/parameters/api-version' - in: query name: force description: Whether force delete was specified. required: false type: boolean responses: '200': description: Success '202': description: Accepted headers: Location: type: string '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-long-running-operation: true /subscriptions/{subscriptionId}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineTemplates: get: tags: - VirtualMachineTemplates operationId: microsoftAzureVirtualmachinetemplatesList summary: Microsoft Azure Implements Get Virtualmachinetemplates In A Subscription description: List of virtualMachineTemplates in a subscription. x-ms-examples: ListVirtualMachineTemplates: $ref: ./examples/ListVirtualMachineTemplates.json produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/VirtualMachineTemplatesList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ConnectedVMwarevSphere/virtualMachineTemplates : get: tags: - VirtualMachineTemplates operationId: microsoftAzureVirtualmachinetemplatesListbyresourcegroup summary: Microsoft Azure Implements Get Virtualmachinetemplates In A Resource Group description: List of virtualMachineTemplates in a resource group. x-ms-examples: ListVirtualMachineTemplatesByResourceGroup: $ref: ./examples/ListVirtualMachineTemplatesByResourceGroup.json produces: - application/json parameters: - $ref: '#/parameters/subscriptionId' - $ref: '#/parameters/resourceGroupName' - $ref: '#/parameters/api-version' responses: '200': description: Success schema: $ref: '#/definitions/VirtualMachineTemplatesList' default: description: Error response describing why the operation failed. schema: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/ErrorResponse x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachineTemplates/{virtualMachineTemplateName} : get: tags: - VirtualMachineTemplates operationId: microsoftAzureVirtualmachinetemplatesGet summary: Microsoft Azure Gets A Virtualmachinetemplate description: Implements VirtualMachineTemplate GET method. x-ms-examples: GetVirtualMachineTemplate: $ref: ./examples/GetVirtualMachineTemplate.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: virtualMachineTemplateName required: true type: string description: Name of the VirtualMachineTemplate. - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Retrieves the VirtualMachineTemplates resource. schema: $ref: '#/definitions/VirtualMachineTemplate_2' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' put: tags: - VirtualMachineTemplates operationId: microsoftAzureVirtualmachinetemplatesCreateorupdate description: Onboards the ScVmm VM Template as an Azure VM Template resource. summary: Microsoft Azure Implements Virtualmachinetemplates Put Method x-ms-examples: CreateVirtualMachineTemplate: $ref: ./examples/CreateVirtualMachineTemplate.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: virtualMachineTemplateName required: true type: string description: Name of the VirtualMachineTemplate. - $ref: '#/parameters/ApiVersionParameter' - name: body description: Request payload. in: body required: true schema: $ref: '#/definitions/VirtualMachineTemplate_2' responses: '200': description: Creates or Updates the VirtualMachineTemplates resource. schema: $ref: '#/definitions/VirtualMachineTemplate_2' '201': description: Creates or Updates the VirtualMachineTemplates resource. schema: $ref: '#/definitions/VirtualMachineTemplate_2' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation delete: tags: - VirtualMachineTemplates operationId: microsoftAzureVirtualmachinetemplatesDelete description: Deregisters the ScVmm VM Template from Azure. summary: Microsoft Azure Implements Virtualmachinetemplate Delete Method x-ms-examples: DeleteVirtualMachineTemplate: $ref: ./examples/DeleteVirtualMachineTemplate.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - in: path name: virtualMachineTemplateName required: true type: string description: Name of the VirtualMachineTemplate. - $ref: '#/parameters/ApiVersionParameter' - in: query name: force description: Forces the resource to be deleted from azure. The corresponding CR would be attempted to be deleted too. required: false type: boolean responses: '200': description: Deletes the VirtualMachineTemplates resource. '202': description: Accepted '204': description: No Content default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation patch: tags: - VirtualMachineTemplates operationId: microsoftAzureVirtualmachinetemplatesUpdate summary: Microsoft Azure Implements The Virtualmachinetemplate Patch Method description: Updates the VirtualMachineTemplate resource. x-ms-examples: UpdateVirtualMachineTemplate: $ref: ./examples/UpdateVirtualMachineTemplate.json parameters: - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter' - $ref: '#/parameters/SubscriptionIdParameter' - in: path name: virtualMachineTemplateName required: true type: string description: Name of the VirtualMachineTemplate. - name: body description: VirtualMachineTemplates patch details. in: body required: true schema: $ref: '#/definitions/ResourcePatch_2' responses: '200': description: Successful. schema: $ref: '#/definitions/VirtualMachineTemplate_2' '201': description: Created schema: $ref: '#/definitions/VirtualMachineTemplate_2' '202': description: Accepted default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-long-running-operation: true x-ms-long-running-operation-options: final-state-via: azure-async-operation /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ScVmm/virtualMachineTemplates: get: tags: - VirtualMachineTemplates operationId: microsoftAzureVirtualmachinetemplatesListbyresourcegroup summary: Microsoft Azure Implements Get Virtualmachinetemplates In A Resource Group description: List of VirtualMachineTemplates in a resource group. x-ms-examples: ListVirtualMachineTemplatesByResourceGroup: $ref: ./examples/ListVirtualMachineTemplatesByResourceGroup.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ResourceGroupNameParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Lists all VirtualMachineTemplates under the resource group. schema: $ref: '#/definitions/VirtualMachineTemplateListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink /subscriptions/{subscriptionId}/providers/Microsoft.ScVmm/virtualMachineTemplates: get: tags: - VirtualMachineTemplates operationId: microsoftAzureVirtualmachinetemplatesListbysubscription summary: Microsoft Azure Implements Get Virtualmachinetemplates In A Subscription description: List of VirtualMachineTemplates in a subscription. x-ms-examples: ListVirtualMachineTemplatesBySubscription: $ref: ./examples/ListVirtualMachineTemplatesBySubscription.json parameters: - $ref: '#/parameters/SubscriptionIdParameter' - $ref: '#/parameters/ApiVersionParameter' responses: '200': description: Lists all VirtualMachineTemplates under the subscription. schema: $ref: '#/definitions/VirtualMachineTemplateListResult' default: description: Error response describing why the operation failed. schema: $ref: '#/definitions/ErrorResponse' x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}/virtualMachineTemplates : get: description: Returns list of virtual machine templates in region for private cloud produces: - application/json tags: - VirtualMachineTemplates summary: Microsoft Azure Implements List Of Available Vm Templates operationId: microsoftAzureVirtualmachinetemplatesList parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/api-version_2' - $ref: '#/parameters/pcName' - $ref: '#/parameters/regionId' - type: string description: Resource pool used to derive vSphere cluster which contains VM templates name: resourcePoolName in: query required: true responses: '200': description: successful operation schema: $ref: '#/definitions/VirtualMachineTemplateListResponse' default: description: General Error schema: $ref: '#/definitions/CSRPError' x-ms-examples: ListVirtualMachineTemplates: $ref: ./examples/ListVirtualMachineTemplates.json x-ms-pageable: nextLinkName: nextLink ? /subscriptions/{subscriptionId}/providers/Microsoft.VMwareCloudSimple/locations/{regionId}/privateClouds/{pcName}/virtualMachineTemplates/{virtualMachineTemplateName} : get: description: Returns virtual machine templates by its name consumes: - application/json produces: - application/json tags: - VirtualMachineTemplates summary: Microsoft Azure Implements Virtual Machine Template Get Method operationId: microsoftAzureVirtualmachinetemplatesGet parameters: - $ref: '#/parameters/subscriptionId_2' - $ref: '#/parameters/regionId' - $ref: '#/parameters/pcName' - type: string description: virtual machine template id (vsphereId) name: virtualMachineTemplateName in: path required: true - $ref: '#/parameters/api-version_2' responses: '200': description: successful operation schema: $ref: '#/definitions/VirtualMachineTemplate_3' default: description: General Error schema: $ref: '#/definitions/CSRPError' x-ms-examples: GetVirtualMachineTemplate: $ref: ./examples/GetVirtualMachineTemplate.json definitions: VirtualMachineTemplate: description: Define the virtualMachineTemplate. required: - location - properties type: object x-ms-azure-resource: true properties: properties: x-ms-client-flatten: true description: Resource properties. $ref: '#/definitions/VirtualMachineTemplateProperties' location: description: Gets or sets the location. type: string x-ms-mutability: - read - create extendedLocation: $ref: '#/definitions/ExtendedLocation' description: Gets or sets the extended location. systemData: $ref: ../../../../../common-types/resource-management/v2/types.json#/definitions/systemData description: The system data. tags: description: Gets or sets the Resource tags. type: object additionalProperties: type: string name: description: Gets or sets the name. type: string readOnly: true id: description: Gets or sets the Id. type: string readOnly: true type: description: Gets or sets the type of the resource. type: string readOnly: true kind: type: string description: Metadata used by portal/tooling/etc to render different UX experiences for resources of the same type; e.g. ApiApps are a kind of Microsoft.Web/sites type. If supported, the resource provider must validate and persist this value. VirtualNic: description: Virtual NIC model required: - nicType - network properties: customization: description: guest OS customization for nic $ref: '#/definitions/GuestOSNICCustomization' ipAddresses: description: NIC ip address type: array items: type: string macAddress: description: NIC MAC address type: string network: description: Virtual Network $ref: '#/definitions/VirtualNetwork' nicType: description: NIC type type: string enum: - E1000 - E1000E - PCNET32 - VMXNET - VMXNET2 - VMXNET3 x-ms-enum: modelAsString: false name: NICType powerOnBoot: description: Is NIC powered on/off on boot type: boolean virtualNicId: description: NIC id type: string virtualNicName: description: NIC name type: string readOnly: true OsType: description: Defines the different types of VM guest operating systems. enum: - Windows - Linux - Other type: string x-ms-enum: modelAsString: true name: OsType GuestOSNICCustomization: description: Guest OS nic customization properties: allocation: description: IP address allocation method type: string enum: - static - dynamic dnsServers: description: List of dns servers to use type: array items: $ref: '#/definitions/IPV4Address' gateway: description: Gateway addresses assigned to nic type: array items: $ref: '#/definitions/IPV4Address' ipAddress: description: Static ip address for nic $ref: '#/definitions/IPV4Address' mask: description: Network mask for nic $ref: '#/definitions/IPV4Address' primaryWinsServer: description: primary WINS server for Windows $ref: '#/definitions/IPV4Address' secondaryWinsServer: description: secondary WINS server for Windows $ref: '#/definitions/IPV4Address' ExtendedLocation: type: object description: The extended location. properties: type: type: string description: The extended location type. name: type: string description: The extended location name. VirtualMachineTemplatesList: description: List of VirtualMachineTemplates. type: object properties: nextLink: description: Url to follow for getting next page of VirtualMachineTemplates. type: string value: description: Array of VirtualMachineTemplates type: array items: $ref: '#/definitions/VirtualMachineTemplate' required: - value VirtualMachineTemplate_3: description: Virtual machine template model properties: id: description: virtual machine template id (privateCloudId:vsphereId) type: string readOnly: true location: description: Azure region type: string name: description: '{virtualMachineTemplateName}' type: string readOnly: true properties: description: The Virtual Machine Template properties x-ms-client-flatten: true $ref: '#/definitions/VirtualMachineTemplateProperties_3' type: description: '{resourceProviderNamespace}/{resourceType}' type: string readOnly: true CSRPErrorBody: description: Error properties properties: code: description: Error's code type: string readOnly: true details: description: Error's details type: array items: $ref: '#/definitions/CSRPErrorBody' x-ms-identifiers: [] readOnly: true message: description: Error's message type: string readOnly: true target: description: Error's target type: string VirtualNetworkProperties: description: Properties of virtual network properties: privateCloudId: description: The Private Cloud id type: string readOnly: true AllocationMethod: description: Allocation method. enum: - Dynamic - Static x-ms-enum: modelAsString: true name: AllocationMethod type: string ResourceProvisioningState: type: string description: The current deployment state of resource. enum: - Succeeded - Failed - Canceled - Provisioning - Updating - Deleting - Accepted - Created x-ms-enum: name: ProvisioningState modelAsString: true NetworkInterface: description: Network Interface model type: object properties: name: description: Gets or sets the name of the network interface. type: string label: description: Gets or sets the label of the virtual network in vCenter that the nic is connected to. type: string readOnly: true ipAddresses: description: Gets or sets the nic ip addresses. type: array items: type: string readOnly: true macAddress: description: Gets or sets the NIC MAC address. type: string readOnly: true networkId: description: Gets or sets the ARM Id of the network resource to connect the virtual machine. type: string nicType: description: NIC type $ref: '#/definitions/NICType' powerOnBoot: description: Gets or sets the power on boot. $ref: '#/definitions/PowerOnBootOption' networkMoRefId: description: "Gets or sets the vCenter MoRef (Managed Object Reference) ID of the virtual network\r\nthat the nic is connected to." type: string readOnly: true networkMoName: description: Gets or sets the name of the virtual network in vCenter that the nic is connected to. type: string readOnly: true deviceKey: format: int32 description: Gets or sets the device key value. type: integer ipSettings: description: Gets or sets the ipsettings. $ref: '#/definitions/NicIPSettings' VirtualMachineTemplateProperties: description: Describes the properties of a Virtual Machine Template. type: object properties: uuid: description: Gets or sets a unique identifier for this resource. type: string readOnly: true vCenterId: description: Gets or sets the ARM Id of the vCenter resource in which this template resides. type: string moRefId: description: "Gets or sets the vCenter MoRef (Managed Object Reference) ID for the virtual machine\r\ntemplate." type: string inventoryItemId: description: Gets or sets the inventory Item ID for the virtual machine template. type: string moName: description: Gets or sets the vCenter Managed Object name for the virtual machine template. type: string readOnly: true memorySizeMB: format: int32 description: Gets or sets memory size in MBs for the template. type: integer readOnly: true numCPUs: format: int32 description: Gets or sets the number of vCPUs for the template. type: integer readOnly: true numCoresPerSocket: format: int32 description: "Gets or sets the number of cores per socket for the template.\r\nDefaults to 1 if unspecified." type: integer readOnly: true osType: description: Gets or sets the type of the os. $ref: '#/definitions/OsType' readOnly: true osName: description: Gets or sets os name. type: string readOnly: true folderPath: description: Gets or sets the folder path of the template. type: string readOnly: true networkInterfaces: description: Gets or sets the network interfaces of the template. type: array items: $ref: '#/definitions/NetworkInterface' readOnly: true disks: description: Gets or sets the disks the template. type: array items: $ref: '#/definitions/VirtualDisk' readOnly: true customResourceName: description: Gets the name of the corresponding resource in Kubernetes. type: string readOnly: true toolsVersionStatus: description: Gets or sets the current version status of VMware Tools installed in the guest operating system. type: string readOnly: true toolsVersion: description: Gets or sets the current version of VMware Tools. type: string readOnly: true firmwareType: description: Firmware type $ref: '#/definitions/FirmwareType' readOnly: true statuses: description: The resource status information. readOnly: true type: array items: $ref: '#/definitions/ResourceStatus' x-ms-identifiers: - type provisioningState: $ref: '#/definitions/ResourceProvisioningState' description: Gets the provisioning state. readOnly: true CSRPError: description: General error model properties: error: description: Error's body $ref: '#/definitions/CSRPErrorBody' VirtualDiskController: description: Virtual disk controller model properties: id: description: Controller's id type: string readOnly: true name: description: The display name of Controller type: string readOnly: true subType: description: dik controller subtype (VMWARE_PARAVIRTUAL, BUS_PARALLEL, LSI_PARALLEL, LSI_SAS) type: string readOnly: true type: description: disk controller type (SCSI) type: string readOnly: true ResourceStatus: description: The resource status information. type: object properties: type: description: The type of the condition. type: string readOnly: true status: description: Status of the condition. type: string readOnly: true reason: description: The reason for the condition's status. type: string readOnly: true message: description: A human readable message indicating details about the status. type: string readOnly: true severity: description: Severity with which to treat failures of this type of condition. type: string readOnly: true lastUpdatedAt: description: The last update time for this condition. type: string format: date-time readOnly: true PowerOnBootOption: description: Defines the options for power on boot. enum: - enabled - disabled type: string x-ms-enum: modelAsString: true name: PowerOnBootOption VirtualMachineTemplate_2: type: object x-ms-azure-resource: true properties: properties: x-ms-client-flatten: true description: Resource properties. $ref: '#/definitions/VirtualMachineTemplateProperties_2' id: type: string readOnly: true description: Resource Id name: type: string readOnly: true description: Resource Name type: type: string readOnly: true description: Resource Type location: description: Gets or sets the location. type: string x-ms-mutability: - read - create tags: type: object additionalProperties: type: string description: Resource tags systemData: $ref: ../../../../../common-types/resource-management/v3/types.json#/definitions/systemData description: The system data. extendedLocation: $ref: '#/definitions/ExtendedLocation' description: The extended location. required: - location - properties - extendedLocation description: The VirtualMachineTemplates resource definition. VirtualDisk: description: Virtual disk model type: object properties: name: description: Gets or sets the name of the virtual disk. type: string label: description: Gets or sets the label of the virtual disk in vCenter. type: string readOnly: true diskObjectId: description: Gets or sets the disk object id. type: string readOnly: true diskSizeGB: format: int32 description: Gets or sets the disk total size. type: integer deviceKey: format: int32 description: Gets or sets the device key value. type: integer diskMode: description: Gets or sets the disk mode. $ref: '#/definitions/DiskMode' controllerKey: description: Gets or sets the controller id. format: int32 type: integer unitNumber: description: Gets or sets the unit number of the disk on the controller. format: int32 type: integer deviceName: description: Gets or sets the device name. type: string diskType: description: Gets or sets the disk backing type. $ref: '#/definitions/DiskType' ErrorDefinition: description: Error definition. type: object properties: code: description: Service specific error code which serves as the substatus for the HTTP error code. type: string readOnly: true message: description: Description of the error. type: string readOnly: true details: description: Internal error details. type: array items: $ref: '#/definitions/ErrorDefinition' x-ms-identifiers: [] readOnly: true ResourcePatch_2: type: object properties: tags: type: object additionalProperties: type: string description: Resource tags. description: Object containing tags updates for patch operations. VirtualMachineTemplateProperties_3: description: Properties of virtual machine template required: - privateCloudId properties: amountOfRam: description: The amount of memory type: integer controllers: description: The list of Virtual Disk Controllers type: array items: $ref: '#/definitions/VirtualDiskController' description: description: The description of Virtual Machine Template type: string disks: description: The list of Virtual Disks type: array items: $ref: '#/definitions/VirtualDisk_3' x-ms-identifiers: - virtualDiskId exposeToGuestVM: description: Expose Guest OS or not type: boolean guestOS: description: The Guest OS type: string readOnly: true guestOSType: description: The Guest OS types type: string readOnly: true nics: description: The list of Virtual NICs type: array items: $ref: '#/definitions/VirtualNic' x-ms-identifiers: - virtualNicId numberOfCores: description: The number of CPU cores type: integer path: description: path to folder type: string example: Datacenter/Workload VMs privateCloudId: description: The Private Cloud Id type: string vSphereNetworks: description: The list of VSphere networks type: array items: type: string vSphereTags: description: The tags from VSphere type: array items: type: string vmwaretools: description: The VMware tools version type: string readOnly: true NetworkInterfaces: description: Network Interface model type: object properties: name: description: Gets or sets the name of the network interface. type: string displayName: description: Gets the display name of the network interface as shown in the vmmServer. This is the fallback label for a NIC when the name is not set. type: string readOnly: true ipv4Addresses: description: Gets or sets the nic ipv4 addresses. type: array items: type: string readOnly: true ipv6Addresses: description: Gets or sets the nic ipv6 addresses. type: array items: type: string readOnly: true macAddress: description: Gets or sets the nic MAC address. type: string virtualNetworkId: description: Gets or sets the ARM Id of the Microsoft.ScVmm/virtualNetwork resource to connect the nic. type: string networkName: description: Gets or sets the name of the virtual network in vmmServer that the nic is connected to. type: string readOnly: true ipv4AddressType: description: Gets or sets the ipv4 address type. $ref: '#/definitions/AllocationMethod' ipv6AddressType: description: Gets or sets the ipv6 address type. $ref: '#/definitions/AllocationMethod' macAddressType: description: Gets or sets the mac address type. $ref: '#/definitions/AllocationMethod' nicId: description: Gets or sets the nic id. type: string VirtualDisk_2: description: Virtual disk model type: object properties: name: description: Gets or sets the name of the disk. type: string displayName: description: Gets the display name of the virtual disk as shown in the vmmServer. This is the fallback label for a disk when the name is not set. type: string readOnly: true diskId: description: Gets or sets the disk id. type: string diskSizeGB: format: int32 description: Gets or sets the disk total size. type: integer maxDiskSizeGB: format: int32 description: Gets or sets the max disk size. type: integer readOnly: true bus: format: int32 description: Gets or sets the disk bus. type: integer lun: format: int32 description: Gets or sets the disk lun. type: integer busType: description: Gets or sets the disk bus type. type: string vhdType: description: Gets or sets the disk vhd type. type: string volumeType: description: Gets or sets the disk volume type. type: string readOnly: true vhdFormatType: description: Gets the disk vhd format type. type: string readOnly: true templateDiskId: description: Gets or sets the disk id in the template. type: string storageQoSPolicy: description: The QoS policy for the disk. $ref: '#/definitions/StorageQoSPolicyDetails' createDiffDisk: type: string description: Gets or sets a value indicating diff disk. enum: - 'false' - 'true' x-ms-enum: modelAsString: true name: CreateDiffDisk DiskMode: description: Defines the different types of disk modes. enum: - persistent - independent_persistent - independent_nonpersistent type: string x-ms-enum: modelAsString: true name: DiskMode NicIPAddressSettings: description: IP address information for a virtual network adapter reported by the fabric. type: object properties: allocationMethod: description: Gets the ip address allocation method. type: string readOnly: true ipAddress: description: Gets the ip address for the nic. type: string readOnly: true subnetMask: description: Gets the mask. type: string readOnly: true VirtualNetwork: description: Virtual network model required: - id properties: assignable: description: can be used in vm creation/deletion type: boolean readOnly: true id: description: virtual network id (privateCloudId:vsphereId) type: string location: description: Azure region type: string readOnly: true name: description: '{VirtualNetworkName}' type: string readOnly: true properties: description: Virtual Network properties x-ms-client-flatten: true $ref: '#/definitions/VirtualNetworkProperties' type: description: '{resourceProviderNamespace}/{resourceType}' type: string readOnly: true OsType_2: description: Defines the different types of VM guest operating systems. enum: - Windows - Linux - Other x-ms-enum: modelAsString: true name: OsType type: string readOnly: true VirtualMachineTemplateProperties_2: description: Defines the resource properties. type: object properties: inventoryItemId: description: Gets or sets the inventory Item ID for the resource. type: string uuid: type: string description: Unique ID of the virtual machine template. minLength: 1 vmmServerId: type: string description: ARM Id of the vmmServer resource in which this resource resides. osType: description: Gets or sets the type of the os. $ref: '#/definitions/OsType_2' readOnly: true osName: description: Gets or sets os name. type: string readOnly: true computerName: description: Gets or sets computer name. type: string readOnly: true memoryMB: type: integer format: int32 description: MemoryMB is the desired size of a virtual machine's memory, in MB. readOnly: true cpuCount: type: integer description: Gets or sets the desired number of vCPUs for the vm. format: int32 readOnly: true limitCpuForMigration: type: string description: Gets or sets a value indicating whether to enable processor compatibility mode for live migration of VMs. enum: - 'false' - 'true' x-ms-enum: modelAsString: true name: LimitCpuForMigration readOnly: true dynamicMemoryEnabled: type: string description: Gets or sets a value indicating whether to enable dynamic memory or not. enum: - 'false' - 'true' x-ms-enum: modelAsString: true name: DynamicMemoryEnabled readOnly: true isCustomizable: type: string description: Gets or sets a value indicating whether the vm template is customizable or not. enum: - 'false' - 'true' x-ms-enum: modelAsString: true name: IsCustomizable readOnly: true dynamicMemoryMaxMB: type: integer format: int32 description: Gets or sets the max dynamic memory for the vm. readOnly: true dynamicMemoryMinMB: type: integer format: int32 description: Gets or sets the min dynamic memory for the vm. readOnly: true isHighlyAvailable: description: Gets highly available property. type: string readOnly: true generation: type: integer format: int32 description: Gets or sets the generation for the vm. readOnly: true networkInterfaces: description: Gets or sets the network interfaces of the template. type: array items: $ref: '#/definitions/NetworkInterfaces' x-ms-identifiers: - name - nicId readOnly: true disks: description: Gets or sets the disks of the template. type: array items: $ref: '#/definitions/VirtualDisk_2' x-ms-identifiers: - name - diskId readOnly: true provisioningState: description: Gets or sets the provisioning state. type: string readOnly: true DiskType: description: Defines the different types of disks. enum: - flat - pmem - rawphysical - rawvirtual - sparse - sesparse - unknown type: string x-ms-enum: modelAsString: true name: DiskType NICType: description: NIC type type: string enum: - vmxnet3 - vmxnet2 - vmxnet - e1000 - e1000e - pcnet32 x-ms-enum: modelAsString: true name: NICType VirtualMachineTemplateListResponse: description: List of virtual machine templates properties: nextLink: description: Link for next list of VirtualMachineTemplate type: string value: description: Results of the VM template list type: array items: $ref: '#/definitions/VirtualMachineTemplate_3' FirmwareType: description: Firmware type type: string enum: - bios - efi x-ms-enum: modelAsString: true name: FirmwareType NicIPSettings: description: Defines the network interface ip settings. type: object properties: allocationMethod: description: Gets or sets the nic allocation method. $ref: '#/definitions/IPAddressAllocationMethod' dnsServers: description: Gets or sets the dns servers. type: array items: type: string gateway: description: Gets or sets the gateway. type: array items: type: string ipAddress: description: Gets or sets the ip address for the nic. type: string subnetMask: description: Gets or sets the mask. type: string primaryWinsServer: description: Gets or sets the primary server. type: string readOnly: true secondaryWinsServer: description: Gets or sets the secondary server. type: string readOnly: true ipAddressInfo: description: Gets or sets the IP address information being reported for this NIC. This contains the same IPv4 information above plus IPV6 information. type: array items: $ref: '#/definitions/NicIPAddressSettings' readOnly: true IPV4Address: type: string pattern: ^(([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])[.]){3}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])$ StorageQoSPolicyDetails: description: The StorageQoSPolicyDetails definition. type: object properties: name: description: The name of the policy. type: string id: description: The ID of the QoS policy. type: string ErrorResponse: description: Error response. type: object properties: error: $ref: '#/definitions/ErrorDefinition' description: The error details. ResourcePatch: type: object properties: tags: type: object additionalProperties: type: string description: Resource tags. description: Object containing updates for patch operations. VirtualDisk_3: description: Virtual disk model required: - totalSize - independenceMode - controllerId properties: controllerId: description: Disk's Controller id type: string independenceMode: description: Disk's independence mode type type: string enum: - persistent - independent_persistent - independent_nonpersistent x-ms-enum: modelAsString: false name: DiskIndependenceMode totalSize: description: Disk's total size type: integer virtualDiskId: description: Disk's id type: string virtualDiskName: description: Disk's display name type: string readOnly: true VirtualMachineTemplateListResult: type: object description: List of VirtualMachineTemplates. properties: value: description: List of VirtualMachineTemplates. type: array items: $ref: '#/definitions/VirtualMachineTemplate_2' nextLink: type: string description: Url to follow for getting next page of resources. IPAddressAllocationMethod: description: IP address allocation method. enum: - unset - dynamic - static - linklayer - random - other type: string x-ms-enum: modelAsString: true name: IPAddressAllocationMethod parameters: pcName: type: string x-ms-parameter-location: method description: The private cloud name name: pcName in: path required: true ApiVersionParameter: name: api-version in: query required: true type: string description: The API version to be used with the HTTP request (e.g. YYYY-MM-DD). resourceGroupName: in: path name: resourceGroupName description: The Resource Group Name. required: true type: string x-ms-parameter-location: method api-version: in: query name: api-version description: Client Api Version. required: true type: string ResourceGroupNameParameter: name: resourceGroupName in: path required: true type: string description: The name of the resource group. x-ms-parameter-location: method subscriptionId: in: path name: subscriptionId description: The Subscription ID. required: true type: string SubscriptionIdParameter: name: subscriptionId in: path required: true type: string description: The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000). regionId: type: string x-ms-parameter-location: method description: The region Id (westus, eastus) name: regionId in: path required: true api-version_2: type: string description: Client API version. name: api-version in: query required: true subscriptionId_2: type: string description: The subscription ID. name: subscriptionId in: path required: true x-ms-parameterized-host: hostTemplate: '{endpoint}' useSchemePrefix: false parameters: - $ref: '#/parameters/Endpoint'