Partilhar via

Path - Lease

  • Referência
Serviço:
Storage Services
Versão da API:
2023-08-03

Caminho da Concessão
Crie e faça a gestão de uma concessão para restringir o acesso de escrita e eliminação ao caminho. Esta operação suporta pedidos HTTP condicionais. Para obter mais informações, veja Especificar Cabeçalhos Condicionais para Operações do Serviço Blob.

POST https://{accountName}.{dnsSuffix}/{filesystem}/{path}
Com parâmetros opcionais: 
POST https://{accountName}.{dnsSuffix}/{filesystem}/{path}?timeout={timeout}

Parâmetros do URI

Name Em Necessário Tipo Description
accountName
 path True

string

O nome da conta de Armazenamento do Azure.
dnsSuffix
 path True

string

O sufixo DNS para o ponto final Azure Data Lake Storage.
filesystem
 path True

string

O identificador do sistema de ficheiros.

Padrão Regex: ^[$a-z0-9](?!.*--)[-a-z0-9]{1,61}[a-z0-9]$
path
 path True

string

O caminho do ficheiro ou diretório.
timeout
 query

integer

int32

Um valor de tempo limite de operação opcional em segundos. O período começa quando o pedido é recebido pelo serviço. Se o valor de tempo limite terminar antes da conclusão da operação, a operação falhará.

Cabeçalho do Pedido

Name Necessário Tipo Description
x-ms-lease-action True

PathLeaseAction

Existem cinco ações de concessão: "adquirir", "break", "change", "renew" e "release". Utilize "acquire" e especifique o "x-ms-proposed-lease-id" e "x-ms-lease-duration" para adquirir uma nova concessão. Utilize "break" para interromper uma concessão existente. Quando uma concessão é interrompida, o período de interrupção da concessão é permitido decorrido, período durante o qual não é possível executar nenhuma operação de concessão, exceto quebra e lançamento no ficheiro. Quando uma concessão é quebrada com êxito, a resposta indica o intervalo em segundos até que uma nova concessão possa ser adquirida. Utilize "alterar" e especifique o ID de concessão atual em "x-ms-lease-id" e o novo ID de concessão em "x-ms-proposed-lease-id" para alterar o ID de concessão de uma concessão ativa. Utilize "renovar" e especifique o "x-ms-lease-id" para renovar uma concessão existente. Utilize "release" e especifique o "x-ms-lease-id" para libertar uma concessão.
x-ms-lease-duration

integer

int32

A duração da concessão é necessária para adquirir uma concessão e especifica a duração da concessão em segundos. A duração da concessão tem de estar entre 15 e 60 segundos ou -1 para concessão infinita.
x-ms-lease-break-period

integer

int32

A duração do período de interrupção da concessão é opcional para interromper uma concessão e especifica o período de interrupção da concessão em segundos. A duração da quebra de concessão tem de estar entre 0 e 60 segundos.
x-ms-lease-id

string

Necessário quando "x-ms-lease-action" for "renew", "change" ou "release". Para as ações de renovação e lançamento, esta ação tem de corresponder ao ID de concessão atual.

Padrão Regex: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
x-ms-proposed-lease-id

string

Necessário quando "x-ms-lease-action" é "acquire" ou "change". Uma concessão será adquirida com este ID de concessão se a operação for bem-sucedida.

Padrão Regex: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
If-Match

string

Opcional. Um valor ETag. Especifique este cabeçalho para executar a operação apenas se o ETag do recurso corresponder ao valor especificado. O ETag tem de ser especificado em aspas.
If-None-Match

string

Opcional. Um valor ETag ou o valor de caráter universal especial ("*"). Especifique este cabeçalho para executar a operação apenas se o ETag do recurso não corresponder ao valor especificado. O ETag tem de ser especificado em aspas.
If-Modified-Since

string

Opcional. Um valor de data e hora. Especifique este cabeçalho para executar a operação apenas se o recurso tiver sido modificado desde a data e hora especificadas.
If-Unmodified-Since

string

Opcional. Um valor de data e hora. Especifique este cabeçalho para executar a operação apenas se o recurso não tiver sido modificado desde a data e hora especificadas.
x-ms-client-request-id

string

Um UUID registado nos registos de análise para resolução de problemas e correlação.

Padrão Regex: ^[{(]?[0-9a-f]{8}[-]?([0-9a-f]{4}[-]?){3}[0-9a-f]{12}[)}]?$
x-ms-date

string

Especifica a Hora Universal Coordenada (UTC) do pedido. Isto é necessário ao utilizar a autorização de chave partilhada.
x-ms-version

string

Especifica a versão do protocolo REST utilizada para processar o pedido. Isto é necessário ao utilizar a autorização de chave partilhada.

Respostas

Name Tipo Description
200 OK

A ação "renovar", "alterar" ou "libertar" foi bem-sucedida.

Cabeçalhos

  • Date: string
  • ETag: string
  • Last-Modified: string
  • x-ms-request-id: string
  • x-ms-version: string
  • x-ms-lease-id: string
201 Created

Foi criada uma nova concessão. A ação "adquirir" foi bem-sucedida.

Cabeçalhos

  • Date: string
  • ETag: string
  • Last-Modified: string
  • x-ms-request-id: string
  • x-ms-version: string
  • x-ms-lease-id: string
202 Accepted

A ação de concessão "break" foi bem sucedida.

Cabeçalhos

  • ETag: string
  • Last-Modified: string
  • x-ms-request-id: string
  • x-ms-version: string
  • x-ms-lease-time: string
Other Status Codes

DataLakeStorageError

Ocorreu um erro. As cadeias de estado, código e mensagem http possíveis estão listadas abaixo:

  • 400 Pedido Incorreto, ContentLengthMustBeZero, "O cabeçalho do pedido Content-Length tem de ser zero".
  • 400 Pedido Incorreto, InvalidAuthenticationInfo, "As informações de autenticação não são fornecidas no formato correto. Verifique o valor do cabeçalho Autorização."
  • 400 Pedido Incorreto, InvalidFlushPosition, "Os dados carregados não são contíguos ou o valor do parâmetro de consulta de posição não é igual ao comprimento do ficheiro depois de acrescentar os dados carregados."
  • 400 Pedido Incorreto, InvalidHeaderValue, "O valor de um dos cabeçalhos HTTP não está no formato correto."
  • 400 Pedido Incorreto, InválidoHttpVerb, "O verbo HTTP especificado é inválido - não é reconhecido pelo servidor."
  • 400 Pedido Incorreto, InvalidInput, "Uma das entradas do pedido não é válida.".
  • 400 Pedido Incorreto, InvalidPropertyName, "Um nome de propriedade não pode estar vazio".
  • 400 Pedido Inválido, InvalidPropertyName, "O nome da propriedade contém carateres inválidos.".
  • 400 Pedido Incorreto, InvalidQueryParameterValue, "O valor de um dos parâmetros de consulta especificados no URI do pedido é inválido."
  • 400 Pedido Inválido, InvalidResourceName, "O nome do recurso especificado contém carateres inválidos."
  • 400 Pedido Incorreto, InvalidSourceUri, "O URI de origem é inválido".
  • 400 Pedido Incorreto, InvalidUri, "O URI do pedido é inválido".
  • 400 Pedido Incorreto, MissingRequiredHeader, "Um cabeçalho HTTP obrigatório para este pedido não é especificado."
  • 400 Pedido Incorreto, MissingRequiredQueryParameter, "Não é especificado um parâmetro de consulta obrigatório para este pedido.".
  • 400 Pedido Incorreto, MultipleConditionHeadersNotSupported, "Não são suportados múltiplos cabeçalhos de condição".
  • 400 Pedido Incorreto, OutOfRangeInput, "Uma das entradas do pedido está fora do intervalo".
  • 400 Pedido Incorreto, OutOfRangeQueryParameterValue, "Um dos parâmetros de consulta especificados no URI do pedido está fora do intervalo permitido."
  • 400 Pedido Incorreto, UnsupportedHeader, "Um dos cabeçalhos especificados no pedido não é suportado."
  • 400 Pedido Incorreto, UnsupportedQueryParameter, "Um dos parâmetros de consulta especificados no URI do pedido não é suportado."
  • 400 Pedido Incorreto, UnsupportedRestVersion, "A Versão Rest especificada não é suportada".
  • 403 Proibido, AccountIsDisabled, "A conta especificada está desativada".
  • 403 Proibido, AuthorizationFailure, "Este pedido não está autorizado a executar esta operação."
  • 403 Proibido, InsufficientAccountPermissions, "A conta a ser acedida não tem permissões suficientes para executar esta operação."
  • 404 Não Encontrado, FilesystemNotFound, "O sistema de ficheiros especificado não existe".
  • 404 Não Encontrado, PathNotFound, "O caminho especificado não existe.".
  • 404 Não Encontrado, RenameDestinationParentPathNotFound, "O diretório principal do caminho de destino não existe.".
  • 404 Não Encontrado, ResourceNotFound, "O recurso especificado não existe.".
  • 404 Não Encontrado, SourcePathNotFound, "O caminho de origem para uma operação de mudança de nome não existe."
  • Método 405 Não Permitido, Não SuportadoHttpVerb, "O recurso não suporta o verbo HTTP especificado".
  • 409 Conflito, DestinationPathIsBeingDeleted, "O caminho de destino especificado está marcado para ser eliminado".
  • 409 Conflito, DirectoryNotEmpty, "O valor do parâmetro de consulta recursiva tem de ser verdadeiro para eliminar um diretório não vazio."
  • 409 Conflito, FilesystemAlreadyExists, "O sistema de ficheiros especificado já existe".
  • 409 Conflito, FilesystemBeingDeleted, "O sistema de ficheiros especificado está a ser eliminado".
  • 409 Conflito, InvalidDestinationPath, "O caminho especificado, ou um elemento do caminho, existe e o tipo de recurso é inválido para esta operação." * 409 Conflito, InvalidFlushOperation, "O recurso foi criado ou modificado pela API do Serviço blob e não pode ser escrito pela API de Serviço Data Lake Storage".
  • 409 Conflito, InvalidRenameSourcePath, "O diretório de origem não pode ser o mesmo que o diretório de destino, nem o destino pode ser um subdiretório do diretório de origem."
  • Conflito 409, InvalidSourceOrDestinationResourceType, "O tipo de recurso de origem e destino tem de ser idêntico.".
  • 409 Conflito, LeaseAlreadyPresent, "Já existe uma concessão presente."
  • 409 Conflito, LeaseIdMismatchWithLeaseOperation, "O ID de concessão especificado não correspondeu ao ID de concessão do recurso com a operação de concessão especificada."
  • 409 Conflito, LeaseIsAlreadyBroken, "A concessão já foi quebrada e não pode ser quebrada novamente."
  • 409 Conflito, LeaseIsBreakingAndCannotBeAcquired, "O ID de concessão correspondeu, mas a concessão está atualmente em estado de interrupção e não pode ser adquirida até que seja quebrada."
  • 409 Conflito, LeaseIsBreakingAndCannotBeChanged, "O ID de concessão correspondeu, mas a concessão está atualmente em estado de interrupção e não pode ser alterada."
  • 409 Conflito, LeaseIsBrokenAndCannotBeRenewed, "O ID de concessão correspondeu, mas a concessão foi quebrada explicitamente e não pode ser renovada."
  • 409 Conflito, LeaseNameMismatch, "O nome da concessão especificado não corresponde ao nome da concessão existente."
  • 409 Conflito, LeaseNotPresentWithLeaseOperation, "O ID de concessão não está presente na operação de concessão especificada."
  • 409 Conflito, PathAlreadyExists, "O caminho especificado já existe".
  • 409 Conflito, PathConflict, "O caminho especificado, ou um elemento do caminho, existe e o tipo de recurso é inválido para esta operação."
  • 409 Conflito, SourcePathIsBeingDeleted, "O caminho de origem especificado está marcado para ser eliminado".
  • 409 Conflito, ResourceTypeMismatch, "O tipo de recurso especificado no pedido não corresponde ao tipo de recurso."
  • 412 Precondition Failed, ConditionNotMet, "The condition specified using HTTP conditional header(s) is not met."
  • 412 Precondition Failed, LeaseIdMismatch, "The lease ID specified not match the lease ID for the resource."
  • 412 Precondition Failed, LeaseIdMissing, "There is currently a lease on the resource and no lease ID was specified in the request."
  • 412 Precondition Failed, LeaseNotPresent, "Não existe atualmente nenhuma concessão no recurso.".
  • 412 Precondition Failed, LeaseLost, "A lease ID was specified, but the lease for the resource has expired."
  • 412 Precondition Failed, SourceConditionNotMet, "The source condition specified using HTTP conditional header(s) is not met."
  • 413 Request Entity Too Large, RequestBodyTooLarge, "The request body is too large and exceeds the maximum permissible limit."
  • 416 Intervalo Pedido Não Satisfiable, InvalidRange, "O intervalo especificado é inválido para o tamanho atual do recurso."
  • Erro interno do Servidor 500, InternalError, "O servidor encontrou um erro interno. Repita o pedido."
  • 500 Erro interno do Servidor, OperationTimedOut, "Não foi possível concluir a operação dentro do tempo permitido".
  • 503 Serviço Indisponível, ServerBusy, "A saída ultrapassou o limite da conta".
  • 503 Serviço Indisponível, ServerBusy, "A entrada está acima do limite da conta".
  • 503 Serviço Indisponível, ServerBusy, "As operações por segundo estão acima do limite da conta".
  • Serviço 503 Indisponível, ServerBusy, "Atualmente, o servidor não consegue receber pedidos. Tente novamente o seu pedido."

Cabeçalhos

  • x-ms-request-id: string
  • x-ms-version: string

Definições

Name Description
DataLakeStorageError
Error

O objeto de resposta de erro do serviço.
PathLeaseAction

Existem cinco ações de concessão: "adquirir", "break", "change", "renew" e "release". Utilize "acquire" e especifique o "x-ms-proposed-lease-id" e "x-ms-lease-duration" para adquirir uma nova concessão. Utilize "break" para interromper uma concessão existente. Quando uma concessão é interrompida, o período de interrupção da concessão é permitido decorrido, período durante o qual não é possível executar nenhuma operação de concessão, exceto quebra e lançamento no ficheiro. Quando uma concessão é quebrada com êxito, a resposta indica o intervalo em segundos até que uma nova concessão possa ser adquirida. Utilize "alterar" e especifique o ID de concessão atual em "x-ms-lease-id" e o novo ID de concessão em "x-ms-proposed-lease-id" para alterar o ID de concessão de uma concessão ativa. Utilize "renovar" e especifique o "x-ms-lease-id" para renovar uma concessão existente. Utilize "release" e especifique o "x-ms-lease-id" para libertar uma concessão.

DataLakeStorageError

Name Tipo Description
error

Error

O objeto de resposta de erro do serviço.

Error

O objeto de resposta de erro do serviço.

Name Tipo Description
code

string

O código de erro do serviço.
message

string

A mensagem de erro do serviço.

PathLeaseAction

Existem cinco ações de concessão: "adquirir", "break", "change", "renew" e "release". Utilize "acquire" e especifique o "x-ms-proposed-lease-id" e "x-ms-lease-duration" para adquirir uma nova concessão. Utilize "break" para interromper uma concessão existente. Quando uma concessão é interrompida, o período de interrupção da concessão é permitido decorrido, período durante o qual não é possível executar nenhuma operação de concessão, exceto quebra e lançamento no ficheiro. Quando uma concessão é quebrada com êxito, a resposta indica o intervalo em segundos até que uma nova concessão possa ser adquirida. Utilize "alterar" e especifique o ID de concessão atual em "x-ms-lease-id" e o novo ID de concessão em "x-ms-proposed-lease-id" para alterar o ID de concessão de uma concessão ativa. Utilize "renovar" e especifique o "x-ms-lease-id" para renovar uma concessão existente. Utilize "release" e especifique o "x-ms-lease-id" para libertar uma concessão.

Name Tipo Description
acquire

string

break

string

change

string

release

string

renew

string