Virtual Machine Instances - Stop

Serviço:

Azure Arc enabled SCVMM

Versão da API:

2024-06-01

Implementa a operação para interromper uma máquina virtual.
A operação para desligar (parar) uma instância de máquina virtual.

POST https://management.azure.com/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/stop?api-version=2024-06-01

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
resourceUri	path	True	string	O identificador totalmente qualificado do Azure Resource Manager do recurso.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo da solicitação

Nome	Tipo	Description
skipShutdown	SkipShutdown	Obtém ou define um valor que indica se a solicitação de desligamento de VM não normal deve ser solicitada. O valor verdadeiro para esse sinalizador indica o desligamento não normal, enquanto false indica o contrário. O padrão é false.

Respostas

Nome	Tipo	Description
202 Accepted		Operação de recurso aceita. Cabeçalhos Location: string Retry-After: integer
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Segurança

azure_auth

Fluxo OAuth2 do Azure Active Directory.

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

Escopos

Nome	Description
user_impersonation	representar sua conta de usuário

Exemplos

VirtualMachineInstances_Stop_MaximumSet

VirtualMachineInstances_Stop_MinimumSet

VirtualMachineInstances_Stop_MaximumSet

Solicitação de exemplo

HTTP

POST https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default/stop?api-version=2024-06-01

{
  "skipShutdown": "true"
}

Resposta de exemplo

Código de status:

202

location: https://contoso.com/operationstatus

VirtualMachineInstances_Stop_MinimumSet

Solicitação de exemplo

HTTP

POST https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default/stop?api-version=2024-06-01

{}

Resposta de exemplo

Código de status:

202

location: https://contoso.com/operationstatus

Definições

Nome	Description
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
SkipShutdown	Obtém ou define um valor que indica se a solicitação de desligamento de VM não normal deve ser solicitada. O valor verdadeiro para esse sinalizador indica o desligamento não normal, enquanto false indica o contrário. O padrão é false.
StopVirtualMachineOptions	Define as propriedades de ação de parada.

ErrorAdditionalInfo

As informações adicionais do erro de gerenciamento de recursos.

Nome	Tipo	Description
info	object	As informações adicionais.
type	string	O tipo de informação adicional.

ErrorDetail

O detalhe do erro.

Nome	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	As informações adicionais do erro.
code	string	O código de erro.
details	ErrorDetail[]	Os detalhes do erro.
message	string	A mensagem de erro.
target	string	O destino do erro.

ErrorResponse

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

SkipShutdown

Obtém ou define um valor que indica se a solicitação de desligamento de VM não normal deve ser solicitada. O valor verdadeiro para esse sinalizador indica o desligamento não normal, enquanto false indica o contrário. O padrão é false.

Nome	Tipo	Description
false	string	Desabilitar ignorar desligamento.
true	string	Habilitar o desligamento de ignorar.

StopVirtualMachineOptions

Define as propriedades de ação de parada.

Nome	Tipo	Valor padrão	Description
skipShutdown	SkipShutdown	false	Obtém ou define um valor que indica se a solicitação de desligamento de VM não normal deve ser solicitada. O valor verdadeiro para esse sinalizador indica o desligamento não normal, enquanto false indica o contrário. O padrão é false.