Agents - Update

Serviço:

Storage Mover

Versão da API:

2024-07-01

Cria ou atualiza um recurso do Agente.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.StorageMover/storageMovers/{storageMoverName}/agents/{agentName}?api-version=2024-07-01

Parâmetros do URI

Name	Em	Necessário	Tipo	Description
agentName	path	True	string	O nome do recurso Agente.
resourceGroupName	path	True	string	O nome do grupo de recursos. O nome não diferencia maiúsculas de minúsculas.
storageMoverName	path	True	string	O nome do recurso Storage Mover.
subscriptionId	path	True	string	A ID da assinatura de destino.
api-version	query	True	string	A versão da API a ser usada para esta operação.

Corpo do Pedido

Name	Tipo	Description
properties.description	string	Uma descrição para o Agente.
properties.uploadLimitSchedule	UploadLimitSchedule	O agendamento de limite de upload de link WAN que se aplica a qualquer Execução de Trabalho executada pelo agente. As operações do plano de dados (migração de arquivos) são afetadas. As operações do plano de controle garantem uma funcionalidade de migração perfeita e não são limitadas por esse cronograma. O horário é interpretado com a hora local do agente.

Respostas

Name	Tipo	Description
200 OK	Agent	O recurso Agente.
Other Status Codes	ErrorResponse	Resposta de erro descrevendo por que a operação falhou.

Segurança

azure_auth

Fluxo OAuth2 do Azure Ative Directory.

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

Agents_Update

Pedido de amostra

HTTP

PATCH https://management.azure.com/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/examples-agentName?api-version=2024-07-01

{
  "properties": {
    "description": "Example Agent Description",
    "uploadLimitSchedule": {
      "weeklyRecurrences": [
        {
          "days": [
            "Monday"
          ],
          "startTime": {
            "hour": 9,
            "minute": 0
          },
          "endTime": {
            "hour": 18,
            "minute": 30
          },
          "limitInMbps": 2000
        }
      ]
    }
  }
}

Java

import com.azure.resourcemanager.storagemover.models.Agent;
import com.azure.resourcemanager.storagemover.models.DayOfWeek;
import com.azure.resourcemanager.storagemover.models.Minute;
import com.azure.resourcemanager.storagemover.models.Time;
import com.azure.resourcemanager.storagemover.models.UploadLimitSchedule;
import com.azure.resourcemanager.storagemover.models.UploadLimitWeeklyRecurrence;
import java.util.Arrays;

/**
 * Samples for Agents Update.
 */
public final class Main {
    /*
     * x-ms-original-file:
     * specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_Update.json
     */
    /**
     * Sample code: Agents_Update.
     * 
     * @param manager Entry point to StorageMoverManager.
     */
    public static void agentsUpdate(com.azure.resourcemanager.storagemover.StorageMoverManager manager) {
        Agent resource = manager.agents().getWithResponse("examples-rg", "examples-storageMoverName",
            "examples-agentName", com.azure.core.util.Context.NONE).getValue();
        resource.update().withDescription("Example Agent Description")
            .withUploadLimitSchedule(new UploadLimitSchedule().withWeeklyRecurrences(Arrays
                .asList(new UploadLimitWeeklyRecurrence().withStartTime(new Time().withHour(9).withMinute(Minute.ZERO))
                    .withEndTime(new Time().withHour(18).withMinute(Minute.THREE_ZERO))
                    .withDays(Arrays.asList(DayOfWeek.MONDAY)).withLimitInMbps(2000))))
            .apply();
    }
}

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

Python

from typing import Any, IO, Union

from azure.identity import DefaultAzureCredential

from azure.mgmt.storagemover import StorageMoverMgmtClient

"""
# PREREQUISITES
    pip install azure-identity
    pip install azure-mgmt-storagemover
# USAGE
    python agents_update.py

    Before run the sample, please set the values of the client ID, tenant ID and client secret
    of the AAD application as environment variables: AZURE_CLIENT_ID, AZURE_TENANT_ID,
    AZURE_CLIENT_SECRET. For more info about how to get the value, please see:
    https://docs.microsoft.com/azure/active-directory/develop/howto-create-service-principal-portal
"""


def main():
    client = StorageMoverMgmtClient(
        credential=DefaultAzureCredential(),
        subscription_id="60bcfc77-6589-4da2-b7fd-f9ec9322cf95",
    )

    response = client.agents.update(
        resource_group_name="examples-rg",
        storage_mover_name="examples-storageMoverName",
        agent_name="examples-agentName",
        agent={
            "properties": {
                "description": "Example Agent Description",
                "uploadLimitSchedule": {
                    "weeklyRecurrences": [
                        {
                            "days": ["Monday"],
                            "endTime": {"hour": 18, "minute": 30},
                            "limitInMbps": 2000,
                            "startTime": {"hour": 9, "minute": 0},
                        }
                    ]
                },
            }
        },
    )
    print(response)


# x-ms-original-file: specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_Update.json
if __name__ == "__main__":
    main()

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

Go

package armstoragemover_test

import (
	"context"
	"log"

	"github.com/Azure/azure-sdk-for-go/sdk/azcore/to"
	"github.com/Azure/azure-sdk-for-go/sdk/azidentity"
	"github.com/Azure/azure-sdk-for-go/sdk/resourcemanager/storagemover/armstoragemover/v2"
)

// Generated from example definition: https://github.com/Azure/azure-rest-api-specs/blob/4ee6d9fd7687d4b67117c5a167c191a7e7e70b53/specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_Update.json
func ExampleAgentsClient_Update() {
	cred, err := azidentity.NewDefaultAzureCredential(nil)
	if err != nil {
		log.Fatalf("failed to obtain a credential: %v", err)
	}
	ctx := context.Background()
	clientFactory, err := armstoragemover.NewClientFactory("<subscription-id>", cred, nil)
	if err != nil {
		log.Fatalf("failed to create client: %v", err)
	}
	res, err := clientFactory.NewAgentsClient().Update(ctx, "examples-rg", "examples-storageMoverName", "examples-agentName", armstoragemover.AgentUpdateParameters{
		Properties: &armstoragemover.AgentUpdateProperties{
			Description: to.Ptr("Example Agent Description"),
			UploadLimitSchedule: &armstoragemover.UploadLimitSchedule{
				WeeklyRecurrences: []*armstoragemover.UploadLimitWeeklyRecurrence{
					{
						LimitInMbps: to.Ptr[int32](2000),
						EndTime: &armstoragemover.Time{
							Hour:   to.Ptr[int32](18),
							Minute: to.Ptr(armstoragemover.Minute(30)),
						},
						StartTime: &armstoragemover.Time{
							Hour:   to.Ptr[int32](9),
							Minute: to.Ptr(armstoragemover.Minute(0)),
						},
						Days: []*armstoragemover.DayOfWeek{
							to.Ptr(armstoragemover.DayOfWeekMonday)},
					}},
			},
		},
	}, nil)
	if err != nil {
		log.Fatalf("failed to finish the request: %v", err)
	}
	// You could use response here. We use blank identifier for just demo purposes.
	_ = res
	// If the HTTP response code is 200 as defined in example definition, your response structure would look as follows. Please pay attention that all the values in the output are fake values for just demo purposes.
	// res.Agent = armstoragemover.Agent{
	// 	Name: to.Ptr("examples-agentName"),
	// 	Type: to.Ptr("Microsoft.StorageMover/storageMovers/agents"),
	// 	ID: to.Ptr("/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/examples-agentName"),
	// 	SystemData: &armstoragemover.SystemData{
	// 		CreatedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-07-01T01:01:01.107Z"); return t}()),
	// 		CreatedBy: to.Ptr("string"),
	// 		CreatedByType: to.Ptr(armstoragemover.CreatedByTypeUser),
	// 		LastModifiedAt: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-07-01T02:01:01.107Z"); return t}()),
	// 		LastModifiedBy: to.Ptr("string"),
	// 		LastModifiedByType: to.Ptr(armstoragemover.CreatedByTypeUser),
	// 	},
	// 	Properties: &armstoragemover.AgentProperties{
	// 		Description: to.Ptr("Example Agent Description"),
	// 		AgentStatus: to.Ptr(armstoragemover.AgentStatusOnline),
	// 		AgentVersion: to.Ptr("1.0.0"),
	// 		ArcResourceID: to.Ptr("/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName"),
	// 		ArcVMUUID: to.Ptr("3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9"),
	// 		LastStatusUpdate: to.Ptr(func() time.Time { t, _ := time.Parse(time.RFC3339Nano, "2023-07-01T02:21:01.107Z"); return t}()),
	// 		LocalIPAddress: to.Ptr("192.168.0.0"),
	// 		MemoryInMB: to.Ptr[int64](4096),
	// 		NumberOfCores: to.Ptr[int64](8),
	// 		ProvisioningState: to.Ptr(armstoragemover.ProvisioningStateSucceeded),
	// 		TimeZone: to.Ptr("Eastern Standard Time"),
	// 		UploadLimitSchedule: &armstoragemover.UploadLimitSchedule{
	// 			WeeklyRecurrences: []*armstoragemover.UploadLimitWeeklyRecurrence{
	// 				{
	// 					LimitInMbps: to.Ptr[int32](2000),
	// 					EndTime: &armstoragemover.Time{
	// 						Hour: to.Ptr[int32](18),
	// 						Minute: to.Ptr(armstoragemover.Minute(30)),
	// 					},
	// 					StartTime: &armstoragemover.Time{
	// 						Hour: to.Ptr[int32](9),
	// 						Minute: to.Ptr(armstoragemover.Minute(0)),
	// 					},
	// 					Days: []*armstoragemover.DayOfWeek{
	// 						to.Ptr(armstoragemover.DayOfWeekMonday)},
	// 				}},
	// 			},
	// 			UptimeInSeconds: to.Ptr[int64](522),
	// 		},
	// 	}
}

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

JavaScript

const { StorageMoverClient } = require("@azure/arm-storagemover");
const { DefaultAzureCredential } = require("@azure/identity");

/**
 * This sample demonstrates how to Creates or updates an Agent resource.
 *
 * @summary Creates or updates an Agent resource.
 * x-ms-original-file: specification/storagemover/resource-manager/Microsoft.StorageMover/stable/2024-07-01/examples/Agents_Update.json
 */
async function agentsUpdate() {
  const subscriptionId =
    process.env["STORAGEMOVER_SUBSCRIPTION_ID"] || "60bcfc77-6589-4da2-b7fd-f9ec9322cf95";
  const resourceGroupName = process.env["STORAGEMOVER_RESOURCE_GROUP"] || "examples-rg";
  const storageMoverName = "examples-storageMoverName";
  const agentName = "examples-agentName";
  const agent = {
    description: "Example Agent Description",
    uploadLimitSchedule: {
      weeklyRecurrences: [
        {
          days: ["Monday"],
          endTime: { hour: 18, minute: 30 },
          limitInMbps: 2000,
          startTime: { hour: 9, minute: 0 },
        },
      ],
    },
  };
  const credential = new DefaultAzureCredential();
  const client = new StorageMoverClient(credential, subscriptionId);
  const result = await client.agents.update(resourceGroupName, storageMoverName, agentName, agent);
  console.log(result);
}

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

Resposta da amostra

Código de estado:

200

{
  "properties": {
    "arcResourceId": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.HybridCompute/machines/examples-hybridComputeName",
    "arcVmUuid": "3bb2c024-eba9-4d18-9e7a-1d772fcc5fe9",
    "description": "Example Agent Description",
    "agentVersion": "1.0.0",
    "agentStatus": "Online",
    "lastStatusUpdate": "2023-07-01T02:21:01.1075056Z",
    "localIPAddress": "192.168.0.0",
    "memoryInMB": 4096,
    "numberOfCores": 8,
    "uptimeInSeconds": 522,
    "timeZone": "Eastern Standard Time",
    "uploadLimitSchedule": {
      "weeklyRecurrences": [
        {
          "days": [
            "Monday"
          ],
          "startTime": {
            "hour": 9,
            "minute": 0
          },
          "endTime": {
            "hour": 18,
            "minute": 30
          },
          "limitInMbps": 2000
        }
      ]
    },
    "provisioningState": "Succeeded"
  },
  "systemData": {
    "createdBy": "string",
    "createdByType": "User",
    "createdAt": "2023-07-01T01:01:01.1075056Z",
    "lastModifiedBy": "string",
    "lastModifiedByType": "User",
    "lastModifiedAt": "2023-07-01T02:01:01.1075056Z"
  },
  "id": "/subscriptions/60bcfc77-6589-4da2-b7fd-f9ec9322cf95/resourceGroups/examples-rg/providers/Microsoft.StorageMover/storageMovers/examples-storageMoverName/agents/examples-agentName",
  "name": "examples-agentName",
  "type": "Microsoft.StorageMover/storageMovers/agents"
}

Definições

Name	Description
Agent	O recurso Agente.
AgentStatus	O status do agente.
AgentUpdateParameters	O recurso Agente.
createdByType	O tipo de identidade que criou o recurso.
DayOfWeek	O dia da semana.
ErrorAdditionalInfo	O erro de gerenciamento de recursos informações adicionais.
ErrorDetail	O detalhe do erro.
ErrorDetails
ErrorResponse	Resposta de erro
Minute	O elemento minúsculo do tempo. Os valores permitidos são 0 e 30. Se não for especificado, seu valor será padronizado como 0.
ProvisioningState	O estado de provisionamento de um recurso.
systemData	Metadados referentes à criação e última modificação do recurso.
Time	A hora do dia.
UploadLimitSchedule	O cronograma de limite de upload de link WAN. Não são permitidas recorrências sobrepostas.
UploadLimitWeeklyRecurrence	A recorrência semanal do cronograma de limite de upload de link WAN. A hora de início deve ser mais cedo do que a hora de fim. A recorrência não deve abranger vários dias.

Agent

O recurso Agente.

Name	Tipo	Description
id	string	ID de recurso totalmente qualificado para o recurso. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}
name	string	O nome do recurso
properties.agentStatus	AgentStatus	O status do agente.
properties.agentVersion	string	A versão do agente.
properties.arcResourceId	string	O ID de recurso totalmente qualificado do recurso de computação híbrida para o agente.
properties.arcVmUuid	string	O UUID VM do recurso de computação híbrida para o agente.
properties.description	string	Uma descrição para o Agente.
properties.errorDetails	ErrorDetails
properties.lastStatusUpdate	string	A última hora atualizada do status do Agente.
properties.localIPAddress	string	Endereço IP local reportado pelo Agente.
properties.memoryInMB	integer	Memória disponível reportada pelo Agente, em MB.
properties.numberOfCores	integer	Núcleos de computação disponíveis relatados pelo Agente.
properties.provisioningState	ProvisioningState	O estado de provisionamento deste recurso.
properties.timeZone	string	O fuso horário local do agente representado no formato Windows.
properties.uploadLimitSchedule	UploadLimitSchedule	O agendamento de limite de upload de link WAN que se aplica a qualquer Execução de Trabalho executada pelo agente. As operações do plano de dados (migração de arquivos) são afetadas. As operações do plano de controle garantem uma funcionalidade de migração perfeita e não são limitadas por esse cronograma. O horário é interpretado com a hora local do agente.
properties.uptimeInSeconds	integer	Uptime do Agente em segundos.
systemData	systemData	Metadados do sistema de recursos.
type	string	O tipo do recurso. Por exemplo, "Microsoft.Compute/virtualMachines" ou "Microsoft.Storage/storageAccounts"

AgentStatus

O status do agente.

Name	Tipo	Description
Executing	string
Offline	string
Online	string
Registering	string
RequiresAttention	string
Unregistering	string

AgentUpdateParameters

O recurso Agente.

Name	Tipo	Description
properties.description	string	Uma descrição para o Agente.
properties.uploadLimitSchedule	UploadLimitSchedule	O agendamento de limite de upload de link WAN que se aplica a qualquer Execução de Trabalho executada pelo agente. As operações do plano de dados (migração de arquivos) são afetadas. As operações do plano de controle garantem uma funcionalidade de migração perfeita e não são limitadas por esse cronograma. O horário é interpretado com a hora local do agente.

createdByType

O tipo de identidade que criou o recurso.

Name	Tipo	Description
Application	string
Key	string
ManagedIdentity	string
User	string

DayOfWeek

O dia da semana.

Name	Tipo	Description
Friday	string
Monday	string
Saturday	string
Sunday	string
Thursday	string
Tuesday	string
Wednesday	string

ErrorAdditionalInfo

O erro de gerenciamento de recursos informações adicionais.

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

ErrorDetail

O detalhe do erro.

Name	Tipo	Description
additionalInfo	ErrorAdditionalInfo[]	O erro informações adicionais.
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.

ErrorDetails

Name	Tipo	Description
code	string	Código de erro relatado pelo agente
message	string	Descrição expandida do código de erro reportado

ErrorResponse

Resposta de erro

Name	Tipo	Description
error	ErrorDetail	O objeto de erro.

Minute

O elemento minúsculo do tempo. Os valores permitidos são 0 e 30. Se não for especificado, seu valor será padronizado como 0.

Name	Tipo	Description
0	Integer
30	Integer

ProvisioningState

O estado de provisionamento de um recurso.

Name	Tipo	Description
Canceled	string
Deleting	string
Failed	string
Succeeded	string

systemData

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

Name	Tipo	Description
createdAt	string	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	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.

Time

A hora do dia.

Name	Tipo	Default value	Description
hour	integer		O elemento hora do tempo. Os valores permitidos variam de 0 (início do dia selecionado) a 24 (final do dia selecionado). O valor de hora 24 não pode ser combinado com qualquer outro valor de minuto além de 0.
minute	Minute	0	O elemento minúsculo do tempo. Os valores permitidos são 0 e 30. Se não for especificado, seu valor será padronizado como 0.

UploadLimitSchedule

O cronograma de limite de upload de link WAN. Não são permitidas recorrências sobrepostas.

Name	Tipo	Description
weeklyRecurrences	UploadLimitWeeklyRecurrence[]	O conjunto de recorrências semanais repetidas do cronograma de limite de upload de link WAN.

UploadLimitWeeklyRecurrence

A recorrência semanal do cronograma de limite de upload de link WAN. A hora de início deve ser mais cedo do que a hora de fim. A recorrência não deve abranger vários dias.

Name	Tipo	Description
days	DayOfWeek[]	O conjunto de dias da semana para a recorrência do cronograma. Um dia não deve ser especificado mais de uma vez em caso de recorrência.
endTime	Time	A hora de término da recorrência do cronograma. São suportados intervalos de horas completas e 30 minutos.
limitInMbps	integer	A largura de banda de upload de link WAN (taxa máxima de transferência de dados) em megabits por segundo. O valor 0 indica que nenhuma taxa de transferência é permitida e qualquer trabalho de migração em execução é efetivamente pausado durante essa recorrência. Apenas as operações do plano de dados são regidas por este limite. As operações do plano de controle garantem uma funcionalidade perfeita. O agente pode exceder esse limite com mensagens de controle, se necessário.
startTime	Time	A hora de início da recorrência do cronograma. São suportados intervalos de horas completas e 30 minutos.