Partilhar via


Virtual Machine Scale Set VMs - List

Obtém uma lista de todas as máquinas virtuais em um conjunto de dimensionamento de VM.

GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines?api-version=2024-07-01
GET https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines?$filter={$filter}&$select={$select}&$expand={$expand}&api-version=2024-07-01

Parâmetros do URI

Name Em Necessário Tipo Description
resourceGroupName
path True

string

O nome do grupo de recursos.

subscriptionId
path True

string

Credenciais de assinatura que identificam exclusivamente a assinatura do Microsoft Azure. O ID da assinatura faz parte do URI de cada chamada de serviço.

virtualMachineScaleSetName
path True

string

O nome do conjunto de escala de VM.

api-version
query True

string

Versão da API do cliente.

$expand
query

string

A expressão expand a ser aplicada à operação. Os valores permitidos são 'instanceView'.

$filter
query

string

O filtro a ser aplicado à operação. Os valores permitidos são 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'.

$select
query

string

Os parâmetros da lista. Os valores permitidos são 'instanceView', 'instanceView/statuses'.

Respostas

Name Tipo Description
200 OK

VirtualMachineScaleSetVMListResult

OK

Other Status Codes

CloudError

Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Azure Ative Directory OAuth2 Flow

Tipo: oauth2
Fluxo: implicit
URL de Autorização: https://login.microsoftonline.com/common/oauth2/authorize

Âmbitos

Name Description
user_impersonation personificar a sua conta de utilizador

Exemplos

VirtualMachineScaleSetVM_List_MaximumSet_Gen
VirtualMachineScaleSetVM_List_MinimumSet_Gen

VirtualMachineScaleSetVM_List_MaximumSet_Gen

Pedido de amostra

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaaaaaaaaa/virtualMachines?$filter=aaaaaaaaaaaaaa&$select=aaaaaaaaaaaaaaaaaaaaa&$expand=aaaaaaaaaaaaa&api-version=2024-07-01

Resposta da amostra

{
  "value": [
    {
      "name": "{vmss-vm-name}",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0",
      "type": "Microsoft.Compute/virtualMachines",
      "location": "westus",
      "tags": {},
      "properties": {
        "latestModelApplied": true,
        "modelDefinitionApplied": "VirtualMachineScaleSet",
        "networkProfileConfiguration": {
          "networkInterfaceConfigurations": [
            {
              "name": "vmsstestnetconfig5415",
              "properties": {
                "primary": true,
                "enableAcceleratedNetworking": true,
                "dnsSettings": {
                  "dnsServers": []
                },
                "enableIPForwarding": true,
                "ipConfigurations": [
                  {
                    "name": "vmsstestnetconfig9693",
                    "properties": {
                      "subnet": {
                        "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/vn4071/subnets/sn5503"
                      },
                      "privateIPAddressVersion": "IPv4",
                      "primary": true,
                      "publicIPAddressConfiguration": {
                        "name": "aaaaaaaaaaaaaaaaaa",
                        "properties": {
                          "idleTimeoutInMinutes": 18,
                          "dnsSettings": {
                            "domainNameLabel": "aaaaaaaaaaaaaaaaaa"
                          },
                          "ipTags": [
                            {
                              "ipTagType": "aaaaaaa",
                              "tag": "aaaaaaaaaaaaaaaaaaaaaaaaaaa"
                            }
                          ],
                          "publicIPPrefix": {
                            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                          },
                          "publicIPAddressVersion": "IPv4",
                          "deleteOption": "Delete"
                        },
                        "sku": {
                          "name": "Basic",
                          "tier": "Regional"
                        }
                      },
                      "applicationGatewayBackendAddressPools": [
                        {
                          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                        }
                      ],
                      "applicationSecurityGroups": [
                        {
                          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                        }
                      ],
                      "loadBalancerBackendAddressPools": [
                        {
                          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                        }
                      ],
                      "loadBalancerInboundNatPools": [
                        {
                          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                        }
                      ]
                    }
                  }
                ],
                "enableFpga": true,
                "networkSecurityGroup": {
                  "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                },
                "deleteOption": "Delete"
              }
            }
          ]
        },
        "vmId": "42af9fdf-b906-4ad7-9905-8316209ff619",
        "hardwareProfile": {
          "vmSize": "Basic_A0",
          "vmSizeProperties": {
            "vCPUsAvailable": 9,
            "vCPUsPerCore": 12
          }
        },
        "storageProfile": {
          "imageReference": {
            "publisher": "MicrosoftWindowsServer",
            "offer": "WindowsServer",
            "sku": "2012-R2-Datacenter",
            "version": "4.127.20180315",
            "exactVersion": "4.127.20180315",
            "sharedGalleryImageId": "aaaaaaaaaaaaaaaaaaaa",
            "id": "a"
          },
          "osDisk": {
            "osType": "Windows",
            "name": "vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc",
            "createOption": "FromImage",
            "caching": "None",
            "managedDisk": {
              "storageAccountType": "Standard_LRS",
              "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_OsDisk_1_6d72b805e50e4de6830303c5055077fc",
              "diskEncryptionSet": {
                "id": "aaaaaaaaaaaa"
              }
            },
            "diskSizeGB": 127,
            "encryptionSettings": {
              "diskEncryptionKey": {
                "secretUrl": "aaaaaaaa",
                "sourceVault": {
                  "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                }
              },
              "keyEncryptionKey": {
                "keyUrl": "aaaaaaaaaaaaaa",
                "sourceVault": {
                  "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                }
              },
              "enabled": true
            },
            "vhd": {
              "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
            },
            "image": {
              "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
            },
            "writeAcceleratorEnabled": true,
            "diffDiskSettings": {
              "option": "Local",
              "placement": "CacheDisk"
            },
            "deleteOption": "Delete"
          },
          "dataDisks": [
            {
              "lun": 1,
              "name": "vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
              "createOption": "Empty",
              "caching": "None",
              "managedDisk": {
                "storageAccountType": "Standard_LRS",
                "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/vmss3176_vmss3176_0_disk2_6c4f554bdafa49baa780eb2d128ff39d",
                "diskEncryptionSet": {
                  "id": "aaaaaaaaaaaa"
                }
              },
              "diskSizeGB": 128,
              "toBeDetached": true,
              "vhd": {
                "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
              },
              "image": {
                "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd"
              },
              "writeAcceleratorEnabled": true,
              "diskIOPSReadWrite": 18,
              "diskMBpsReadWrite": 29,
              "detachOption": "ForceDetach",
              "deleteOption": "Delete"
            }
          ]
        },
        "osProfile": {
          "computerName": "test000000",
          "adminUsername": "Foo12",
          "windowsConfiguration": {
            "provisionVMAgent": true,
            "enableAutomaticUpdates": true,
            "timeZone": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
            "additionalUnattendContent": [
              {
                "passName": "OobeSystem",
                "componentName": "Microsoft-Windows-Shell-Setup",
                "settingName": "AutoLogon",
                "content": "aaaaaaaaaaaaaaaaaaaa"
              }
            ],
            "patchSettings": {
              "patchMode": "Manual",
              "enableHotpatching": true,
              "assessmentMode": "ImageDefault"
            },
            "winRM": {
              "listeners": [
                {
                  "protocol": "Http",
                  "certificateUrl": "aaaaaaaaaaaaaaaaaaaaaa"
                }
              ]
            }
          },
          "secrets": [],
          "allowExtensionOperations": true,
          "requireGuestProvisionSignal": true,
          "customData": "aaaa",
          "linuxConfiguration": {
            "disablePasswordAuthentication": true,
            "ssh": {
              "publicKeys": [
                {
                  "path": "aaa",
                  "keyData": "aaaaaa"
                }
              ]
            },
            "provisionVMAgent": true,
            "patchSettings": {
              "patchMode": "ImageDefault",
              "assessmentMode": "ImageDefault"
            }
          }
        },
        "userData": "RXhhbXBsZSBVc2VyRGF0YQ==",
        "networkProfile": {
          "networkInterfaces": [
            {
              "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0/networkInterfaces/vmsstestnetconfig5415",
              "properties": {
                "primary": true,
                "deleteOption": "Delete"
              }
            }
          ],
          "networkApiVersion": "2020-11-01",
          "networkInterfaceConfigurations": [
            {
              "name": "aaaaaaaaaaa",
              "properties": {
                "primary": true,
                "deleteOption": "Delete",
                "enableAcceleratedNetworking": true,
                "enableFpga": true,
                "enableIPForwarding": true,
                "networkSecurityGroup": {
                  "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                },
                "dnsSettings": {
                  "dnsServers": [
                    "aaaaaa"
                  ]
                },
                "ipConfigurations": [
                  {
                    "name": "aa",
                    "properties": {
                      "subnet": {
                        "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                      },
                      "primary": true,
                      "publicIPAddressConfiguration": {
                        "name": "aaaaaaaaaaaaaaaaaaaaaaaaaaaaa",
                        "properties": {
                          "idleTimeoutInMinutes": 2,
                          "deleteOption": "Delete",
                          "dnsSettings": {
                            "domainNameLabel": "aaaaaaaaaaaaaaaaaaaaaaaaa"
                          },
                          "ipTags": [
                            {
                              "ipTagType": "aaaaaaaaaaaaaaaaaaaaaaaaa",
                              "tag": "aaaaaaaaaaaaaaaaaaaa"
                            }
                          ],
                          "publicIPPrefix": {
                            "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                          },
                          "publicIPAddressVersion": "IPv4",
                          "publicIPAllocationMethod": "Dynamic"
                        },
                        "sku": {
                          "name": "Basic",
                          "tier": "Regional"
                        }
                      },
                      "privateIPAddressVersion": "IPv4",
                      "applicationSecurityGroups": [
                        {
                          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                        }
                      ],
                      "applicationGatewayBackendAddressPools": [
                        {
                          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                        }
                      ],
                      "loadBalancerBackendAddressPools": [
                        {
                          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                        }
                      ]
                    }
                  }
                ],
                "dscpConfiguration": {
                  "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                }
              }
            }
          ]
        },
        "diagnosticsProfile": {
          "bootDiagnostics": {
            "enabled": true,
            "storageUri": "aaaaaaaaaaaaa"
          }
        },
        "provisioningState": "Succeeded",
        "instanceView": {
          "platformUpdateDomain": 23,
          "platformFaultDomain": 14,
          "rdpThumbPrint": "aaaaaaaaaaaaaaaaaaaaaaaaaaa",
          "vmAgent": {
            "vmAgentVersion": "aaaaaaaaaaaaaaaaaaaaaaa",
            "extensionHandlers": [
              {
                "type": "aaaaaaaaaaaaa",
                "typeHandlerVersion": "aaaaa",
                "status": {
                  "code": "aaaaaaaaaaaaaaaaaaaaaaa",
                  "level": "Info",
                  "displayStatus": "aaaaaa",
                  "message": "a",
                  "time": "2021-11-30T12:58:26.522Z"
                }
              }
            ],
            "statuses": [
              {
                "code": "aaaaaaaaaaaaaaaaaaaaaaa",
                "level": "Info",
                "displayStatus": "aaaaaa",
                "message": "a",
                "time": "2021-11-30T12:58:26.522Z"
              }
            ]
          },
          "maintenanceRedeployStatus": {
            "isCustomerInitiatedMaintenanceAllowed": true,
            "preMaintenanceWindowStartTime": "2021-11-30T12:58:26.531Z",
            "preMaintenanceWindowEndTime": "2021-11-30T12:58:26.531Z",
            "maintenanceWindowStartTime": "2021-11-30T12:58:26.531Z",
            "maintenanceWindowEndTime": "2021-11-30T12:58:26.531Z",
            "lastOperationResultCode": "None",
            "lastOperationMessage": "aaaaaa"
          },
          "disks": [
            {
              "name": "aaaaaaaaaaa",
              "encryptionSettings": [
                {
                  "diskEncryptionKey": {
                    "secretUrl": "aaaaaaaa",
                    "sourceVault": {
                      "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                    }
                  },
                  "keyEncryptionKey": {
                    "keyUrl": "aaaaaaaaaaaaaa",
                    "sourceVault": {
                      "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
                    }
                  },
                  "enabled": true
                }
              ],
              "statuses": [
                {
                  "code": "aaaaaaaaaaaaaaaaaaaaaaa",
                  "level": "Info",
                  "displayStatus": "aaaaaa",
                  "message": "a",
                  "time": "2021-11-30T12:58:26.522Z"
                }
              ]
            }
          ],
          "extensions": [
            {
              "name": "aaaaaaaaaaaaaaaaa",
              "type": "aaaaaaaaa",
              "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
              "substatuses": [
                {
                  "code": "aaaaaaaaaaaaaaaaaaaaaaa",
                  "level": "Info",
                  "displayStatus": "aaaaaa",
                  "message": "a",
                  "time": "2021-11-30T12:58:26.522Z"
                }
              ],
              "statuses": [
                {
                  "code": "aaaaaaaaaaaaaaaaaaaaaaa",
                  "level": "Info",
                  "displayStatus": "aaaaaa",
                  "message": "a",
                  "time": "2021-11-30T12:58:26.522Z"
                }
              ]
            }
          ],
          "vmHealth": {
            "status": {
              "code": "aaaaaaaaaaaaaaaaaaaaaaa",
              "level": "Info",
              "displayStatus": "aaaaaa",
              "message": "a",
              "time": "2021-11-30T12:58:26.522Z"
            }
          },
          "bootDiagnostics": {
            "consoleScreenshotBlobUri": "aaaaaaaaaaaaaaaaaaaaaaaaa",
            "serialConsoleLogBlobUri": "aaaaaaaa",
            "status": {
              "code": "aaaaaaaaaaaaaaaaaaaaaaa",
              "level": "Info",
              "displayStatus": "aaaaaa",
              "message": "a",
              "time": "2021-11-30T12:58:26.522Z"
            }
          },
          "statuses": [
            {
              "code": "aaaaaaaaaaaaaaaaaaaaaaa",
              "level": "Info",
              "displayStatus": "aaaaaa",
              "message": "a",
              "time": "2021-11-30T12:58:26.522Z"
            }
          ],
          "assignedHost": "aaaaaaa",
          "placementGroupId": "aaa"
        },
        "additionalCapabilities": {
          "ultraSSDEnabled": true,
          "hibernationEnabled": true
        },
        "securityProfile": {
          "uefiSettings": {
            "secureBootEnabled": true,
            "vTpmEnabled": true
          },
          "encryptionAtHost": true,
          "securityType": "TrustedLaunch"
        },
        "availabilitySet": {
          "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}"
        },
        "licenseType": "aaaaaaaaaa",
        "protectionPolicy": {
          "protectFromScaleIn": true,
          "protectFromScaleSetActions": true
        },
        "timeCreated": "2021-06-27T01:02:38.3138469+00:00"
      },
      "resources": [
        {
          "name": "CustomScriptExtension-DSC",
          "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC",
          "type": "Microsoft.Compute/virtualMachines/extensions",
          "location": "westus",
          "tags": {},
          "properties": {
            "autoUpgradeMinorVersion": true,
            "provisioningState": "Succeeded",
            "publisher": "Microsoft.Compute",
            "type": "CustomScriptExtension",
            "typeHandlerVersion": "1.9",
            "settings": {},
            "forceUpdateTag": "aaaaaaa",
            "enableAutomaticUpgrade": true,
            "protectedSettings": {},
            "instanceView": {
              "name": "aaaaaaaaaaaaaaaaa",
              "type": "aaaaaaaaa",
              "typeHandlerVersion": "aaaaaaaaaaaaaaaaaaaaaaaaaa",
              "substatuses": [
                {
                  "code": "aaaaaaaaaaaaaaaaaaaaaaa",
                  "level": "Info",
                  "displayStatus": "aaaaaa",
                  "message": "a",
                  "time": "2021-11-30T12:58:26.522Z"
                }
              ],
              "statuses": [
                {
                  "code": "aaaaaaaaaaaaaaaaaaaaaaa",
                  "level": "Info",
                  "displayStatus": "aaaaaa",
                  "message": "a",
                  "time": "2021-11-30T12:58:26.522Z"
                }
              ]
            },
            "suppressFailures": true
          }
        }
      ],
      "instanceId": "aaaaaaaaaaaa",
      "sku": {
        "name": "Classic",
        "tier": "aaaaaaaaaaaaaa",
        "capacity": 29
      },
      "plan": {
        "name": "aaaaaaaaaa",
        "publisher": "aaaaaaaaaaaaaaaaaaaaaa",
        "product": "aaaaaaaaaaaaaaaaaaaa",
        "promotionCode": "aaaaaaaaaaaaaaaaaaaa"
      },
      "zones": [
        "a"
      ]
    }
  ],
  "nextLink": "aaaaaaaaaaaaaa"
}

VirtualMachineScaleSetVM_List_MinimumSet_Gen

Pedido de amostra

GET https://management.azure.com/subscriptions/{subscription-id}/resourceGroups/rgcompute/providers/Microsoft.Compute/virtualMachineScaleSets/aaaaaaaaaaaaaaaaaaaaaaaaaaaa/virtualMachines?api-version=2024-07-01

Resposta da amostra

{
  "value": [
    {
      "location": "westus",
      "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}/virtualMachines/0"
    }
  ]
}

Definições

Name Description
AdditionalCapabilities

Especifica recursos adicionais habilitados ou desabilitados na máquina virtual no conjunto de escala. Por exemplo: se a máquina virtual tem a capacidade de suportar a anexação de discos de dados gerenciados com UltraSSD_LRS tipo de conta de armazenamento.

AdditionalUnattendContent

Especifica informações adicionais formatadas em XML codificadas em base 64 que podem ser incluídas no arquivo Unattend.xml, que é usado pela Instalação do Windows.

ApiEntityReference

O identificador do recurso de origem. Pode ser um instantâneo ou um ponto de restauração de disco a partir do qual criar um disco.

ApiError

Erro de api.

ApiErrorBase

Base de erro da api.

BootDiagnostics

O Diagnóstico de Inicialização é um recurso de depuração que permite visualizar a saída do console e a captura de tela para diagnosticar o status da VM. NOTA: Se storageUri estiver sendo especificado, verifique se a conta de armazenamento está na mesma região e assinatura que a VM. Você pode visualizar facilmente a saída do log do console. O Azure também permite que você veja uma captura de tela da VM do hipervisor.

BootDiagnosticsInstanceView

O Diagnóstico de Inicialização é um recurso de depuração que permite visualizar a saída do console e a captura de tela para diagnosticar o status da VM. Você pode visualizar facilmente a saída do log do console. O Azure também permite que você veja uma captura de tela da VM do hipervisor.

CachingTypes

Especifica os requisitos de cache. Os valores possíveis são: None,ReadOnlyReadWrite. O comportamento padrão é: Nenhum para armazenamento padrão. ReadOnly para armazenamento Premium.

CloudError

Uma resposta de erro do serviço de computação.

ComponentNames

O nome do componente. Atualmente, o único valor permitido é Microsoft-Windows-Shell-Setup.

DataDisk

Especifica os parâmetros que são usados para adicionar um disco de dados a uma máquina virtual. Para obter mais informações sobre discos, consulte Sobre discos e VHDs para máquinas virtuais do Azure.

DeleteOptions

Especificar o que acontece com a interface de rede quando a VM é excluída

DiagnosticsProfile

Especifica o estado das configurações de diagnóstico de inicialização. Versão mínima da api: 2015-06-15.

DiffDiskOptions

Especifica as configurações de disco efêmero para o disco do sistema operacional.

DiffDiskPlacement

Especifica o posicionamento efêmero do disco do sistema operacional. Os valores possíveis são: CacheDisk,ResourceDiskNvmeDisk. O comportamento padrão é: CacheDisk se um estiver configurado para o tamanho da VM, caso contrário, ResourceDisk ou NvmeDisk for usado. Consulte a documentação de tamanho de VM para VM do Windows em https://docs.microsoft.com/azure/virtual-machines/windows/sizes e VM do Linux em https://docs.microsoft.com/azure/virtual-machines/linux/sizes para verificar quais tamanhos de VM expõem um disco de cache. Versão mínima da api para NvmeDisk: 2024-03-01.

DiffDiskSettings

Especifica as configurações de disco efêmeras para o disco do sistema operacional usado pela máquina virtual.

DiskControllerTypes

Especifica o tipo de controlador de disco configurado para a VM. Nota: Esta propriedade será definida como o tipo de controlador de disco padrão se não for especificada, desde que a máquina virtual esteja sendo criada com 'hyperVGeneration' definido como V2 com base nos recursos do disco do sistema operacional e no tamanho da VM da versão mínima de api especificada. Você precisa desalocar a VM antes de atualizar seu tipo de controlador de disco, a menos que esteja atualizando o tamanho da VM na configuração da VM que implicitamente desaloca e realoca a VM. Versão mínima da api: 2022-08-01.

DiskCreateOptionTypes

Especifica como o disco da máquina virtual deve ser criado. Os valores possíveis são Anexar: Esse valor é usado quando você estiver usando um disco especializado para criar a máquina virtual. FromImage: Esse valor é usado quando você está usando uma imagem para criar a máquina virtual. Se você estiver usando uma imagem de plataforma, também deverá usar o elemento imageReference descrito acima. Se você estiver usando uma imagem de marketplace, também deverá usar o elemento de plano descrito anteriormente.

DiskDeleteOptionTypes

Especifica se o disco do sistema operacional deve ser excluído ou desanexado após a exclusão da VM. Os valores possíveis são: Delete. Se esse valor for usado, o disco do sistema operacional será excluído quando a VM for excluída. Destacar. Se esse valor for usado, o disco do sistema operacional será retido após a VM ser excluída. O valor padrão é definido como Desanexar. Para um disco de sistema operacional efêmero, o valor padrão é definido como Delete. O usuário não pode alterar a opção de exclusão para um disco de sistema operacional efêmero.

DiskDetachOptionTypes

Especifica o comportamento de desanexação a ser usado durante a desanexação de um disco ou que já está em processo de desanexação da máquina virtual. Valores suportados: ForceDetach. detachOption: ForceDetach é aplicável apenas para discos de dados gerenciados. Se uma tentativa anterior de desanexação do disco de dados não foi concluída devido a uma falha inesperada da máquina virtual e o disco ainda não foi liberado, use force-detach como uma opção de último recurso para desanexar o disco à força da VM. Todas as gravações podem não ter sido liberadas ao usar esse comportamento de desanexação. Para forçar a desanexação de uma atualização de disco de dados toBeDetached para 'true' junto com a configuração detachOption: 'ForceDetach'.

DiskEncryptionSetParameters

Especifica a id do recurso do conjunto de criptografia de disco gerenciado pelo cliente para o disco gerenciado.

DiskEncryptionSettings

Especifica as configurações de criptografia para o disco do sistema operacional.

Versão mínima da api: 2015-06-15

DiskInstanceView

As informações dos discos.

DomainNameLabelScopeTypes

O escopo do rótulo de nome de domínio dos recursos PublicIPAddress que serão criados. O rótulo de nome gerado é a concatenação do rótulo de nome de domínio com hash com a política de acordo com o escopo do rótulo do nome de domínio e o ID exclusivo do perfil de rede vm.

EncryptionIdentity

Especifica a Identidade Gerenciada usada pelo ADE para obter o token de acesso para operações keyvault.

HardwareProfile

Especifica as configurações de hardware para a máquina virtual.

HyperVGeneration

A geração do hipervisor da Máquina Virtual [V1, V2]

ImageReference

Especifica informações sobre a imagem a ser usada. Você pode especificar informações sobre imagens de plataforma, imagens de mercado ou imagens de máquina virtual. Esse elemento é necessário quando você deseja usar uma imagem de plataforma, imagem de mercado ou imagem de máquina virtual, mas não é usado em outras operações de criação.

InnerError

Detalhes do erro interno.

InstanceViewStatus

Status da exibição da instância.

IPVersion

Disponível a partir de Api-Version 2019-07-01, representa se a configuração ip específica é IPv4 ou IPv6. O padrão é considerado IPv4. Os valores possíveis são: 'IPv4' e 'IPv6'.

IPVersions

Disponível a partir de Api-Version 2019-07-01, representa se a configuração ip específica é IPv4 ou IPv6. O padrão é considerado IPv4. Os valores possíveis são: 'IPv4' e 'IPv6'.

KeyVaultKeyReference

Especifica o local da chave de criptografia de chave no Cofre da Chave.

KeyVaultSecretReference

As extensões protegem as configurações que são passadas por referência e consumidas do cofre de chaves

LinuxConfiguration

Especifica as configurações do sistema operacional Linux na máquina virtual. Para obter uma lista de distribuições Linux suportadas, consulte Linux on Azure-Endorsed Distributions.

LinuxPatchAssessmentMode

Especifica o modo de Avaliação de Patch de Convidado de VM para a máquina virtual IaaS.

Os valores possíveis são:

ImageDefault - Você controla o tempo das avaliações de patch em uma máquina virtual.

AutomaticByPlatform - A plataforma acionará avaliações periódicas de patches. A provisão de propriedadeVMAgent deve ser true.

LinuxPatchSettings

[Funcionalidade de pré-visualização] Especifica as configurações relacionadas ao Patch de convidado de VM no Linux.

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Especifica a configuração de reinicialização para todas as operações de instalação do patch AutomaticByPlatform.

LinuxVMGuestPatchAutomaticByPlatformSettings

Especifica configurações adicionais para o modo de patch AutomaticByPlatform no VM Guest Patching no Linux.

LinuxVMGuestPatchMode

Especifica o modo de aplicação de patches de convidado de VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquina virtual com OrchestrationMode como flexível.

Os valores possíveis são:

ImageDefault - A configuração de patch padrão da máquina virtual é usada.

AutomaticByPlatform - A máquina virtual será atualizada automaticamente pela plataforma. A provisão de propriedadeVMAgent deve ser true

MaintenanceOperationResultCodeTypes

O código do resultado da última operação de manutenção.

MaintenanceRedeployStatus

O status da Operação de Manutenção na máquina virtual.

ManagedDiskParameters

Os parâmetros do disco gerenciado.

Mode

Especifica o modo em que o ProxyAgent será executado se o recurso estiver habilitado. O ProxyAgent começará a auditar ou monitorar, mas não a impor o controle de acesso sobre solicitações para hospedar pontos de extremidade no modo de Auditoria, enquanto no modo Enforce ele imporá o controle de acesso. O valor padrão é Enforce mode.

NetworkApiVersion

especifica a versão da API Microsoft.Network usada ao criar recursos de rede nas Configurações da Interface de Rede

NetworkInterfaceAuxiliaryMode

Especifica se o modo Auxiliar está habilitado para o recurso Interface de Rede.

NetworkInterfaceAuxiliarySku

Especifica se a sku Auxiliar está habilitada para o recurso Interface de Rede.

NetworkInterfaceReference

Especifica a lista de IDs de recursos para as interfaces de rede associadas à máquina virtual.

NetworkProfile

Especifica as interfaces de rede da máquina virtual.

OperatingSystemTypes

O tipo de sistema operacional.

OSDisk

Especifica informações sobre o disco do sistema operacional usado pela máquina virtual. Para obter mais informações sobre discos, consulte Sobre discos e VHDs para máquinas virtuais do Azure.

OSProfile

Especifica as configurações do sistema operacional para a máquina virtual.

PassNames

O nome do passe. Atualmente, o único valor permitido é OobeSystem.

PatchSettings

[Funcionalidade de pré-visualização] Especifica as configurações relacionadas ao patch de convidado de VM no Windows.

Plan

Especifica informações sobre a imagem do marketplace usada para criar a máquina virtual. Este elemento é usado apenas para imagens do mercado. Antes de poder usar uma imagem de mercado de uma API, você deve habilitar a imagem para uso programático. No portal do Azure, localize a imagem do marketplace que pretende utilizar e, em seguida, clique em Pretende implementar programaticamente, Introdução ->. Introduza todas as informações necessárias e, em seguida, clique em Guardar.

ProtocolTypes

Especifica o protocolo do ouvinte do WinRM. Os valores possíveis são: httphttps.

ProxyAgentSettings

Especifica as configurações do ProxyAgent ao criar a máquina virtual. Versão mínima da api: 2023-09-01.

PublicIPAddressSku

Descreve o IP público Sku. Ele só pode ser definido com OrchestrationMode como flexível.

PublicIPAddressSkuName

Especificar nome de sku IP público

PublicIPAddressSkuTier

Especificar camada de sku IP público

PublicIPAllocationMethod

Especificar o tipo de alocação de IP público

ResourceIdentityType

O tipo de identidade usado para a máquina virtual. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades da máquina virtual.

securityEncryptionTypes

Especifica o EncryptionType do disco gerenciado. Ele é definido como DiskWithVMGuestState para criptografia do disco gerenciado junto com o blob VMGuestState, VMGuestStateOnly para criptografia apenas do blob VMGuestState e NonPersistedTPM para não persistir o estado do firmware no blob VMGuestState. Nota: Ele pode ser definido apenas para VMs confidenciais.

SecurityProfile

Especifica as configurações de perfil relacionadas à segurança para a máquina virtual.

SecurityTypes

Especifica o SecurityType da máquina virtual. Ele deve ser definido como qualquer valor especificado para habilitar UefiSettings. O comportamento padrão é: UefiSettings não será habilitado a menos que essa propriedade esteja definida.

SettingNames

Especifica o nome da configuração à qual o conteúdo se aplica. Os valores possíveis são: FirstLogonCommands e AutoLogon.

Sku

A máquina virtual SKU.

SshConfiguration

Especifica a configuração da chave ssh para um sistema operacional Linux.

SshPublicKey

A lista de chaves públicas SSH usadas para autenticar com VMs baseadas em linux.

StatusLevelTypes

O código de nível.

StorageAccountTypes

Especifica o tipo de conta de armazenamento para o disco gerenciado. NOTA: UltraSSD_LRS só pode ser utilizado com discos de dados, não pode ser utilizado com o OS Disk.

StorageProfile

Especifica as configurações de armazenamento para os discos da máquina virtual.

SubResource

O URL relativo do Cofre da Chave que contém o segredo.

UefiSettings

Especifica as configurações de segurança, como inicialização segura e vTPM, usadas durante a criação da máquina virtual. Versão api mínima: 2020-12-01.

UserAssignedIdentities

A lista de identidades de usuário associadas à máquina virtual. As referências de chave do dicionário de identidade do usuário serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

VaultCertificate

A lista de referências do cofre de chaves no SourceVault que contêm certificados.

VaultSecretGroup

Especifica o conjunto de certificados que devem ser instalados na máquina virtual. Para instalar certificados em uma máquina virtual, é recomendável usar a extensão de máquina virtual do Azure Key Vault para Linux ou a extensão de máquina virtual do Azure Key Vault para Windows.

VirtualHardDisk

O disco rígido virtual.

VirtualMachineAgentInstanceView

O Agente de VM em execução na máquina virtual.

VirtualMachineExtension

Os recursos de extensão filho da máquina virtual.

VirtualMachineExtensionHandlerInstanceView

A exibição da instância do manipulador de extensão de máquina virtual.

VirtualMachineExtensionInstanceView

A exibição da instância de extensão de máquina virtual.

VirtualMachineHealthStatus

O status de integridade da VM.

VirtualMachineIdentity

A identidade da máquina virtual, se configurada.

VirtualMachineIpTag

A lista de tags IP associadas ao endereço IP público.

VirtualMachineNetworkInterfaceConfiguration

Especifica as configurações de rede que serão usadas para criar os recursos de rede da máquina virtual.

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

As configurações de dns a serem aplicadas nas interfaces de rede.

VirtualMachineNetworkInterfaceIPConfiguration

Especifica as configurações IP da interface de rede.

VirtualMachinePublicIPAddressConfiguration

O publicIPAddressConfiguration.

VirtualMachinePublicIPAddressDnsSettingsConfiguration

As configurações de dns a serem aplicadas nos endereços IP públicos.

VirtualMachineScaleSetIPConfiguration

Especifica as configurações IP da interface de rede.

VirtualMachineScaleSetIpTag

A lista de tags IP associadas ao endereço IP público.

VirtualMachineScaleSetNetworkConfiguration

A lista de configurações de rede.

VirtualMachineScaleSetNetworkConfigurationDnsSettings

As configurações de dns a serem aplicadas nas interfaces de rede.

VirtualMachineScaleSetPublicIPAddressConfiguration

O publicIPAddressConfiguration.

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

As configurações de dns a serem aplicadas nos endereços IP públicos.

VirtualMachineScaleSetVM

A lista de dimensionamento de máquina virtual define VMs.

VirtualMachineScaleSetVMInstanceView

A exibição da instância da máquina virtual.

VirtualMachineScaleSetVMListResult

A resposta de operação Listar Conjunto de Dimensionamento de Máquina Virtual VMs.

VirtualMachineScaleSetVMNetworkProfileConfiguration

Especifica a configuração do perfil de rede da máquina virtual.

VirtualMachineScaleSetVMProtectionPolicy

Especifica a política de proteção da máquina virtual.

VirtualMachineSizeTypes

Especifica o tamanho da máquina virtual. O tipo de dados enum está atualmente preterido e será removido até 23 de dezembro de 2023. A maneira recomendada de obter a lista de tamanhos disponíveis é usando estas APIs: Listar todos os tamanhos de máquina virtual disponíveis em um conjunto de disponibilidade, Listar todos os tamanhos de máquina virtual disponíveis em uma regiãoListar todos os tamanhos de máquina virtual disponíveis para redimensionamento. Para obter mais informações sobre tamanhos de máquinas virtuais, consulte tamanhos para máquinas virtuais. Os tamanhos de VM disponíveis dependem da região e do conjunto de disponibilidade.

VMDiskSecurityProfile

Especifica o perfil de segurança para o disco gerenciado.

VMSizeProperties

Especifica as propriedades para personalizar o tamanho da máquina virtual. Versão mínima api: 2021-07-01. Esse recurso ainda está no modo de visualização e não é suportado para VirtualMachineScaleSet. Siga as instruções em de personalização de VM para obter mais detalhes.

WindowsConfiguration

Especifica as configurações do sistema operacional Windows na máquina virtual.

WindowsPatchAssessmentMode

Especifica o modo de avaliação de patch do convidado da VM para a máquina virtual IaaS.

Os valores possíveis são:

ImageDefault - Você controla o tempo das avaliações de patch em uma máquina virtual.

AutomaticByPlatform - A plataforma acionará avaliações periódicas de patches. A provisão de propriedadeVMAgent deve ser true.

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Especifica a configuração de reinicialização para todas as operações de instalação do patch AutomaticByPlatform.

WindowsVMGuestPatchAutomaticByPlatformSettings

Especifica configurações adicionais para o modo de patch AutomaticByPlatform no VM Guest Patching no Windows.

WindowsVMGuestPatchMode

Especifica o modo de aplicação de patches de convidado de VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquina virtual com OrchestrationMode como flexível.

Os valores possíveis são:

Manual - Você controla a aplicação de patches em uma máquina virtual. Para fazer isso, aplique patches manualmente dentro da VM. Neste modo, as atualizações automáticas são desativadas; a propriedade WindowsConfiguration.enableAutomaticUpdates deve ser false

AutomaticByOS - A máquina virtual será atualizada automaticamente pelo SO. A propriedade WindowsConfiguration.enableAutomaticUpdates deve ser true.

AutomaticByPlatform - a máquina virtual será atualizada automaticamente pela plataforma. As propriedades provisionVMAgent e WindowsConfiguration.enableAutomaticUpdates devem ser true

WinRMConfiguration

Especifica os ouvintes do Gerenciamento Remoto do Windows. Isso habilita o Windows PowerShell remoto.

WinRMListener

A lista de ouvintes do Gerenciamento Remoto do Windows

AdditionalCapabilities

Especifica recursos adicionais habilitados ou desabilitados na máquina virtual no conjunto de escala. Por exemplo: se a máquina virtual tem a capacidade de suportar a anexação de discos de dados gerenciados com UltraSSD_LRS tipo de conta de armazenamento.

Name Tipo Description
hibernationEnabled

boolean

O sinalizador que habilita ou desabilita a capacidade de hibernação na VM.

ultraSSDEnabled

boolean

O sinalizador que habilita ou desabilita um recurso para ter um ou mais discos de dados gerenciados com UltraSSD_LRS tipo de conta de armazenamento na VM ou VMSS. Os discos gerenciados com UltraSSD_LRS tipo de conta de armazenamento podem ser adicionados a uma máquina virtual ou a um conjunto de dimensionamento de máquina virtual somente se essa propriedade estiver habilitada.

AdditionalUnattendContent

Especifica informações adicionais formatadas em XML codificadas em base 64 que podem ser incluídas no arquivo Unattend.xml, que é usado pela Instalação do Windows.

Name Tipo Description
componentName

ComponentNames

O nome do componente. Atualmente, o único valor permitido é Microsoft-Windows-Shell-Setup.

content

string

Especifica o conteúdo formatado em XML que é adicionado ao arquivo de unattend.xml para o caminho e o componente especificados. O XML deve ter menos de 4KB e deve incluir o elemento raiz para a configuração ou recurso que está sendo inserido.

passName

PassNames

O nome do passe. Atualmente, o único valor permitido é OobeSystem.

settingName

SettingNames

Especifica o nome da configuração à qual o conteúdo se aplica. Os valores possíveis são: FirstLogonCommands e AutoLogon.

ApiEntityReference

O identificador do recurso de origem. Pode ser um instantâneo ou um ponto de restauração de disco a partir do qual criar um disco.

Name Tipo Description
id

string

A ID do recurso ARM na forma de /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/...

ApiError

Erro de api.

Name Tipo Description
code

string

O código de erro.

details

ApiErrorBase[]

Os detalhes do erro Api

innererror

InnerError

O erro interno da Api

message

string

A mensagem de erro.

target

string

O alvo do erro específico.

ApiErrorBase

Base de erro da api.

Name Tipo Description
code

string

O código de erro.

message

string

A mensagem de erro.

target

string

O alvo do erro específico.

BootDiagnostics

O Diagnóstico de Inicialização é um recurso de depuração que permite visualizar a saída do console e a captura de tela para diagnosticar o status da VM. NOTA: Se storageUri estiver sendo especificado, verifique se a conta de armazenamento está na mesma região e assinatura que a VM. Você pode visualizar facilmente a saída do log do console. O Azure também permite que você veja uma captura de tela da VM do hipervisor.

Name Tipo Description
enabled

boolean

Se o diagnóstico de inicialização deve ser habilitado na máquina virtual.

storageUri

string

Uri da conta de armazenamento a ser usada para colocar a saída do console e a captura de tela. Se storageUri não for especificado ao habilitar o diagnóstico de inicialização, o armazenamento gerenciado será usado.

BootDiagnosticsInstanceView

O Diagnóstico de Inicialização é um recurso de depuração que permite visualizar a saída do console e a captura de tela para diagnosticar o status da VM. Você pode visualizar facilmente a saída do log do console. O Azure também permite que você veja uma captura de tela da VM do hipervisor.

Name Tipo Description
consoleScreenshotBlobUri

string

O URI de blob da captura de tela do console. Nota: Isso não será definido se o diagnóstico de inicialização estiver atualmente habilitado com armazenamento gerenciado.

serialConsoleLogBlobUri

string

O Uri do blob de log do console serial. Nota: Isso não será definido se o diagnóstico de inicialização estiver atualmente habilitado com armazenamento gerenciado.

status

InstanceViewStatus

As informações de status do diagnóstico de inicialização para a VM. Nota: Ele será definido somente se houver erros encontrados na ativação do diagnóstico de inicialização.

CachingTypes

Especifica os requisitos de cache. Os valores possíveis são: None,ReadOnlyReadWrite. O comportamento padrão é: Nenhum para armazenamento padrão. ReadOnly para armazenamento Premium.

Name Tipo Description
None

string

ReadOnly

string

ReadWrite

string

CloudError

Uma resposta de erro do serviço de computação.

Name Tipo Description
error

ApiError

Erro de api.

ComponentNames

O nome do componente. Atualmente, o único valor permitido é Microsoft-Windows-Shell-Setup.

Name Tipo Description
Microsoft-Windows-Shell-Setup

string

DataDisk

Especifica os parâmetros que são usados para adicionar um disco de dados a uma máquina virtual. Para obter mais informações sobre discos, consulte Sobre discos e VHDs para máquinas virtuais do Azure.

Name Tipo Description
caching

CachingTypes

Especifica os requisitos de cache. Os valores possíveis são: None,ReadOnlyReadWrite. O comportamento padrão é: Nenhum para armazenamento padrão. ReadOnly para armazenamento Premium.

createOption

DiskCreateOptionTypes

Especifica como o disco da máquina virtual deve ser criado. Os valores possíveis são Anexar: Esse valor é usado quando você estiver usando um disco especializado para criar a máquina virtual. FromImage: Esse valor é usado quando você está usando uma imagem para criar o disco de dados da máquina virtual. Se você estiver usando uma imagem de plataforma, também deverá usar o elemento imageReference descrito acima. Se você estiver usando uma imagem de marketplace, também deverá usar o elemento de plano descrito anteriormente. Vazio: Este valor é usado ao criar um disco de dados vazio. Copy: Este valor é usado para criar um disco de dados a partir de um instantâneo ou outro disco. Restauração: Este valor é usado para criar um disco de dados a partir de um ponto de restauração de disco.

deleteOption

DiskDeleteOptionTypes

Especifica se o disco de dados deve ser excluído ou desanexado após a exclusão da VM. Os valores possíveis são: Delete. Se esse valor for usado, o disco de dados será excluído quando a VM for excluída. Destacar. Se esse valor for usado, o disco de dados será retido após a VM ser excluída. O valor padrão é definido como Desanexar.

detachOption

DiskDetachOptionTypes

Especifica o comportamento de desanexação a ser usado durante a desanexação de um disco ou que já está em processo de desanexação da máquina virtual. Valores suportados: ForceDetach. detachOption: ForceDetach é aplicável apenas para discos de dados gerenciados. Se uma tentativa anterior de desanexação do disco de dados não foi concluída devido a uma falha inesperada da máquina virtual e o disco ainda não foi liberado, use force-detach como uma opção de último recurso para desanexar o disco à força da VM. Todas as gravações podem não ter sido liberadas ao usar esse comportamento de desanexação. Para forçar a desanexação de uma atualização de disco de dados toBeDetached para 'true' junto com a configuração detachOption: 'ForceDetach'.

diskIOPSReadWrite

integer

Especifica as IOPS Read-Write para o disco gerenciado quando StorageAccountType é UltraSSD_LRS. Retornado somente para discos de VM do VirtualMachine ScaleSet. Pode ser atualizado somente por meio de atualizações para o VirtualMachine Scale set.

diskMBpsReadWrite

integer

Especifica a largura de banda em MB por segundo para o disco gerenciado quando StorageAccountType é UltraSSD_LRS. Retornado somente para discos de VM do VirtualMachine ScaleSet. Pode ser atualizado somente por meio de atualizações para o VirtualMachine Scale set.

diskSizeGB

integer

Especifica o tamanho de um disco de dados vazio em gigabytes. Esse elemento pode ser usado para substituir o tamanho do disco em uma imagem de máquina virtual. A propriedade 'diskSizeGB' é o número de bytes x 1024^3 para o disco e o valor não pode ser maior que 1023.

image

VirtualHardDisk

O disco rígido virtual de imagem do usuário de origem. O disco rígido virtual será copiado antes de ser anexado à máquina virtual. Se SourceImage for fornecido, o disco rígido virtual de destino não deve existir.

lun

integer

Especifica o número da unidade lógica do disco de dados. Esse valor é usado para identificar discos de dados dentro da VM e, portanto, deve ser exclusivo para cada disco de dados conectado a uma VM.

managedDisk

ManagedDiskParameters

Os parâmetros do disco gerenciado.

name

string

O nome do disco.

sourceResource

ApiEntityReference

O identificador do recurso de origem. Pode ser um instantâneo ou um ponto de restauração de disco a partir do qual criar um disco.

toBeDetached

boolean

Especifica se o disco de dados está em processo de desanexação do VirtualMachine/VirtualMachineScaleset

vhd

VirtualHardDisk

O disco rígido virtual.

writeAcceleratorEnabled

boolean

Especifica se writeAccelerator deve ser habilitado ou desabilitado no disco.

DeleteOptions

Especificar o que acontece com a interface de rede quando a VM é excluída

Name Tipo Description
Delete

string

Detach

string

DiagnosticsProfile

Especifica o estado das configurações de diagnóstico de inicialização. Versão mínima da api: 2015-06-15.

Name Tipo Description
bootDiagnostics

BootDiagnostics

O Diagnóstico de Inicialização é um recurso de depuração que permite visualizar a saída do console e a captura de tela para diagnosticar o status da VM. NOTA: Se storageUri estiver sendo especificado, verifique se a conta de armazenamento está na mesma região e assinatura que a VM. Você pode visualizar facilmente a saída do log do console. O Azure também permite que você veja uma captura de tela da VM do hipervisor.

DiffDiskOptions

Especifica as configurações de disco efêmero para o disco do sistema operacional.

Name Tipo Description
Local

string

DiffDiskPlacement

Especifica o posicionamento efêmero do disco do sistema operacional. Os valores possíveis são: CacheDisk,ResourceDiskNvmeDisk. O comportamento padrão é: CacheDisk se um estiver configurado para o tamanho da VM, caso contrário, ResourceDisk ou NvmeDisk for usado. Consulte a documentação de tamanho de VM para VM do Windows em https://docs.microsoft.com/azure/virtual-machines/windows/sizes e VM do Linux em https://docs.microsoft.com/azure/virtual-machines/linux/sizes para verificar quais tamanhos de VM expõem um disco de cache. Versão mínima da api para NvmeDisk: 2024-03-01.

Name Tipo Description
CacheDisk

string

NvmeDisk

string

ResourceDisk

string

DiffDiskSettings

Especifica as configurações de disco efêmeras para o disco do sistema operacional usado pela máquina virtual.

Name Tipo Description
option

DiffDiskOptions

Especifica as configurações de disco efêmero para o disco do sistema operacional.

placement

DiffDiskPlacement

Especifica o posicionamento efêmero do disco do sistema operacional. Os valores possíveis são: CacheDisk,ResourceDiskNvmeDisk. O comportamento padrão é: CacheDisk se um estiver configurado para o tamanho da VM, caso contrário, ResourceDisk ou NvmeDisk for usado. Consulte a documentação de tamanho de VM para VM do Windows em https://docs.microsoft.com/azure/virtual-machines/windows/sizes e VM do Linux em https://docs.microsoft.com/azure/virtual-machines/linux/sizes para verificar quais tamanhos de VM expõem um disco de cache. Versão mínima da api para NvmeDisk: 2024-03-01.

DiskControllerTypes

Especifica o tipo de controlador de disco configurado para a VM. Nota: Esta propriedade será definida como o tipo de controlador de disco padrão se não for especificada, desde que a máquina virtual esteja sendo criada com 'hyperVGeneration' definido como V2 com base nos recursos do disco do sistema operacional e no tamanho da VM da versão mínima de api especificada. Você precisa desalocar a VM antes de atualizar seu tipo de controlador de disco, a menos que esteja atualizando o tamanho da VM na configuração da VM que implicitamente desaloca e realoca a VM. Versão mínima da api: 2022-08-01.

Name Tipo Description
NVMe

string

SCSI

string

DiskCreateOptionTypes

Especifica como o disco da máquina virtual deve ser criado. Os valores possíveis são Anexar: Esse valor é usado quando você estiver usando um disco especializado para criar a máquina virtual. FromImage: Esse valor é usado quando você está usando uma imagem para criar a máquina virtual. Se você estiver usando uma imagem de plataforma, também deverá usar o elemento imageReference descrito acima. Se você estiver usando uma imagem de marketplace, também deverá usar o elemento de plano descrito anteriormente.

Name Tipo Description
Attach

string

Copy

string

Empty

string

FromImage

string

Restore

string

DiskDeleteOptionTypes

Especifica se o disco do sistema operacional deve ser excluído ou desanexado após a exclusão da VM. Os valores possíveis são: Delete. Se esse valor for usado, o disco do sistema operacional será excluído quando a VM for excluída. Destacar. Se esse valor for usado, o disco do sistema operacional será retido após a VM ser excluída. O valor padrão é definido como Desanexar. Para um disco de sistema operacional efêmero, o valor padrão é definido como Delete. O usuário não pode alterar a opção de exclusão para um disco de sistema operacional efêmero.

Name Tipo Description
Delete

string

Detach

string

DiskDetachOptionTypes

Especifica o comportamento de desanexação a ser usado durante a desanexação de um disco ou que já está em processo de desanexação da máquina virtual. Valores suportados: ForceDetach. detachOption: ForceDetach é aplicável apenas para discos de dados gerenciados. Se uma tentativa anterior de desanexação do disco de dados não foi concluída devido a uma falha inesperada da máquina virtual e o disco ainda não foi liberado, use force-detach como uma opção de último recurso para desanexar o disco à força da VM. Todas as gravações podem não ter sido liberadas ao usar esse comportamento de desanexação. Para forçar a desanexação de uma atualização de disco de dados toBeDetached para 'true' junto com a configuração detachOption: 'ForceDetach'.

Name Tipo Description
ForceDetach

string

DiskEncryptionSetParameters

Especifica a id do recurso do conjunto de criptografia de disco gerenciado pelo cliente para o disco gerenciado.

Name Tipo Description
id

string

ID do recurso

DiskEncryptionSettings

Especifica as configurações de criptografia para o disco do sistema operacional.

Versão mínima da api: 2015-06-15

Name Tipo Description
diskEncryptionKey

KeyVaultSecretReference

Especifica o local da chave de criptografia de disco, que é um segredo do Cofre da Chave.

enabled

boolean

Especifica se a criptografia de disco deve ser habilitada na máquina virtual.

keyEncryptionKey

KeyVaultKeyReference

Especifica o local da chave de criptografia de chave no Cofre da Chave.

DiskInstanceView

As informações dos discos.

Name Tipo Description
encryptionSettings

DiskEncryptionSettings[]

Especifica as configurações de criptografia para o disco do sistema operacional.

Versão mínima da api: 2015-06-15

name

string

O nome do disco.

statuses

InstanceViewStatus[]

As informações de status do recurso.

DomainNameLabelScopeTypes

O escopo do rótulo de nome de domínio dos recursos PublicIPAddress que serão criados. O rótulo de nome gerado é a concatenação do rótulo de nome de domínio com hash com a política de acordo com o escopo do rótulo do nome de domínio e o ID exclusivo do perfil de rede vm.

Name Tipo Description
NoReuse

string

ResourceGroupReuse

string

SubscriptionReuse

string

TenantReuse

string

EncryptionIdentity

Especifica a Identidade Gerenciada usada pelo ADE para obter o token de acesso para operações keyvault.

Name Tipo Description
userAssignedIdentityResourceId

string

Especifica a ID de recurso ARM de uma das identidades de usuário associadas à VM.

HardwareProfile

Especifica as configurações de hardware para a máquina virtual.

Name Tipo Description
vmSize

VirtualMachineSizeTypes

Especifica o tamanho da máquina virtual. O tipo de dados enum está atualmente preterido e será removido até 23 de dezembro de 2023. A maneira recomendada de obter a lista de tamanhos disponíveis é usando estas APIs: Listar todos os tamanhos de máquina virtual disponíveis em um conjunto de disponibilidade, Listar todos os tamanhos de máquina virtual disponíveis em uma regiãoListar todos os tamanhos de máquina virtual disponíveis para redimensionamento. Para obter mais informações sobre tamanhos de máquinas virtuais, consulte tamanhos para máquinas virtuais. Os tamanhos de VM disponíveis dependem da região e do conjunto de disponibilidade.

vmSizeProperties

VMSizeProperties

Especifica as propriedades para personalizar o tamanho da máquina virtual. Versão mínima api: 2021-07-01. Esse recurso ainda está no modo de visualização e não é suportado para VirtualMachineScaleSet. Siga as instruções em de personalização de VM para obter mais detalhes.

HyperVGeneration

A geração do hipervisor da Máquina Virtual [V1, V2]

Name Tipo Description
V1

string

V2

string

ImageReference

Especifica informações sobre a imagem a ser usada. Você pode especificar informações sobre imagens de plataforma, imagens de mercado ou imagens de máquina virtual. Esse elemento é necessário quando você deseja usar uma imagem de plataforma, imagem de mercado ou imagem de máquina virtual, mas não é usado em outras operações de criação.

Name Tipo Description
communityGalleryImageId

string

Especificada a id exclusiva da imagem da galeria da comunidade para implantação de vm. Isso pode ser obtido na chamada GET da galeria da galeria da comunidade.

exactVersion

string

Especifica em números decimais, a versão da imagem da plataforma ou da imagem do mercado usada para criar a máquina virtual. Este campo só de leitura difere de «versão», apenas se o valor especificado no campo «versão» for «mais recente».

id

string

ID do recurso

offer

string

Especifica a oferta da imagem da plataforma ou imagem do mercado usada para criar a máquina virtual.

publisher

string

A editora de imagens.

sharedGalleryImageId

string

Especificada a id exclusiva da imagem da galeria compartilhada para implantação de vm. Isso pode ser obtido na chamada GET da imagem compartilhada da galeria.

sku

string

A imagem SKU.

version

string

Especifica a versão da imagem da plataforma ou da imagem do marketplace usada para criar a máquina virtual. Os formatos permitidos são Major.Minor.Build ou 'mais recente'. Major, Minor e Build são números decimais. Especifique 'mais recente' para usar a versão mais recente de uma imagem disponível no momento da implantação. Mesmo se você usar 'mais recente', a imagem da VM não será atualizada automaticamente após o tempo de implantação, mesmo que uma nova versão fique disponível. Por favor, não use o campo 'versão' para a implantação da imagem da galeria, a imagem da galeria deve sempre usar o campo 'id' para implantação, para usar a versão 'mais recente' da imagem da galeria, basta definir '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/galleries/{galleryName}/images/{imageName}' no campo 'id' sem entrada de versão.

InnerError

Detalhes do erro interno.

Name Tipo Description
errordetail

string

A mensagem de erro interna ou despejo de exceção.

exceptiontype

string

O tipo de exceção.

InstanceViewStatus

Status da exibição da instância.

Name Tipo Description
code

string

O código de status.

displayStatus

string

O rótulo curto localizável para o status.

level

StatusLevelTypes

O código de nível.

message

string

A mensagem de status detalhada, inclusive para alertas e mensagens de erro.

time

string

A hora do status.

IPVersion

Disponível a partir de Api-Version 2019-07-01, representa se a configuração ip específica é IPv4 ou IPv6. O padrão é considerado IPv4. Os valores possíveis são: 'IPv4' e 'IPv6'.

Name Tipo Description
IPv4

string

IPv6

string

IPVersions

Disponível a partir de Api-Version 2019-07-01, representa se a configuração ip específica é IPv4 ou IPv6. O padrão é considerado IPv4. Os valores possíveis são: 'IPv4' e 'IPv6'.

Name Tipo Description
IPv4

string

IPv6

string

KeyVaultKeyReference

Especifica o local da chave de criptografia de chave no Cofre da Chave.

Name Tipo Description
keyUrl

string

O URL que faz referência a uma chave de criptografia de chave no Cofre da Chave.

sourceVault

SubResource

O URL relativo do Cofre da Chave que contém a chave.

KeyVaultSecretReference

As extensões protegem as configurações que são passadas por referência e consumidas do cofre de chaves

Name Tipo Description
secretUrl

string

O URL que faz referência a um segredo em um Cofre de Chaves.

sourceVault

SubResource

O URL relativo do Cofre da Chave que contém o segredo.

LinuxConfiguration

Especifica as configurações do sistema operacional Linux na máquina virtual. Para obter uma lista de distribuições Linux suportadas, consulte Linux on Azure-Endorsed Distributions.

Name Tipo Description
disablePasswordAuthentication

boolean

Especifica se a autenticação de senha deve ser desabilitada.

enableVMAgentPlatformUpdates

boolean

Indica se as Atualizações da Plataforma VMAgent estão habilitadas para a máquina virtual Linux. O valor padrão é false.

patchSettings

LinuxPatchSettings

[Funcionalidade de pré-visualização] Especifica as configurações relacionadas ao Patch de convidado de VM no Linux.

provisionVMAgent

boolean

Indica se o agente de máquina virtual deve ser provisionado na máquina virtual. Quando essa propriedade não é especificada no corpo da solicitação, o comportamento padrão é defini-la como true. Isso garantirá que o Agente de VM seja instalado na VM para que as extensões possam ser adicionadas à VM posteriormente.

ssh

SshConfiguration

Especifica a configuração da chave ssh para um sistema operacional Linux.

LinuxPatchAssessmentMode

Especifica o modo de Avaliação de Patch de Convidado de VM para a máquina virtual IaaS.

Os valores possíveis são:

ImageDefault - Você controla o tempo das avaliações de patch em uma máquina virtual.

AutomaticByPlatform - A plataforma acionará avaliações periódicas de patches. A provisão de propriedadeVMAgent deve ser true.

Name Tipo Description
AutomaticByPlatform

string

ImageDefault

string

LinuxPatchSettings

[Funcionalidade de pré-visualização] Especifica as configurações relacionadas ao Patch de convidado de VM no Linux.

Name Tipo Description
assessmentMode

LinuxPatchAssessmentMode

Especifica o modo de Avaliação de Patch de Convidado de VM para a máquina virtual IaaS.

Os valores possíveis são:

ImageDefault - Você controla o tempo das avaliações de patch em uma máquina virtual.

AutomaticByPlatform - A plataforma acionará avaliações periódicas de patches. A provisão de propriedadeVMAgent deve ser true.

automaticByPlatformSettings

LinuxVMGuestPatchAutomaticByPlatformSettings

Especifica configurações adicionais para o modo de patch AutomaticByPlatform no VM Guest Patching no Linux.

patchMode

LinuxVMGuestPatchMode

Especifica o modo de aplicação de patches de convidado de VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquina virtual com OrchestrationMode como flexível.

Os valores possíveis são:

ImageDefault - A configuração de patch padrão da máquina virtual é usada.

AutomaticByPlatform - A máquina virtual será atualizada automaticamente pela plataforma. A provisão de propriedadeVMAgent deve ser true

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Especifica a configuração de reinicialização para todas as operações de instalação do patch AutomaticByPlatform.

Name Tipo Description
Always

string

IfRequired

string

Never

string

Unknown

string

LinuxVMGuestPatchAutomaticByPlatformSettings

Especifica configurações adicionais para o modo de patch AutomaticByPlatform no VM Guest Patching no Linux.

Name Tipo Description
bypassPlatformSafetyChecksOnUserSchedule

boolean

Permite que o cliente agende patches sem atualizações acidentais

rebootSetting

LinuxVMGuestPatchAutomaticByPlatformRebootSetting

Especifica a configuração de reinicialização para todas as operações de instalação do patch AutomaticByPlatform.

LinuxVMGuestPatchMode

Especifica o modo de aplicação de patches de convidado de VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquina virtual com OrchestrationMode como flexível.

Os valores possíveis são:

ImageDefault - A configuração de patch padrão da máquina virtual é usada.

AutomaticByPlatform - A máquina virtual será atualizada automaticamente pela plataforma. A provisão de propriedadeVMAgent deve ser true

Name Tipo Description
AutomaticByPlatform

string

ImageDefault

string

MaintenanceOperationResultCodeTypes

O código do resultado da última operação de manutenção.

Name Tipo Description
MaintenanceAborted

string

MaintenanceCompleted

string

None

string

RetryLater

string

MaintenanceRedeployStatus

O status da Operação de Manutenção na máquina virtual.

Name Tipo Description
isCustomerInitiatedMaintenanceAllowed

boolean

True, se o cliente tiver permissão para realizar a Manutenção.

lastOperationMessage

string

Mensagem retornada para a última Operação de Manutenção.

lastOperationResultCode

MaintenanceOperationResultCodeTypes

O código do resultado da última operação de manutenção.

maintenanceWindowEndTime

string

Hora de Fim da Janela de Manutenção.

maintenanceWindowStartTime

string

Hora de início da janela de manutenção.

preMaintenanceWindowEndTime

string

Hora de término da janela de pré-manutenção.

preMaintenanceWindowStartTime

string

Hora de início da janela de pré-manutenção.

ManagedDiskParameters

Os parâmetros do disco gerenciado.

Name Tipo Description
diskEncryptionSet

DiskEncryptionSetParameters

Especifica a id do recurso do conjunto de criptografia de disco gerenciado pelo cliente para o disco gerenciado.

id

string

ID do recurso

securityProfile

VMDiskSecurityProfile

Especifica o perfil de segurança para o disco gerenciado.

storageAccountType

StorageAccountTypes

Especifica o tipo de conta de armazenamento para o disco gerenciado. NOTA: UltraSSD_LRS só pode ser utilizado com discos de dados, não pode ser utilizado com o OS Disk.

Mode

Especifica o modo em que o ProxyAgent será executado se o recurso estiver habilitado. O ProxyAgent começará a auditar ou monitorar, mas não a impor o controle de acesso sobre solicitações para hospedar pontos de extremidade no modo de Auditoria, enquanto no modo Enforce ele imporá o controle de acesso. O valor padrão é Enforce mode.

Name Tipo Description
Audit

string

Enforce

string

NetworkApiVersion

especifica a versão da API Microsoft.Network usada ao criar recursos de rede nas Configurações da Interface de Rede

Name Tipo Description
2020-11-01

string

NetworkInterfaceAuxiliaryMode

Especifica se o modo Auxiliar está habilitado para o recurso Interface de Rede.

Name Tipo Description
AcceleratedConnections

string

Floating

string

None

string

NetworkInterfaceAuxiliarySku

Especifica se a sku Auxiliar está habilitada para o recurso Interface de Rede.

Name Tipo Description
A1

string

A2

string

A4

string

A8

string

None

string

NetworkInterfaceReference

Especifica a lista de IDs de recursos para as interfaces de rede associadas à máquina virtual.

Name Tipo Description
id

string

ID do recurso

properties.deleteOption

DeleteOptions

Especificar o que acontece com a interface de rede quando a VM é excluída

properties.primary

boolean

Especifica a interface de rede primária caso a máquina virtual tenha mais de 1 interface de rede.

NetworkProfile

Especifica as interfaces de rede da máquina virtual.

Name Tipo Description
networkApiVersion

NetworkApiVersion

especifica a versão da API Microsoft.Network usada ao criar recursos de rede nas Configurações da Interface de Rede

networkInterfaceConfigurations

VirtualMachineNetworkInterfaceConfiguration[]

Especifica as configurações de rede que serão usadas para criar os recursos de rede da máquina virtual.

networkInterfaces

NetworkInterfaceReference[]

Especifica a lista de IDs de recursos para as interfaces de rede associadas à máquina virtual.

OperatingSystemTypes

O tipo de sistema operacional.

Name Tipo Description
Linux

string

Windows

string

OSDisk

Especifica informações sobre o disco do sistema operacional usado pela máquina virtual. Para obter mais informações sobre discos, consulte Sobre discos e VHDs para máquinas virtuais do Azure.

Name Tipo Description
caching

CachingTypes

Especifica os requisitos de cache. Os valores possíveis são: None,ReadOnlyReadWrite. O comportamento padrão é: Nenhum para armazenamento padrão. ReadOnly para armazenamento Premium.

createOption

DiskCreateOptionTypes

Especifica como o disco da máquina virtual deve ser criado. Os valores possíveis são Anexar: Esse valor é usado quando você estiver usando um disco especializado para criar a máquina virtual. FromImage: Esse valor é usado quando você está usando uma imagem para criar a máquina virtual. Se você estiver usando uma imagem de plataforma, também deverá usar o elemento imageReference descrito acima. Se você estiver usando uma imagem de marketplace, também deverá usar o elemento de plano descrito anteriormente.

deleteOption

DiskDeleteOptionTypes

Especifica se o disco do sistema operacional deve ser excluído ou desanexado após a exclusão da VM. Os valores possíveis são: Delete. Se esse valor for usado, o disco do sistema operacional será excluído quando a VM for excluída. Destacar. Se esse valor for usado, o disco do sistema operacional será retido após a VM ser excluída. O valor padrão é definido como Desanexar. Para um disco de sistema operacional efêmero, o valor padrão é definido como Delete. O usuário não pode alterar a opção de exclusão para um disco de sistema operacional efêmero.

diffDiskSettings

DiffDiskSettings

Especifica as configurações de disco efêmeras para o disco do sistema operacional usado pela máquina virtual.

diskSizeGB

integer

Especifica o tamanho de um disco de dados vazio em gigabytes. Esse elemento pode ser usado para substituir o tamanho do disco em uma imagem de máquina virtual. A propriedade 'diskSizeGB' é o número de bytes x 1024^3 para o disco e o valor não pode ser maior que 1023.

encryptionSettings

DiskEncryptionSettings

Especifica as configurações de criptografia para o disco do sistema operacional. Versão mínima da api: 2015-06-15.

image

VirtualHardDisk

O disco rígido virtual de imagem do usuário de origem. O disco rígido virtual será copiado antes de ser anexado à máquina virtual. Se SourceImage for fornecido, o disco rígido virtual de destino não deve existir.

managedDisk

ManagedDiskParameters

Os parâmetros do disco gerenciado.

name

string

O nome do disco.

osType

OperatingSystemTypes

Essa propriedade permite que você especifique o tipo do sistema operacional que está incluído no disco se estiver criando uma VM a partir da imagem do usuário ou de um VHD especializado. Os valores possíveis são: Windows,Linux.

vhd

VirtualHardDisk

O disco rígido virtual.

writeAcceleratorEnabled

boolean

Especifica se writeAccelerator deve ser habilitado ou desabilitado no disco.

OSProfile

Especifica as configurações do sistema operacional para a máquina virtual.

Name Tipo Description
adminPassword

string

Especifica a senha da conta de administrador.

Comprimento mínimo (Windows): 8 caracteres

Comprimento mínimo (Linux): 6 caracteres

Max-length (Windows): 123 caracteres

Max-length (Linux): 72 caracteres

Requisitos de complexidade: 3 das 4 condições abaixo precisam ser cumpridas
Tem caracteres mais baixos
Tem caracteres superiores
Tem um dígito
Tem um caractere especial (Regex match [\W_])

Valores não permitidos: "abc@123", "P@$$w 0rd", "P@ssw0rd", "P@ssword123", "Pa$$word", "pass@word1", "Password!", "Password1", "Password22", "iloveyou!"

Para redefinir a senha, consulte Como redefinir o serviço de Área de Trabalho Remota ou sua senha de login em uma VM do Windows

Para redefinir a senha de root, consulte Gerenciar usuários, SSH e verificar ou reparar discos em VMs Linux do Azure usando a Extensão VMAccess

adminUsername

string

Especifica o nome da conta de administrador.

Essa propriedade não pode ser atualizada depois que a VM é criada.

Restrição somente para Windows: Não pode terminar em "."

Valores não permitidos: "administrator", "admin", "user", "user1", "test", "user2", "test1", "user3", "admin1", "1", "123", "a", "actuser", "adm", "admin2", "aspnet", "backup", "console", "david", "guest", "john", "owner", "root", "server", "sql", "support", "support_388945a0", "sys", "test2", "test3", "user4", "user5".

Comprimento mínimo (Linux): 1 caractere

Max-length (Linux): 64 caracteres

Comprimento máximo (Windows): 20 caracteres.

allowExtensionOperations

boolean

Especifica se as operações de extensão devem ser permitidas na máquina virtual. Isso só pode ser definido como Falso quando nenhuma extensão estiver presente na máquina virtual.

computerName

string

Especifica o nome do sistema operacional host da máquina virtual. Esse nome não pode ser atualizado após a criação da VM. Comprimento máximo (Windows): 15 caracteres. Max-length (Linux): 64 caracteres. Para convenções e restrições de nomenclatura, consulte diretrizes de implementação de serviços de infraestrutura do Azure.

customData

string

Especifica uma cadeia de caracteres codificada em base 64 de dados personalizados. A cadeia de caracteres codificada em base 64 é decodificada para uma matriz binária que é salva como um arquivo na máquina virtual. O comprimento máximo da matriz binária é de 65535 bytes. Nota: Não passe segredos ou senhas na propriedade customData. Essa propriedade não pode ser atualizada depois que a VM é criada. A propriedade 'customData' é passada para a VM para ser salva como um arquivo, para obter mais informações, consulte Dados Personalizados em VMs do Azure. Para usar cloud-init para sua VM Linux, consulte Usando cloud-init para personalizar uma VM Linux durante a criação.

linuxConfiguration

LinuxConfiguration

Especifica as configurações do sistema operacional Linux na máquina virtual. Para obter uma lista de distribuições Linux suportadas, consulte Linux on Azure-Endorsed Distributions.

requireGuestProvisionSignal

boolean

Propriedade opcional que deve ser definida como True ou omitida.

secrets

VaultSecretGroup[]

Especifica o conjunto de certificados que devem ser instalados na máquina virtual. Para instalar certificados em uma máquina virtual, é recomendável usar a extensão de máquina virtual do Azure Key Vault para Linux ou a extensão de máquina virtual do Azure Key Vault para Windows.

windowsConfiguration

WindowsConfiguration

Especifica as configurações do sistema operacional Windows na máquina virtual.

PassNames

O nome do passe. Atualmente, o único valor permitido é OobeSystem.

Name Tipo Description
OobeSystem

string

PatchSettings

[Funcionalidade de pré-visualização] Especifica as configurações relacionadas ao patch de convidado de VM no Windows.

Name Tipo Description
assessmentMode

WindowsPatchAssessmentMode

Especifica o modo de avaliação de patch do convidado da VM para a máquina virtual IaaS.

Os valores possíveis são:

ImageDefault - Você controla o tempo das avaliações de patch em uma máquina virtual.

AutomaticByPlatform - A plataforma acionará avaliações periódicas de patches. A provisão de propriedadeVMAgent deve ser true.

automaticByPlatformSettings

WindowsVMGuestPatchAutomaticByPlatformSettings

Especifica configurações adicionais para o modo de patch AutomaticByPlatform no VM Guest Patching no Windows.

enableHotpatching

boolean

Permite que os clientes corrijam suas VMs do Azure sem exigir uma reinicialização. Para enableHotpatching, o 'provisionVMAgent' deve ser definido como true e 'patchMode' deve ser definido como 'AutomaticByPlatform'.

patchMode

WindowsVMGuestPatchMode

Especifica o modo de aplicação de patches de convidado de VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquina virtual com OrchestrationMode como flexível.

Os valores possíveis são:

Manual - Você controla a aplicação de patches em uma máquina virtual. Para fazer isso, aplique patches manualmente dentro da VM. Neste modo, as atualizações automáticas são desativadas; a propriedade WindowsConfiguration.enableAutomaticUpdates deve ser false

AutomaticByOS - A máquina virtual será atualizada automaticamente pelo SO. A propriedade WindowsConfiguration.enableAutomaticUpdates deve ser true.

AutomaticByPlatform - a máquina virtual será atualizada automaticamente pela plataforma. As propriedades provisionVMAgent e WindowsConfiguration.enableAutomaticUpdates devem ser true

Plan

Especifica informações sobre a imagem do marketplace usada para criar a máquina virtual. Este elemento é usado apenas para imagens do mercado. Antes de poder usar uma imagem de mercado de uma API, você deve habilitar a imagem para uso programático. No portal do Azure, localize a imagem do marketplace que pretende utilizar e, em seguida, clique em Pretende implementar programaticamente, Introdução ->. Introduza todas as informações necessárias e, em seguida, clique em Guardar.

Name Tipo Description
name

string

O ID do plano.

product

string

Especifica o produto da imagem do mercado. Este é o mesmo valor que Offer sob o elemento imageReference.

promotionCode

string

O código promocional.

publisher

string

O ID do editor.

ProtocolTypes

Especifica o protocolo do ouvinte do WinRM. Os valores possíveis são: httphttps.

Name Tipo Description
Http

string

Https

string

ProxyAgentSettings

Especifica as configurações do ProxyAgent ao criar a máquina virtual. Versão mínima da api: 2023-09-01.

Name Tipo Description
enabled

boolean

Especifica se o recurso ProxyAgent deve ser habilitado na máquina virtual ou no conjunto de dimensionamento da máquina virtual.

keyIncarnationId

integer

Aumentar o valor dessa propriedade permite que o usuário redefina a chave usada para proteger o canal de comunicação entre convidado e host.

mode

Mode

Especifica o modo em que o ProxyAgent será executado se o recurso estiver habilitado. O ProxyAgent começará a auditar ou monitorar, mas não a impor o controle de acesso sobre solicitações para hospedar pontos de extremidade no modo de Auditoria, enquanto no modo Enforce ele imporá o controle de acesso. O valor padrão é Enforce mode.

PublicIPAddressSku

Descreve o IP público Sku. Ele só pode ser definido com OrchestrationMode como flexível.

Name Tipo Description
name

PublicIPAddressSkuName

Especificar nome de sku IP público

tier

PublicIPAddressSkuTier

Especificar camada de sku IP público

PublicIPAddressSkuName

Especificar nome de sku IP público

Name Tipo Description
Basic

string

Standard

string

PublicIPAddressSkuTier

Especificar camada de sku IP público

Name Tipo Description
Global

string

Regional

string

PublicIPAllocationMethod

Especificar o tipo de alocação de IP público

Name Tipo Description
Dynamic

string

Static

string

ResourceIdentityType

O tipo de identidade usado para a máquina virtual. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades da máquina virtual.

Name Tipo Description
None

string

SystemAssigned

string

SystemAssigned, UserAssigned

string

UserAssigned

string

securityEncryptionTypes

Especifica o EncryptionType do disco gerenciado. Ele é definido como DiskWithVMGuestState para criptografia do disco gerenciado junto com o blob VMGuestState, VMGuestStateOnly para criptografia apenas do blob VMGuestState e NonPersistedTPM para não persistir o estado do firmware no blob VMGuestState. Nota: Ele pode ser definido apenas para VMs confidenciais.

Name Tipo Description
DiskWithVMGuestState

string

NonPersistedTPM

string

VMGuestStateOnly

string

SecurityProfile

Especifica as configurações de perfil relacionadas à segurança para a máquina virtual.

Name Tipo Description
encryptionAtHost

boolean

Essa propriedade pode ser usada pelo usuário na solicitação para habilitar ou desabilitar a Criptografia de Host para a máquina virtual ou o conjunto de dimensionamento de máquina virtual. Isso habilitará a criptografia para todos os discos, incluindo o disco Resource/Temp no próprio host. O comportamento padrão é: A criptografia no host será desabilitada, a menos que essa propriedade seja definida como true para o recurso.

encryptionIdentity

EncryptionIdentity

Especifica a Identidade Gerenciada usada pelo ADE para obter o token de acesso para operações keyvault.

proxyAgentSettings

ProxyAgentSettings

Especifica as configurações do ProxyAgent ao criar a máquina virtual. Versão mínima da api: 2023-09-01.

securityType

SecurityTypes

Especifica o SecurityType da máquina virtual. Ele deve ser definido como qualquer valor especificado para habilitar UefiSettings. O comportamento padrão é: UefiSettings não será habilitado a menos que essa propriedade esteja definida.

uefiSettings

UefiSettings

Especifica as configurações de segurança, como inicialização segura e vTPM, usadas durante a criação da máquina virtual. Versão api mínima: 2020-12-01.

SecurityTypes

Especifica o SecurityType da máquina virtual. Ele deve ser definido como qualquer valor especificado para habilitar UefiSettings. O comportamento padrão é: UefiSettings não será habilitado a menos que essa propriedade esteja definida.

Name Tipo Description
ConfidentialVM

string

TrustedLaunch

string

SettingNames

Especifica o nome da configuração à qual o conteúdo se aplica. Os valores possíveis são: FirstLogonCommands e AutoLogon.

Name Tipo Description
AutoLogon

string

FirstLogonCommands

string

Sku

A máquina virtual SKU.

Name Tipo Description
capacity

integer

Especifica o número de máquinas virtuais no conjunto de escala.

name

string

O nome do sku.

tier

string

Especifica a camada de máquinas virtuais em um conjunto de escala.

Valores possíveis:

Standard

Básico

SshConfiguration

Especifica a configuração da chave ssh para um sistema operacional Linux.

Name Tipo Description
publicKeys

SshPublicKey[]

A lista de chaves públicas SSH usadas para autenticar com VMs baseadas em linux.

SshPublicKey

A lista de chaves públicas SSH usadas para autenticar com VMs baseadas em linux.

Name Tipo Description
keyData

string

Certificado de chave pública SSH usado para autenticar com a VM através do ssh. A chave precisa ser de pelo menos 2048 bits e no formato ssh-rsa. Para criar chaves ssh, consulte [Criar chaves SSH no Linux e Mac para VMs Linux no Azure]https://docs.microsoft.com/azure/virtual-machines/linux/create-ssh-keys-detailed).

path

string

Especifica o caminho completo na VM criada onde a chave pública ssh é armazenada. Se o arquivo já existir, a chave especificada será anexada ao arquivo. Exemplo: /home/user/.ssh/authorized_keys

StatusLevelTypes

O código de nível.

Name Tipo Description
Error

string

Info

string

Warning

string

StorageAccountTypes

Especifica o tipo de conta de armazenamento para o disco gerenciado. NOTA: UltraSSD_LRS só pode ser utilizado com discos de dados, não pode ser utilizado com o OS Disk.

Name Tipo Description
PremiumV2_LRS

string

Premium_LRS

string

Premium_ZRS

string

StandardSSD_LRS

string

StandardSSD_ZRS

string

Standard_LRS

string

UltraSSD_LRS

string

StorageProfile

Especifica as configurações de armazenamento para os discos da máquina virtual.

Name Tipo Description
dataDisks

DataDisk[]

Especifica os parâmetros que são usados para adicionar um disco de dados a uma máquina virtual. Para obter mais informações sobre discos, consulte Sobre discos e VHDs para máquinas virtuais do Azure.

diskControllerType

DiskControllerTypes

Especifica o tipo de controlador de disco configurado para a VM. Nota: Esta propriedade será definida como o tipo de controlador de disco padrão se não for especificada, desde que a máquina virtual esteja sendo criada com 'hyperVGeneration' definido como V2 com base nos recursos do disco do sistema operacional e no tamanho da VM da versão mínima de api especificada. Você precisa desalocar a VM antes de atualizar seu tipo de controlador de disco, a menos que esteja atualizando o tamanho da VM na configuração da VM que implicitamente desaloca e realoca a VM. Versão mínima da api: 2022-08-01.

imageReference

ImageReference

Especifica informações sobre a imagem a ser usada. Você pode especificar informações sobre imagens de plataforma, imagens de mercado ou imagens de máquina virtual. Esse elemento é necessário quando você deseja usar uma imagem de plataforma, imagem de mercado ou imagem de máquina virtual, mas não é usado em outras operações de criação.

osDisk

OSDisk

Especifica informações sobre o disco do sistema operacional usado pela máquina virtual. Para obter mais informações sobre discos, consulte Sobre discos e VHDs para máquinas virtuais do Azure.

SubResource

O URL relativo do Cofre da Chave que contém o segredo.

Name Tipo Description
id

string

ID do recurso

UefiSettings

Especifica as configurações de segurança, como inicialização segura e vTPM, usadas durante a criação da máquina virtual. Versão api mínima: 2020-12-01.

Name Tipo Description
secureBootEnabled

boolean

Especifica se a inicialização segura deve ser habilitada na máquina virtual. Versão api mínima: 2020-12-01.

vTpmEnabled

boolean

Especifica se o vTPM deve ser habilitado na máquina virtual. Versão api mínima: 2020-12-01.

UserAssignedIdentities

A lista de identidades de usuário associadas à máquina virtual. As referências de chave do dicionário de identidade do usuário serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

Name Tipo Description

VaultCertificate

A lista de referências do cofre de chaves no SourceVault que contêm certificados.

Name Tipo Description
certificateStore

string

Para VMs do Windows, especifica o armazenamento de certificados na Máquina Virtual ao qual o certificado deve ser adicionado. O armazenamento de certificados especificado está implicitamente na conta LocalMachine. Para VMs Linux, o arquivo de certificado é colocado no diretório /var/lib/waagent, com o nome do arquivo <UppercaseThumbprint>.crt para o arquivo de certificado X509 e <UppercaseThumbprint>.prv para chave privada. Ambos os arquivos são .pem formatado.

certificateUrl

string

Este é o URL de um certificado que foi carregado para o Cofre da Chave como um segredo. Para adicionar um segredo ao Cofre de Chaves, consulte Adicionar uma chave ou segredo ao Cofre de Chaves. Nesse caso, seu certificado precisa ser É a codificação Base64 do seguinte objeto JSON que é codificado em UTF-8:

{
"dados":"",
"dataType":"pfx",
"senha":""
}
Para instalar certificados em uma máquina virtual, é recomendável usar a extensão de máquina virtual do Azure Key Vault para Linux ou a extensão de máquina virtual do Azure Key Vault para Windows.

VaultSecretGroup

Especifica o conjunto de certificados que devem ser instalados na máquina virtual. Para instalar certificados em uma máquina virtual, é recomendável usar a extensão de máquina virtual do Azure Key Vault para Linux ou a extensão de máquina virtual do Azure Key Vault para Windows.

Name Tipo Description
sourceVault

SubResource

A URL relativa do Cofre da Chave que contém todos os certificados em VaultCertificates.

vaultCertificates

VaultCertificate[]

A lista de referências do cofre de chaves no SourceVault que contêm certificados.

VirtualHardDisk

O disco rígido virtual.

Name Tipo Description
uri

string

Especifica o uri do disco rígido virtual.

VirtualMachineAgentInstanceView

O Agente de VM em execução na máquina virtual.

Name Tipo Description
extensionHandlers

VirtualMachineExtensionHandlerInstanceView[]

A exibição da instância do manipulador de extensão de máquina virtual.

statuses

InstanceViewStatus[]

As informações de status do recurso.

vmAgentVersion

string

A versão completa do VM Agent.

VirtualMachineExtension

Os recursos de extensão filho da máquina virtual.

Name Tipo Description
id

string

ID do recurso

location

string

Localização do recurso

name

string

Nome do recurso

properties.autoUpgradeMinorVersion

boolean

Indica se a extensão deve usar uma versão secundária mais recente, se uma estiver disponível no momento da implantação. Uma vez implantada, no entanto, a extensão não atualizará versões secundárias, a menos que seja reimplantada, mesmo com essa propriedade definida como true.

properties.enableAutomaticUpgrade

boolean

Indica se a extensão deve ser atualizada automaticamente pela plataforma se houver uma versão mais recente da extensão disponível.

properties.forceUpdateTag

string

Como o manipulador de extensão deve ser forçado a atualizar mesmo que a configuração da extensão não tenha sido alterada.

properties.instanceView

VirtualMachineExtensionInstanceView

A exibição da instância de extensão de máquina virtual.

properties.protectedSettings

object

A extensão pode conter protectedSettings ou protectedSettingsFromKeyVault ou nenhuma configuração protegida.

properties.protectedSettingsFromKeyVault

KeyVaultSecretReference

As extensões protegem as configurações que são passadas por referência e consumidas do cofre de chaves

properties.provisionAfterExtensions

string[]

Coleção de nomes de extensão após a qual essa extensão precisa ser provisionada.

properties.provisioningState

string

O estado de provisionamento, que só aparece na resposta.

properties.publisher

string

O nome do editor do manipulador de extensão.

properties.settings

object

Json formatou configurações públicas para a extensão.

properties.suppressFailures

boolean

Indica se as falhas decorrentes da extensão serão suprimidas (Falhas operacionais, como não se conectar à VM, não serão suprimidas, independentemente desse valor). O padrão é false.

properties.type

string

Especifica o tipo da extensão; um exemplo é "CustomScriptExtension".

properties.typeHandlerVersion

string

Especifica a versão do manipulador de script.

tags

object

Tags de recursos

type

string

Tipo de recurso

VirtualMachineExtensionHandlerInstanceView

A exibição da instância do manipulador de extensão de máquina virtual.

Name Tipo Description
status

InstanceViewStatus

O status do manipulador de extensão.

type

string

Especifica o tipo da extensão; um exemplo é "CustomScriptExtension".

typeHandlerVersion

string

Especifica a versão do manipulador de script.

VirtualMachineExtensionInstanceView

A exibição da instância de extensão de máquina virtual.

Name Tipo Description
name

string

O nome da extensão da máquina virtual.

statuses

InstanceViewStatus[]

As informações de status do recurso.

substatuses

InstanceViewStatus[]

As informações de status do recurso.

type

string

Especifica o tipo da extensão; um exemplo é "CustomScriptExtension".

typeHandlerVersion

string

Especifica a versão do manipulador de script.

VirtualMachineHealthStatus

O status de integridade da VM.

Name Tipo Description
status

InstanceViewStatus

As informações de status de integridade para a VM.

VirtualMachineIdentity

A identidade da máquina virtual, se configurada.

Name Tipo Description
principalId

string

O id principal da identidade da máquina virtual. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.

tenantId

string

A ID do locatário associada à máquina virtual. Esta propriedade só será fornecida para uma identidade atribuída ao sistema.

type

ResourceIdentityType

O tipo de identidade usado para a máquina virtual. O tipo 'SystemAssigned, UserAssigned' inclui uma identidade criada implicitamente e um conjunto de identidades atribuídas pelo usuário. O tipo 'Nenhum' removerá todas as identidades da máquina virtual.

userAssignedIdentities

UserAssignedIdentities

A lista de identidades de usuário associadas à máquina virtual. As referências de chave do dicionário de identidade do usuário serão ids de recurso ARM no formato: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.

VirtualMachineIpTag

A lista de tags IP associadas ao endereço IP público.

Name Tipo Description
ipTagType

string

Tipo de tag IP. Exemplo: FirstPartyUsage.

tag

string

IP associada ao IP público. Exemplo: SQL, Storage etc.

VirtualMachineNetworkInterfaceConfiguration

Especifica as configurações de rede que serão usadas para criar os recursos de rede da máquina virtual.

Name Tipo Description
name

string

O nome da configuração da interface de rede.

properties.auxiliaryMode

NetworkInterfaceAuxiliaryMode

Especifica se o modo Auxiliar está habilitado para o recurso Interface de Rede.

properties.auxiliarySku

NetworkInterfaceAuxiliarySku

Especifica se a sku Auxiliar está habilitada para o recurso Interface de Rede.

properties.deleteOption

DeleteOptions

Especificar o que acontece com a interface de rede quando a VM é excluída

properties.disableTcpStateTracking

boolean

Especifica se a interface de rede está desabilitada para rastreamento de estado tcp.

properties.dnsSettings

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

As configurações de dns a serem aplicadas nas interfaces de rede.

properties.dscpConfiguration

SubResource

properties.enableAcceleratedNetworking

boolean

Especifica se a interface de rede é habilitada para rede acelerada.

properties.enableFpga

boolean

Especifica se a interface de rede é habilitada para rede FPGA.

properties.enableIPForwarding

boolean

Se o encaminhamento IP está habilitado nesta NIC.

properties.ipConfigurations

VirtualMachineNetworkInterfaceIPConfiguration[]

Especifica as configurações IP da interface de rede.

properties.networkSecurityGroup

SubResource

O grupo de segurança de rede.

properties.primary

boolean

Especifica a interface de rede primária caso a máquina virtual tenha mais de 1 interface de rede.

VirtualMachineNetworkInterfaceDnsSettingsConfiguration

As configurações de dns a serem aplicadas nas interfaces de rede.

Name Tipo Description
dnsServers

string[]

Lista de endereços IP de servidores DNS

VirtualMachineNetworkInterfaceIPConfiguration

Especifica as configurações IP da interface de rede.

Name Tipo Description
name

string

O nome da configuração IP.

properties.applicationGatewayBackendAddressPools

SubResource[]

Especifica uma matriz de referências a pools de endereços de back-end de gateways de aplicativos. Uma máquina virtual pode fazer referência a pools de endereços de back-end de vários gateways de aplicativos. Várias máquinas virtuais não podem usar o mesmo gateway de aplicativo.

properties.applicationSecurityGroups

SubResource[]

Especifica uma matriz de referências ao grupo de segurança do aplicativo.

properties.loadBalancerBackendAddressPools

SubResource[]

Especifica uma matriz de referências a pools de endereços de back-end de balanceadores de carga. Uma máquina virtual pode fazer referência a pools de endereços de back-end de um balanceador de carga público e interno. [Várias máquinas virtuais não podem usar o mesmo balanceador de carga sku básico].

properties.primary

boolean

Especifica a interface de rede primária caso a máquina virtual tenha mais de 1 interface de rede.

properties.privateIPAddressVersion

IPVersions

Disponível a partir de 30-03-Api-Version 2017, representa se a configuração ip específica é IPv4 ou IPv6. O padrão é considerado IPv4. Os valores possíveis são: 'IPv4' e 'IPv6'.

properties.publicIPAddressConfiguration

VirtualMachinePublicIPAddressConfiguration

O publicIPAddressConfiguration.

properties.subnet

SubResource

Especifica o identificador da sub-rede.

VirtualMachinePublicIPAddressConfiguration

O publicIPAddressConfiguration.

Name Tipo Description
name

string

O nome de configuração do endereço IP público.

properties.deleteOption

DeleteOptions

Especificar o que acontece com o endereço IP público quando a VM é excluída

properties.dnsSettings

VirtualMachinePublicIPAddressDnsSettingsConfiguration

As configurações de dns a serem aplicadas nos endereços IP públicos.

properties.idleTimeoutInMinutes

integer

O tempo limite ocioso do endereço IP público.

properties.ipTags

VirtualMachineIpTag[]

A lista de tags IP associadas ao endereço IP público.

properties.publicIPAddressVersion

IPVersions

Disponível a partir de Api-Version 2019-07-01, representa se a configuração ip específica é IPv4 ou IPv6. O padrão é considerado IPv4. Os valores possíveis são: 'IPv4' e 'IPv6'.

properties.publicIPAllocationMethod

PublicIPAllocationMethod

Especificar o tipo de alocação de IP público

properties.publicIPPrefix

SubResource

O PublicIPPrefix a partir do qual alocar endereços IP públicos.

sku

PublicIPAddressSku

Descreve o IP público Sku. Ele só pode ser definido com OrchestrationMode como flexível.

VirtualMachinePublicIPAddressDnsSettingsConfiguration

As configurações de dns a serem aplicadas nos endereços IP públicos.

Name Tipo Description
domainNameLabel

string

O prefixo do rótulo de nome de domínio dos recursos PublicIPAddress que serão criados. O rótulo de nome gerado é a concatenação do rótulo de nome de domínio e ID exclusivo do perfil de rede vm.

domainNameLabelScope

DomainNameLabelScopeTypes

O escopo do rótulo de nome de domínio dos recursos PublicIPAddress que serão criados. O rótulo de nome gerado é a concatenação do rótulo de nome de domínio com hash com a política de acordo com o escopo do rótulo do nome de domínio e o ID exclusivo do perfil de rede vm.

VirtualMachineScaleSetIPConfiguration

Especifica as configurações IP da interface de rede.

Name Tipo Description
name

string

O nome da configuração IP.

properties.applicationGatewayBackendAddressPools

SubResource[]

Especifica uma matriz de referências a pools de endereços de back-end de gateways de aplicativos. Um conjunto de dimensionamento pode fazer referência a pools de endereços de back-end de vários gateways de aplicativos. Vários conjuntos de escala não podem usar o mesmo gateway de aplicativo.

properties.applicationSecurityGroups

SubResource[]

Especifica uma matriz de referências ao grupo de segurança do aplicativo.

properties.loadBalancerBackendAddressPools

SubResource[]

Especifica uma matriz de referências a pools de endereços de back-end de balanceadores de carga. Um conjunto de dimensionamento pode fazer referência a pools de endereços de back-end de um balanceador de carga público e interno. Vários conjuntos de escala não podem usar o mesmo balanceador de carga de sku básico.

properties.loadBalancerInboundNatPools

SubResource[]

Especifica uma matriz de referências a pools Nat de entrada dos balanceadores de carga. Um conjunto de escalas pode fazer referência a pools de nat de entrada de um balanceador de carga público e interno. Vários conjuntos de escala não podem usar o mesmo balanceador de carga de sku básico.

properties.primary

boolean

Especifica a interface de rede primária caso a máquina virtual tenha mais de 1 interface de rede.

properties.privateIPAddressVersion

IPVersion

Disponível a partir de 30-03-Api-Version 2017, representa se a configuração ip específica é IPv4 ou IPv6. O padrão é considerado IPv4. Os valores possíveis são: 'IPv4' e 'IPv6'.

properties.publicIPAddressConfiguration

VirtualMachineScaleSetPublicIPAddressConfiguration

O publicIPAddressConfiguration.

properties.subnet

ApiEntityReference

Especifica o identificador da sub-rede.

VirtualMachineScaleSetIpTag

A lista de tags IP associadas ao endereço IP público.

Name Tipo Description
ipTagType

string

Tipo de tag IP. Exemplo: FirstPartyUsage.

tag

string

IP associada ao IP público. Exemplo: SQL, Storage etc.

VirtualMachineScaleSetNetworkConfiguration

A lista de configurações de rede.

Name Tipo Description
name

string

O nome da configuração de rede.

properties.auxiliaryMode

NetworkInterfaceAuxiliaryMode

Especifica se o modo Auxiliar está habilitado para o recurso Interface de Rede.

properties.auxiliarySku

NetworkInterfaceAuxiliarySku

Especifica se a sku Auxiliar está habilitada para o recurso Interface de Rede.

properties.deleteOption

DeleteOptions

Especificar o que acontece com a interface de rede quando a VM é excluída

properties.disableTcpStateTracking

boolean

Especifica se a interface de rede está desabilitada para rastreamento de estado tcp.

properties.dnsSettings

VirtualMachineScaleSetNetworkConfigurationDnsSettings

As configurações de dns a serem aplicadas nas interfaces de rede.

properties.enableAcceleratedNetworking

boolean

Especifica se a interface de rede é habilitada para rede acelerada.

properties.enableFpga

boolean

Especifica se a interface de rede é habilitada para rede FPGA.

properties.enableIPForwarding

boolean

Se o encaminhamento IP está habilitado nesta NIC.

properties.ipConfigurations

VirtualMachineScaleSetIPConfiguration[]

Especifica as configurações IP da interface de rede.

properties.networkSecurityGroup

SubResource

O grupo de segurança de rede.

properties.primary

boolean

Especifica a interface de rede primária caso a máquina virtual tenha mais de 1 interface de rede.

VirtualMachineScaleSetNetworkConfigurationDnsSettings

As configurações de dns a serem aplicadas nas interfaces de rede.

Name Tipo Description
dnsServers

string[]

Lista de endereços IP de servidores DNS

VirtualMachineScaleSetPublicIPAddressConfiguration

O publicIPAddressConfiguration.

Name Tipo Description
name

string

O nome de configuração do endereço IP público.

properties.deleteOption

DeleteOptions

Especificar o que acontece com o IP público quando a VM é excluída

properties.dnsSettings

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

As configurações de dns a serem aplicadas nos endereços IP públicos.

properties.idleTimeoutInMinutes

integer

O tempo limite ocioso do endereço IP público.

properties.ipTags

VirtualMachineScaleSetIpTag[]

A lista de tags IP associadas ao endereço IP público.

properties.publicIPAddressVersion

IPVersion

Disponível a partir de Api-Version 2019-07-01, representa se a configuração ip específica é IPv4 ou IPv6. O padrão é considerado IPv4. Os valores possíveis são: 'IPv4' e 'IPv6'.

properties.publicIPPrefix

SubResource

O PublicIPPrefix a partir do qual alocar endereços IP públicos.

sku

PublicIPAddressSku

Descreve o IP público Sku. Ele só pode ser definido com OrchestrationMode como flexível.

VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings

As configurações de dns a serem aplicadas nos endereços IP públicos.

Name Tipo Description
domainNameLabel

string

O rótulo do nome de domínio. A concatenação do rótulo de nome de domínio e do índice vm serão os rótulos de nome de domínio dos recursos PublicIPAddress que serão criados

domainNameLabelScope

DomainNameLabelScopeTypes

O escopo do rótulo de nome de domínio. A concatenação do rótulo de nome de domínio com hash gerado de acordo com a política do escopo do rótulo de nome de domínio e do índice vm serão os rótulos de nome de domínio dos recursos de endereço PublicIPAddress que serão criados

VirtualMachineScaleSetVM

A lista de dimensionamento de máquina virtual define VMs.

Name Tipo Description
etag

string

Etag é a propriedade retornada na resposta Update/Get da VMSS VMSS, para que o cliente possa fornecê-la no cabeçalho para garantir atualizações otimistas.

id

string

ID do recurso

identity

VirtualMachineIdentity

A identidade da máquina virtual, se configurada.

instanceId

string

O ID da instância da máquina virtual.

location

string

Localização do recurso

name

string

Nome do recurso

plan

Plan

Especifica informações sobre a imagem do marketplace usada para criar a máquina virtual. Este elemento é usado apenas para imagens do mercado. Antes de poder usar uma imagem de mercado de uma API, você deve habilitar a imagem para uso programático. No portal do Azure, localize a imagem do marketplace que pretende utilizar e, em seguida, clique em Pretende implementar programaticamente, Introdução ->. Introduza todas as informações necessárias e, em seguida, clique em Guardar.

properties.additionalCapabilities

AdditionalCapabilities

Especifica recursos adicionais habilitados ou desabilitados na máquina virtual no conjunto de escala. Por exemplo: se a máquina virtual tem a capacidade de suportar a anexação de discos de dados gerenciados com UltraSSD_LRS tipo de conta de armazenamento.

properties.availabilitySet

SubResource

Especifica informações sobre o conjunto de disponibilidade ao qual a máquina virtual deve ser atribuída. As máquinas virtuais especificadas no mesmo conjunto de disponibilidade são alocadas a nós diferentes para maximizar a disponibilidade. Para obter mais informações sobre conjuntos de disponibilidade, consulte Visão geral dos conjuntos de disponibilidade. Para obter mais informações sobre a manutenção planejada do Azure, consulte Manutenção e atualizações para máquinas virtuais no Azure. Atualmente, uma VM só pode ser adicionada ao conjunto de disponibilidade no momento da criação. Uma VM existente não pode ser adicionada a um conjunto de disponibilidade.

properties.diagnosticsProfile

DiagnosticsProfile

Especifica o estado das configurações de diagnóstico de inicialização. Versão mínima da api: 2015-06-15.

properties.hardwareProfile

HardwareProfile

Especifica as configurações de hardware para a máquina virtual.

properties.instanceView

VirtualMachineScaleSetVMInstanceView

A exibição da instância da máquina virtual.

properties.latestModelApplied

boolean

Especifica se o modelo mais recente foi aplicado à máquina virtual.

properties.licenseType

string

Especifica que a imagem ou o disco que está sendo usado foi licenciado localmente.

Os valores possíveis para o sistema operacional Windows Server são:

Windows_Client

Windows_Server

Os valores possíveis para o sistema operacional Linux Server são:

RHEL_BYOS (para RHEL)

SLES_BYOS (para SUSE)

Para obter mais informações, consulte Benefício de Uso Híbrido do Azure para Windows Server

Benefício de Uso Híbrido do Azure para Linux Server

Versão mínima da api: 2015-06-15

properties.modelDefinitionApplied

string

Especifica se o modelo aplicado à máquina virtual é o modelo do conjunto de escala da máquina virtual ou o modelo personalizado para a máquina virtual.

properties.networkProfile

NetworkProfile

Especifica as interfaces de rede da máquina virtual.

properties.networkProfileConfiguration

VirtualMachineScaleSetVMNetworkProfileConfiguration

Especifica a configuração do perfil de rede da máquina virtual.

properties.osProfile

OSProfile

Especifica as configurações do sistema operacional para a máquina virtual.

properties.protectionPolicy

VirtualMachineScaleSetVMProtectionPolicy

Especifica a política de proteção da máquina virtual.

properties.provisioningState

string

O estado de provisionamento, que só aparece na resposta.

properties.securityProfile

SecurityProfile

Especifica as configurações de perfil relacionadas à segurança para a máquina virtual.

properties.storageProfile

StorageProfile

Especifica as configurações de armazenamento para os discos da máquina virtual.

properties.timeCreated

string

Especifica a hora em que o recurso de Máquina Virtual foi criado. Versão mínima api: 2021-11-01.

properties.userData

string

UserData para a VM, que deve ser codificada em base-64. O cliente não deve passar nenhum segredo aqui. Versão mínima da api: 2021-03-01

properties.vmId

string

ID exclusiva da VM do Azure.

resources

VirtualMachineExtension[]

Os recursos de extensão filho da máquina virtual.

sku

Sku

A máquina virtual SKU.

tags

object

Tags de recursos

type

string

Tipo de recurso

zones

string[]

As zonas da máquina virtual.

VirtualMachineScaleSetVMInstanceView

A exibição da instância da máquina virtual.

Name Tipo Description
assignedHost

string

ID de recurso do host dedicado, no qual a máquina virtual é alocada por meio do posicionamento automático, quando a máquina virtual está associada a um grupo de hosts dedicados que tem o posicionamento automático habilitado. Versão api mínima: 2020-06-01.

bootDiagnostics

BootDiagnosticsInstanceView

O Diagnóstico de Inicialização é um recurso de depuração que permite visualizar a saída do console e a captura de tela para diagnosticar o status da VM. Você pode visualizar facilmente a saída do log do console. O Azure também permite que você veja uma captura de tela da VM do hipervisor.

computerName

string

Especifica o nome do sistema operacional host da máquina virtual.

Esse nome não pode ser atualizado após a criação da VM.

Max-length (Windows): 15 caracteres

Max-length (Linux): 64 caracteres.

Para convenções e restrições de nomenclatura, consulte diretrizes de implementação de serviços de infraestrutura do Azure.

disks

DiskInstanceView[]

As informações dos discos.

extensions

VirtualMachineExtensionInstanceView[]

As informações de extensões.

hyperVGeneration

HyperVGeneration

A geração do hipervisor da Máquina Virtual [V1, V2]

maintenanceRedeployStatus

MaintenanceRedeployStatus

O status da Operação de Manutenção na máquina virtual.

osName

string

O sistema operacional em execução na máquina híbrida.

osVersion

string

A versão do sistema operacional em execução na máquina híbrida.

placementGroupId

string

O grupo de posicionamento no qual a VM está sendo executada. Se a VM for desalocada, ela não terá um placementGroupId.

platformFaultDomain

integer

A contagem de Domínio de Falha.

platformUpdateDomain

integer

A contagem de Domínio de Atualização.

rdpThumbPrint

string

A impressão digital do certificado da área de trabalho remota.

statuses

InstanceViewStatus[]

As informações de status do recurso.

vmAgent

VirtualMachineAgentInstanceView

O Agente de VM em execução na máquina virtual.

vmHealth

VirtualMachineHealthStatus

O status de integridade da VM.

VirtualMachineScaleSetVMListResult

A resposta de operação Listar Conjunto de Dimensionamento de Máquina Virtual VMs.

Name Tipo Description
nextLink

string

O uri para buscar a próxima página de VMs do Conjunto de Escala de Máquina Virtual. Chame ListNext() com isso para buscar a próxima página de VMs VMSS

value

VirtualMachineScaleSetVM[]

A lista de dimensionamento de máquina virtual define VMs.

VirtualMachineScaleSetVMNetworkProfileConfiguration

Especifica a configuração do perfil de rede da máquina virtual.

Name Tipo Description
networkInterfaceConfigurations

VirtualMachineScaleSetNetworkConfiguration[]

A lista de configurações de rede.

VirtualMachineScaleSetVMProtectionPolicy

Especifica a política de proteção da máquina virtual.

Name Tipo Description
protectFromScaleIn

boolean

Indica que a VM do conjunto de dimensionamento da máquina virtual não deve ser considerada para exclusão durante uma operação de expansão.

protectFromScaleSetActions

boolean

Indica que as atualizações ou ações de modelo (incluindo scale-in) iniciadas no conjunto de escala da máquina virtual não devem ser aplicadas à VM do conjunto de escala da máquina virtual.

VirtualMachineSizeTypes

Especifica o tamanho da máquina virtual. O tipo de dados enum está atualmente preterido e será removido até 23 de dezembro de 2023. A maneira recomendada de obter a lista de tamanhos disponíveis é usando estas APIs: Listar todos os tamanhos de máquina virtual disponíveis em um conjunto de disponibilidade, Listar todos os tamanhos de máquina virtual disponíveis em uma regiãoListar todos os tamanhos de máquina virtual disponíveis para redimensionamento. Para obter mais informações sobre tamanhos de máquinas virtuais, consulte tamanhos para máquinas virtuais. Os tamanhos de VM disponíveis dependem da região e do conjunto de disponibilidade.

Name Tipo Description
Basic_A0

string

Basic_A1

string

Basic_A2

string

Basic_A3

string

Basic_A4

string

Standard_A0

string

Standard_A1

string

Standard_A10

string

Standard_A11

string

Standard_A1_v2

string

Standard_A2

string

Standard_A2_v2

string

Standard_A2m_v2

string

Standard_A3

string

Standard_A4

string

Standard_A4_v2

string

Standard_A4m_v2

string

Standard_A5

string

Standard_A6

string

Standard_A7

string

Standard_A8

string

Standard_A8_v2

string

Standard_A8m_v2

string

Standard_A9

string

Standard_B1ms

string

Standard_B1s

string

Standard_B2ms

string

Standard_B2s

string

Standard_B4ms

string

Standard_B8ms

string

Standard_D1

string

Standard_D11

string

Standard_D11_v2

string

Standard_D12

string

Standard_D12_v2

string

Standard_D13

string

Standard_D13_v2

string

Standard_D14

string

Standard_D14_v2

string

Standard_D15_v2

string

Standard_D16_v3

string

Standard_D16s_v3

string

Standard_D1_v2

string

Standard_D2

string

Standard_D2_v2

string

Standard_D2_v3

string

Standard_D2s_v3

string

Standard_D3

string

Standard_D32_v3

string

Standard_D32s_v3

string

Standard_D3_v2

string

Standard_D4

string

Standard_D4_v2

string

Standard_D4_v3

string

Standard_D4s_v3

string

Standard_D5_v2

string

Standard_D64_v3

string

Standard_D64s_v3

string

Standard_D8_v3

string

Standard_D8s_v3

string

Standard_DS1

string

Standard_DS11

string

Standard_DS11_v2

string

Standard_DS12

string

Standard_DS12_v2

string

Standard_DS13

string

Standard_DS13-2_v2

string

Standard_DS13-4_v2

string

Standard_DS13_v2

string

Standard_DS14

string

Standard_DS14-4_v2

string

Standard_DS14-8_v2

string

Standard_DS14_v2

string

Standard_DS15_v2

string

Standard_DS1_v2

string

Standard_DS2

string

Standard_DS2_v2

string

Standard_DS3

string

Standard_DS3_v2

string

Standard_DS4

string

Standard_DS4_v2

string

Standard_DS5_v2

string

Standard_E16_v3

string

Standard_E16s_v3

string

Standard_E2_v3

string

Standard_E2s_v3

string

Standard_E32-16_v3

string

Standard_E32-8s_v3

string

Standard_E32_v3

string

Standard_E32s_v3

string

Standard_E4_v3

string

Standard_E4s_v3

string

Standard_E64-16s_v3

string

Standard_E64-32s_v3

string

Standard_E64_v3

string

Standard_E64s_v3

string

Standard_E8_v3

string

Standard_E8s_v3

string

Standard_F1

string

Standard_F16

string

Standard_F16s

string

Standard_F16s_v2

string

Standard_F1s

string

Standard_F2

string

Standard_F2s

string

Standard_F2s_v2

string

Standard_F32s_v2

string

Standard_F4

string

Standard_F4s

string

Standard_F4s_v2

string

Standard_F64s_v2

string

Standard_F72s_v2

string

Standard_F8

string

Standard_F8s

string

Standard_F8s_v2

string

Standard_G1

string

Standard_G2

string

Standard_G3

string

Standard_G4

string

Standard_G5

string

Standard_GS1

string

Standard_GS2

string

Standard_GS3

string

Standard_GS4

string

Standard_GS4-4

string

Standard_GS4-8

string

Standard_GS5

string

Standard_GS5-16

string

Standard_GS5-8

string

Standard_H16

string

Standard_H16m

string

Standard_H16mr

string

Standard_H16r

string

Standard_H8

string

Standard_H8m

string

Standard_L16s

string

Standard_L32s

string

Standard_L4s

string

Standard_L8s

string

Standard_M128-32ms

string

Standard_M128-64ms

string

Standard_M128ms

string

Standard_M128s

string

Standard_M64-16ms

string

Standard_M64-32ms

string

Standard_M64ms

string

Standard_M64s

string

Standard_NC12

string

Standard_NC12s_v2

string

Standard_NC12s_v3

string

Standard_NC24

string

Standard_NC24r

string

Standard_NC24rs_v2

string

Standard_NC24rs_v3

string

Standard_NC24s_v2

string

Standard_NC24s_v3

string

Standard_NC6

string

Standard_NC6s_v2

string

Standard_NC6s_v3

string

Standard_ND12s

string

Standard_ND24rs

string

Standard_ND24s

string

Standard_ND6s

string

Standard_NV12

string

Standard_NV24

string

Standard_NV6

string

VMDiskSecurityProfile

Especifica o perfil de segurança para o disco gerenciado.

Name Tipo Description
diskEncryptionSet

DiskEncryptionSetParameters

Especifica a ID do recurso do conjunto de criptografia de disco gerenciado pelo cliente para o disco gerenciado usado para a Chave Gerenciada do Cliente criptografada, o Disco do SO ConfidentialVM e o blob VMGuest.

securityEncryptionType

securityEncryptionTypes

Especifica o EncryptionType do disco gerenciado. Ele é definido como DiskWithVMGuestState para criptografia do disco gerenciado junto com o blob VMGuestState, VMGuestStateOnly para criptografia apenas do blob VMGuestState e NonPersistedTPM para não persistir o estado do firmware no blob VMGuestState. Nota: Ele pode ser definido apenas para VMs confidenciais.

VMSizeProperties

Especifica as propriedades para personalizar o tamanho da máquina virtual. Versão mínima api: 2021-07-01. Esse recurso ainda está no modo de visualização e não é suportado para VirtualMachineScaleSet. Siga as instruções em de personalização de VM para obter mais detalhes.

Name Tipo Description
vCPUsAvailable

integer

Especifica o número de vCPUs disponíveis para a VM. Quando essa propriedade não é especificada no corpo da solicitação, o comportamento padrão é defini-la com o valor de vCPUs disponíveis para esse tamanho de VM exposto na resposta da api de Listar todos os tamanhos de máquina virtual disponíveis em uma região.

vCPUsPerCore

integer

Especifica a relação vCPU para núcleo físico. Quando essa propriedade não é especificada no corpo da solicitação, o comportamento padrão é definido como o valor de vCPUsPerCore para o Tamanho da VM exposto na resposta da api de Listar todos os tamanhos de máquina virtual disponíveis em uma região. Definir essa propriedade como 1 também significa que o hyper-threading está desabilitado.

WindowsConfiguration

Especifica as configurações do sistema operacional Windows na máquina virtual.

Name Tipo Description
additionalUnattendContent

AdditionalUnattendContent[]

Especifica informações adicionais formatadas em XML codificadas em base 64 que podem ser incluídas no arquivo Unattend.xml, que é usado pela Instalação do Windows.

enableAutomaticUpdates

boolean

Indica se as Atualizações Automáticas estão habilitadas para a máquina virtual do Windows. O valor padrão é true. Para conjuntos de dimensionamento de máquina virtual, essa propriedade pode ser atualizada e as atualizações entrarão em vigor no reprovisionamento do sistema operacional.

enableVMAgentPlatformUpdates

boolean

Indica se as Atualizações da Plataforma VMAgent estão habilitadas para a Máquina Virtual do Windows.

patchSettings

PatchSettings

[Funcionalidade de pré-visualização] Especifica as configurações relacionadas ao patch de convidado de VM no Windows.

provisionVMAgent

boolean

Indica se o agente de máquina virtual deve ser provisionado na máquina virtual. Quando essa propriedade não é especificada no corpo da solicitação, ela é definida como true por padrão. Isso garantirá que o Agente de VM seja instalado na VM para que as extensões possam ser adicionadas à VM posteriormente.

timeZone

string

Especifica o fuso horário da máquina virtual. por exemplo, "Hora Padrão do Pacífico". Os valores possíveis podem ser TimeZoneInfo.Id valor de fusos horários retornados por TimeZoneInfo.GetSystemTimeZones.

winRM

WinRMConfiguration

Especifica os ouvintes do Gerenciamento Remoto do Windows. Isso habilita o Windows PowerShell remoto.

WindowsPatchAssessmentMode

Especifica o modo de avaliação de patch do convidado da VM para a máquina virtual IaaS.

Os valores possíveis são:

ImageDefault - Você controla o tempo das avaliações de patch em uma máquina virtual.

AutomaticByPlatform - A plataforma acionará avaliações periódicas de patches. A provisão de propriedadeVMAgent deve ser true.

Name Tipo Description
AutomaticByPlatform

string

ImageDefault

string

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Especifica a configuração de reinicialização para todas as operações de instalação do patch AutomaticByPlatform.

Name Tipo Description
Always

string

IfRequired

string

Never

string

Unknown

string

WindowsVMGuestPatchAutomaticByPlatformSettings

Especifica configurações adicionais para o modo de patch AutomaticByPlatform no VM Guest Patching no Windows.

Name Tipo Description
bypassPlatformSafetyChecksOnUserSchedule

boolean

Permite que o cliente agende patches sem atualizações acidentais

rebootSetting

WindowsVMGuestPatchAutomaticByPlatformRebootSetting

Especifica a configuração de reinicialização para todas as operações de instalação do patch AutomaticByPlatform.

WindowsVMGuestPatchMode

Especifica o modo de aplicação de patches de convidado de VM para máquina virtual IaaS ou máquinas virtuais associadas ao conjunto de dimensionamento de máquina virtual com OrchestrationMode como flexível.

Os valores possíveis são:

Manual - Você controla a aplicação de patches em uma máquina virtual. Para fazer isso, aplique patches manualmente dentro da VM. Neste modo, as atualizações automáticas são desativadas; a propriedade WindowsConfiguration.enableAutomaticUpdates deve ser false

AutomaticByOS - A máquina virtual será atualizada automaticamente pelo SO. A propriedade WindowsConfiguration.enableAutomaticUpdates deve ser true.

AutomaticByPlatform - a máquina virtual será atualizada automaticamente pela plataforma. As propriedades provisionVMAgent e WindowsConfiguration.enableAutomaticUpdates devem ser true

Name Tipo Description
AutomaticByOS

string

AutomaticByPlatform

string

Manual

string

WinRMConfiguration

Especifica os ouvintes do Gerenciamento Remoto do Windows. Isso habilita o Windows PowerShell remoto.

Name Tipo Description
listeners

WinRMListener[]

A lista de ouvintes do Gerenciamento Remoto do Windows

WinRMListener

A lista de ouvintes do Gerenciamento Remoto do Windows

Name Tipo Description
certificateUrl

string

Este é o URL de um certificado que foi carregado para o Cofre da Chave como um segredo. Para adicionar um segredo ao Cofre de Chaves, consulte Adicionar uma chave ou segredo ao Cofre de Chaves. Nesse caso, seu certificado precisa ser a codificação Base64 do seguinte objeto JSON que é codificado em UTF-8:

{
"dados":"",
"dataType":"pfx",
"senha":""
}
Para instalar certificados em uma máquina virtual, é recomendável usar a extensão de máquina virtual do Azure Key Vault para Linux ou a extensão de máquina virtual do Azure Key Vault para Windows.

protocol

ProtocolTypes

Especifica o protocolo do ouvinte do WinRM. Os valores possíveis são: httphttps.