Guest Agents - Create

Referência

Serviço:: Azure Arc enabled SCVMM

Versão da API:: 2025-03-13

Implementa o método PUT do GuestAgent.
Criar ou atualizar GuestAgent.

PUT https://management.azure.com/{resourceUri}/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default?api-version=2025-03-13

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 minLength: 1	A versão da API a utilizar para esta operação.

Corpo da solicitação

Nome	Tipo	Description
properties.credentials	GuestCredential	Credenciais de nome de usuário/senha para provisionar o agente convidado.
properties.httpProxyConfig	HttpProxyConfiguration	Configuração do Proxy HTTP para a VM.
properties.privateLinkScopeResourceId	string (arm-id)	A ID do recurso do escopo do link privado ao qual este computador é atribuído, se houver.
properties.provisioningAction	ProvisioningAction	Obtém ou define a ação de provisionamento do agente convidado.

Respostas

Nome	Tipo	Description
200 OK	GuestAgent	Operação de atualização 'GuestAgent' do recurso bem-sucedida
201 Created	GuestAgent	Operação de criação de recurso 'GuestAgent' bem-sucedida Cabeçalhos Retry-After: integer
Other Status Codes	ErrorResponse	Uma resposta de erro inesperada.

Nome

Tipo

Description

200 OK

GuestAgent

Operação de atualização 'GuestAgent' do recurso bem-sucedida

201 Created

GuestAgent

Operação de criação de recurso 'GuestAgent' bem-sucedida

Cabeçalhos

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

GuestAgents_Create_MaximumSet

GuestAgents_Create_MinimumSet

GuestAgents_Create_MaximumSet

Solicitação de exemplo

HTTP

PUT https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default?api-version=2025-03-13

{
  "properties": {
    "credentials": {
      "username": "jqxuwirrcpfv",
      "password": "gkvbnmuahumuoibvscoxzfdqwvfuf"
    },
    "httpProxyConfig": {
      "httpsProxy": "uoyzyticmohohomlkwct"
    },
    "provisioningAction": "install"
  }
}

Resposta de exemplo

Código de status:: 200

{
  "properties": {
    "uuid": "hbsgztyakewtgbuxbesezncnzu",
    "credentials": {
      "username": "jqxuwirrcpfv"
    },
    "httpProxyConfig": {
      "httpsProxy": "uoyzyticmohohomlkwct"
    },
    "provisioningAction": "install",
    "status": "jpoukrzfenzrmjdahimkl",
    "customResourceName": "mhqymxkapuvsugd",
    "provisioningState": "Succeeded",
    "privateLinkScopeResourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkResourceName"
  },
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default",
  "name": "rwecpthzyt",
  "type": "dkcgcbtlwtsedxzhvtu",
  "systemData": {
    "createdBy": "p",
    "createdByType": "User",
    "createdAt": "2024-01-29T22:28:00.094Z",
    "lastModifiedBy": "goxcwpyyqlxndquly",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-01-29T22:28:00.095Z"
  }
}

Código de status:: 201

Azure-AsyncOperation: https://contoso.com/operationstatus

{
  "properties": {
    "uuid": "hbsgztyakewtgbuxbesezncnzu",
    "credentials": {
      "username": "jqxuwirrcpfv"
    },
    "httpProxyConfig": {
      "httpsProxy": "uoyzyticmohohomlkwct"
    },
    "provisioningAction": "install",
    "status": "jpoukrzfenzrmjdahimkl",
    "customResourceName": "mhqymxkapuvsugd",
    "provisioningState": "Succeeded",
    "privateLinkScopeResourceId": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.HybridCompute/privateLinkScopes/privateLinkResourceName"
  },
  "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default",
  "name": "rwecpthzyt",
  "type": "dkcgcbtlwtsedxzhvtu",
  "systemData": {
    "createdBy": "p",
    "createdByType": "User",
    "createdAt": "2024-01-29T22:28:00.094Z",
    "lastModifiedBy": "goxcwpyyqlxndquly",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2024-01-29T22:28:00.095Z"
  }
}

GuestAgents_Create_MinimumSet

Solicitação de exemplo

HTTP

PUT https://management.azure.com/gtgclehcbsyave/providers/Microsoft.ScVmm/virtualMachineInstances/default/guestAgents/default?api-version=2025-03-13

{}

Resposta de exemplo

Código de status:: 200

{}

Código de status:: 201

Azure-AsyncOperation: https://contoso.com/operationstatus

{}

Definições

Nome	Description
createdByType	O tipo de identidade que criou o recurso.
ErrorAdditionalInfo	As informações adicionais do erro de gerenciamento de recursos.
ErrorDetail	O detalhe do erro.
ErrorResponse	Resposta de erro
GuestAgent	Define o GuestAgent.
GuestCredential	Credenciais de nome de usuário/senha para se conectar ao convidado.
HttpProxyConfiguration	Configuração do Proxy HTTP para a VM.
ProvisioningAction	Ação de provisionamento do agente convidado.
ProvisioningState	O estado de provisionamento do recurso.
systemData	Metadados relativos à criação e última modificação do recurso.

createdByType

Enumeração

O tipo de identidade que criou o recurso.

Valor	Description
Application
Key
ManagedIdentity
User

ErrorAdditionalInfo

Objeto

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

Objeto

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

Objeto

Resposta de erro

Nome	Tipo	Description
error	ErrorDetail	O objeto de erro.

GuestAgent

Objeto

Define o GuestAgent.

Nome	Tipo	Description
id	string (arm-id)	ID de recurso totalmente qualificada para o recurso. Por exemplo, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}"
name	string	O nome do recurso
properties.credentials	GuestCredential	Credenciais de nome de usuário/senha para provisionar o agente convidado.
properties.customResourceName	string	Obtém o nome do recurso correspondente no Kubernetes.
properties.httpProxyConfig	HttpProxyConfiguration	Configuração do Proxy HTTP para a VM.
properties.privateLinkScopeResourceId	string (arm-id)	A ID do recurso do escopo do link privado ao qual este computador é atribuído, se houver.
properties.provisioningAction	ProvisioningAction	Obtém ou define a ação de provisionamento do agente convidado.
properties.provisioningState	ProvisioningState	Estado de provisionamento do recurso.
properties.status	string	Obtém o status do agente convidado.
properties.uuid	string	Obtém um identificador exclusivo para esse recurso.
systemData	systemData	Metadados do Azure Resource Manager que contêm informações createdBy e modifiedBy.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

GuestCredential

Objeto

Credenciais de nome de usuário/senha para se conectar ao convidado.

Nome	Tipo	Description
password	string (password)	Obtém ou define a senha para se conectar com o convidado.
username	string	Obtém ou define o nome de usuário para se conectar ao convidado.

HttpProxyConfiguration

Objeto

Configuração do Proxy HTTP para a VM.

Nome	Tipo	Description
httpsProxy	string	Obtém ou define a URL httpsProxy.

ProvisioningAction

Enumeração

Ação de provisionamento do agente convidado.

Valor	Description
install	Instale o agente convidado.
repair	Reparar agente convidado.
uninstall	Desinstale o agente convidado.

ProvisioningState

Enumeração

O estado de provisionamento do recurso.

Valor	Description
Accepted	O recurso foi aceito.
Canceled	A criação de recursos foi cancelada.
Created	O recurso foi criado.
Deleting	O recurso está sendo excluído.
Failed	Falha na criação de recursos.
Provisioning	O recurso está sendo provisionado.
Succeeded	O recurso foi criado.
Updating	O recurso está sendo atualizado.

systemData

Objeto

Metadados relativos à criação e última modificação do recurso.

Nome	Tipo	Description
createdAt	string (date-time)	O carimbo de data/hora da criação de recursos (UTC).
createdBy	string	A identidade que criou o recurso.
createdByType	createdByType	O tipo de identidade que criou o recurso.
lastModifiedAt	string (date-time)	O carimbo de data/hora da última modificação do recurso (UTC)
lastModifiedBy	string	A identidade que modificou o recurso pela última vez.
lastModifiedByType	createdByType	O tipo de identidade que modificou o recurso pela última vez.

Compartilhar via

Guest Agents - Create

Parâmetros de URI

Corpo da solicitação

Respostas

Segurança

azure_auth

Escopos

Exemplos

GuestAgents_Create_MaximumSet

Solicitação de exemplo

Resposta de exemplo

GuestAgents_Create_MinimumSet

Solicitação de exemplo

Resposta de exemplo

Definições

createdByType

ErrorAdditionalInfo

ErrorDetail

ErrorResponse

GuestAgent

GuestCredential

HttpProxyConfiguration

ProvisioningAction

ProvisioningState

systemData