Management Zones - Create Cascade Delete Job

Serviço:

Azure Data Manager for Agriculture

Versão da API:

2023-11-01-preview

Crie um trabalho de exclusão em cascata para a zona de gerenciamento especificada.

PUT {endpoint}/management-zones/cascade-delete/{jobId}?partyId={partyId}&managementZoneId={managementZoneId}&api-version=2023-11-01-preview

Parâmetros de URI

Nome	Em	Obrigatório	Tipo	Description
endpoint	path	True	string uri	O nome do host do namespace, por exemplo, admaInstanceName.farmbeats.azure.net
jobId	path	True	string	ID do trabalho fornecida pelo usuário final.
api-version	query	True	string	A versão da API solicitada
managementZoneId	query	True	string	ID da zona de gerenciamento a ser excluída.
partyId	query	True	string	ID da parte associada.

Cabeçalho da solicitação

Nome	Obrigatório	Tipo	Description
Authorization	True	string	Forneça um token de portador válido para chamadas à API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se você já tentou chamadas não autenticadas antes.

Respostas

Nome	Tipo	Description
202 Accepted	CascadeDeleteJob	Aceito
Other Status Codes	ErrorResponse	Erro Cabeçalhos x-ms-error-code: string

Segurança

Authorization

Forneça um token de portador válido para chamadas à API autorizadas. Observe que talvez seja necessário limpar o cache do navegador se você já tentou chamadas não autenticadas antes.

Tipo: apiKey
Em: header

Exemplos

ManagementZones_CreateCascadeDeleteJob

Solicitação de exemplo

HTTP

PUT {endpoint}/management-zones/cascade-delete/JOB123?partyId=PARTY123&managementZoneId=MANAGEMENTZONE123&api-version=2023-11-01-preview

Resposta de exemplo

Código de status:

202

{
  "id": "JOB123",
  "status": "Succeeded",
  "message": "Job completed successfully.",
  "durationInSeconds": 14.7977857,
  "createdDateTime": "2021-04-19T11:31:20Z",
  "lastActionDateTime": "2021-04-19T11:31:34Z",
  "startTime": "2021-04-19T11:31:19Z",
  "endTime": "2021-04-19T11:31:34Z",
  "partyId": "PARTY123",
  "resourceId": "MANAGEMENTZONE123",
  "resourceType": "managementzone"
}

Definições

Nome	Description
CascadeDeleteJob	Esquema do trabalho de exclusão em cascata.
Error	Um erro do serviço AgPlatform do Azure.
ErrorResponse	Uma resposta de erro do serviço AgPlatform do Azure. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses o documento de referência ErrorResponse.
InnerError	Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.
JobStatus	Status do trabalho. Valores possíveis: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.

CascadeDeleteJob

Esquema do trabalho de exclusão em cascata.

Nome	Tipo	Description
createdDateTime	string	Trabalho criado em dateTime. Formato de exemplo: aaaa-MM-ddTHH:mm:ssZ.
durationInSeconds	number	Duração do trabalho em segundos.
endTime	string	Hora de término do trabalho quando disponível. Formato de exemplo: aaaa-MM-ddTHH:mm:ssZ.
errorCode	string	Código de erro quando o trabalho falhou.
id	string	ID de trabalho exclusiva.
lastActionDateTime	string	O trabalho foi agido pela última vez em dateTime. Formato de exemplo: aaaa-MM-ddTHH:mm:ssZ.
message	string	Mensagem de status para capturar mais detalhes do trabalho.
partyId	string	ID da festa.
resourceId	string	A ID do recurso.
resourceType	string	Tipo do recurso.
startTime	string	Hora de início do trabalho quando disponível. Formato de exemplo: aaaa-MM-ddTHH:mm:ssZ.
status	JobStatus	Status do trabalho. Valores possíveis: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.

Error

Um erro do serviço AgPlatform do Azure.

Nome	Tipo	Description
code	string	Conjunto definido pelo servidor de códigos de erro.
details	Error[]	Matriz de detalhes sobre erros específicos que levaram a esse erro relatado.
innererror	InnerError	Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.
message	string	Representação legível ao olho humano do erro.
target	string	Destino do erro.

ErrorResponse

Uma resposta de erro do serviço AgPlatform do Azure. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#7102-error-condition-responses o documento de referência ErrorResponse.

Nome	Tipo	Description
error	Error	Um erro do serviço AgPlatform do Azure.
traceId	string	ID de rastreamento exclusiva.

InnerError

Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.

Nome	Tipo	Description
code	string	Código de erro específico que foi fornecido pelo erro que o contém.
innererror	InnerError	Erro interno que contém a lista de erros. Consulte https://github.com/Microsoft/api-guidelines/blob/vNext/Guidelines.md#innererror--object o documento de referência InnerError.

JobStatus

Status do trabalho. Valores possíveis: 'Waiting', 'Running', 'Succeeded', 'Failed', 'Cancelled'.

Nome	Tipo	Description
Cancelled	string
Failed	string
Running	string
Succeeded	string
Waiting	string