BlobContainersOperations Classe
Aviso
NÃO instancie essa classe diretamente.
Em vez disso, você deve acessar as operações a seguir por meio de
Atributo <xref:blob_containers>.
- Herança
-
builtins.objectBlobContainersOperations
Construtor
BlobContainersOperations(*args, **kwargs)
Métodos
clear_legal_hold |
Limpa marcas de retenção legais. Limpar a mesma marca ou não existente resulta em uma operação idempotente. ClearLegalHold limpa apenas as marcas especificadas na solicitação. |
create |
Cria um novo contêiner na conta especificada, conforme descrito pelo corpo da solicitação. O recurso do contêiner inclui os metadados e as propriedades desse contêiner. Ele não inclui uma lista dos blobs presentes no contêiner. |
create_or_update_immutability_policy |
Cria ou atualiza uma política de imutabilidade desbloqueada. A ETag no If-Match será respeitada se for fornecida, mas não necessária para essa operação. |
delete |
Exclui o contêiner especificado em sua conta. |
delete_immutability_policy |
Anula uma política de imutabilidade desbloqueada. A resposta de delete tem imutabilityPeriodSinceCreationInDays definido como 0. A ETag no If-Match é necessária para essa operação. A exclusão de uma política de imutabilidade bloqueada não é permitida, a única maneira é excluir o contêiner depois de excluir todos os blobs expirados dentro do contêiner bloqueado pela política. |
extend_immutability_policy |
Estende a imutabilidadePeriodSinceCreationInDays de um immutabilityPolicy bloqueado. A única ação permitida em uma política Bloqueada será essa ação. A ETag no If-Match é necessária para essa operação. |
get |
Obtém as propriedades de um contêiner especificado. |
get_immutability_policy |
Obtém a política de imutabilidade existente junto com a ETag correspondente em cabeçalhos de resposta e corpo. |
lease |
A operação Contêiner de Concessão estabelece e gerencia um bloqueio em um contêiner para operações de exclusão. A duração do bloqueio pode ser de 15 a 60 segundos, ou pode ser infinita. |
list |
Lista todos os contêineres e não dá suporte a um prefixo como plano de dados. Além disso, o SRP hoje não retorna o token de continuação. |
lock_immutability_policy |
Define ImmutabilityPolicy como Estado bloqueado. A única ação permitida em uma política Bloqueada é a ação ExtendImmutabilityPolicy. A ETag no If-Match é necessária para essa operação. |
set_legal_hold |
Define marcas de retenção legais. Definir a mesma marca resulta em uma operação idempotente. SetLegalHold segue um padrão de acréscimo e não limpa as marcas existentes que não são especificadas na solicitação. |
update |
Atualizações propriedades de contêiner conforme especificado no corpo da solicitação. As propriedades não mencionadas na solicitação não serão alteradas. A atualização falhará se o contêiner especificado ainda não existir. |
clear_legal_hold
Limpa marcas de retenção legais. Limpar a mesma marca ou não existente resulta em uma operação idempotente. ClearLegalHold limpa apenas as marcas especificadas na solicitação.
async clear_legal_hold(resource_group_name: str, account_name: str, container_name: str, legal_hold: _models.LegalHold, *, content_type: str = 'application/json', **kwargs: Any) -> _models.LegalHold
Parâmetros
- resource_group_name
- str
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.
- account_name
- str
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas. Obrigatórios.
- container_name
- str
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes de contêiner de blob devem ter entre 3 e 63 caracteres e usar números, letras minúsculas e traço (-). Todo caractere de traço (-) precisa ser precedido e seguido imediatamente por uma letra ou um número. Obrigatórios.
A propriedade LegalHold que será limpa de um contêiner de blob. É um tipo LegalHold ou um tipo de E/S. Obrigatórios.
- content_type
- str
Body Parameter content-type. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
Retornos
LegalHold ou o resultado de cls(response)
Tipo de retorno
Exceções
create
Cria um novo contêiner na conta especificada, conforme descrito pelo corpo da solicitação. O recurso do contêiner inclui os metadados e as propriedades desse contêiner. Ele não inclui uma lista dos blobs presentes no contêiner.
async create(resource_group_name: str, account_name: str, container_name: str, blob_container: _models.BlobContainer, *, content_type: str = 'application/json', **kwargs: Any) -> _models.BlobContainer
Parâmetros
- resource_group_name
- str
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.
- account_name
- str
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas. Obrigatórios.
- container_name
- str
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes de contêiner de blob devem ter entre 3 e 63 caracteres e usar números, letras minúsculas e traço (-). Todo caractere de traço (-) precisa ser precedido e seguido imediatamente por uma letra ou um número. Obrigatórios.
- blob_container
- BlobContainer ou IO
Propriedades do contêiner de blob a ser criado. É um tipo BlobContainer ou um tipo de E/S. Obrigatórios.
- content_type
- str
Body Parameter content-type. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
Retornos
BlobContainer ou o resultado de cls(response)
Tipo de retorno
Exceções
create_or_update_immutability_policy
Cria ou atualiza uma política de imutabilidade desbloqueada. A ETag no If-Match será respeitada se for fornecida, mas não necessária para essa operação.
async create_or_update_immutability_policy(resource_group_name: str, account_name: str, container_name: str, immutability_policy_name: str | _models.Enum28, if_match: str | None = None, parameters: _models.ImmutabilityPolicy | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ImmutabilityPolicy
Parâmetros
- resource_group_name
- str
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.
- account_name
- str
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas. Obrigatórios.
- container_name
- str
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes de contêiner de blob devem ter entre 3 e 63 caracteres e usar números, letras minúsculas e traço (-). Todo caractere de traço (-) precisa ser precedido e seguido imediatamente por uma letra ou um número. Obrigatórios.
O nome do contêiner de blob imutabilityPolicy dentro da conta de armazenamento especificada. ImmutabilityPolicy Name deve ser 'default'. "padrão" Obrigatório.
- if_match
- str
A versão de estado da entidade (ETag) da política de imutabilidade a ser atualizada. Um valor de "*" pode ser usado para aplicar a operação somente se a política de imutabilidade já existir. Se omitida, essa operação sempre será aplicada. O valor padrão é Nenhum.
- parameters
- ImmutabilityPolicy ou IO
As propriedades ImmutabilityPolicy que serão criadas ou atualizadas para um contêiner de blob. É um tipo ImmutabilityPolicy ou um tipo de E/S. O valor padrão é Nenhum.
- content_type
- str
Body Parameter content-type. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
Retornos
ImmutabilityPolicy ou o resultado de cls(response)
Tipo de retorno
Exceções
delete
Exclui o contêiner especificado em sua conta.
async delete(resource_group_name: str, account_name: str, container_name: str, **kwargs: Any) -> None
Parâmetros
- resource_group_name
- str
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.
- account_name
- str
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas. Obrigatórios.
- container_name
- str
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes de contêiner de blob devem ter entre 3 e 63 caracteres e usar números, letras minúsculas e traço (-). Todo caractere de traço (-) precisa ser precedido e seguido imediatamente por uma letra ou um número. Obrigatórios.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
Retornos
Nenhum ou o resultado de cls(response)
Tipo de retorno
Exceções
delete_immutability_policy
Anula uma política de imutabilidade desbloqueada. A resposta de delete tem imutabilityPeriodSinceCreationInDays definido como 0. A ETag no If-Match é necessária para essa operação. A exclusão de uma política de imutabilidade bloqueada não é permitida, a única maneira é excluir o contêiner depois de excluir todos os blobs expirados dentro do contêiner bloqueado pela política.
async delete_immutability_policy(resource_group_name: str, account_name: str, container_name: str, immutability_policy_name: str | Enum28, if_match: str, **kwargs: Any) -> ImmutabilityPolicy
Parâmetros
- resource_group_name
- str
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.
- account_name
- str
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas. Obrigatórios.
- container_name
- str
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes de contêiner de blob devem ter entre 3 e 63 caracteres e usar números, letras minúsculas e traço (-). Todo caractere de traço (-) precisa ser precedido e seguido imediatamente por uma letra ou um número. Obrigatórios.
O nome do contêiner de blob imutabilityPolicy dentro da conta de armazenamento especificada. ImmutabilityPolicy Name deve ser 'default'. "padrão" Obrigatório.
- if_match
- str
A versão de estado da entidade (ETag) da política de imutabilidade a ser atualizada. Um valor de "*" pode ser usado para aplicar a operação somente se a política de imutabilidade já existir. Se omitida, essa operação sempre será aplicada. Obrigatórios.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
Retornos
ImmutabilityPolicy ou o resultado de cls(response)
Tipo de retorno
Exceções
extend_immutability_policy
Estende a imutabilidadePeriodSinceCreationInDays de um immutabilityPolicy bloqueado. A única ação permitida em uma política Bloqueada será essa ação. A ETag no If-Match é necessária para essa operação.
async extend_immutability_policy(resource_group_name: str, account_name: str, container_name: str, if_match: str, parameters: _models.ImmutabilityPolicy | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.ImmutabilityPolicy
Parâmetros
- resource_group_name
- str
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.
- account_name
- str
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas. Obrigatórios.
- container_name
- str
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes de contêiner de blob devem ter entre 3 e 63 caracteres e usar números, letras minúsculas e traço (-). Todo caractere de traço (-) precisa ser precedido e seguido imediatamente por uma letra ou um número. Obrigatórios.
- if_match
- str
A versão de estado da entidade (ETag) da política de imutabilidade a ser atualizada. Um valor de "*" pode ser usado para aplicar a operação somente se a política de imutabilidade já existir. Se omitida, essa operação sempre será aplicada. Obrigatórios.
- parameters
- ImmutabilityPolicy ou IO
As propriedades ImmutabilityPolicy que serão estendidas para um contêiner de blob. É um tipo ImmutabilityPolicy ou um tipo de E/S. O valor padrão é Nenhum.
- content_type
- str
Body Parameter content-type. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
Retornos
ImmutabilityPolicy ou o resultado de cls(response)
Tipo de retorno
Exceções
get
Obtém as propriedades de um contêiner especificado.
async get(resource_group_name: str, account_name: str, container_name: str, **kwargs: Any) -> BlobContainer
Parâmetros
- resource_group_name
- str
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.
- account_name
- str
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas. Obrigatórios.
- container_name
- str
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes de contêiner de blob devem ter entre 3 e 63 caracteres e usar números, letras minúsculas e traço (-). Todo caractere de traço (-) precisa ser precedido e seguido imediatamente por uma letra ou um número. Obrigatórios.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
Retornos
BlobContainer ou o resultado de cls(response)
Tipo de retorno
Exceções
get_immutability_policy
Obtém a política de imutabilidade existente junto com a ETag correspondente em cabeçalhos de resposta e corpo.
async get_immutability_policy(resource_group_name: str, account_name: str, container_name: str, immutability_policy_name: str | Enum28, if_match: str | None = None, **kwargs: Any) -> ImmutabilityPolicy
Parâmetros
- resource_group_name
- str
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.
- account_name
- str
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas. Obrigatórios.
- container_name
- str
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes de contêiner de blob devem ter entre 3 e 63 caracteres e usar números, letras minúsculas e traço (-). Todo caractere de traço (-) precisa ser precedido e seguido imediatamente por uma letra ou um número. Obrigatórios.
O nome do contêiner de blob imutabilityPolicy dentro da conta de armazenamento especificada. ImmutabilityPolicy Name deve ser 'default'. "padrão" Obrigatório.
- if_match
- str
A versão de estado da entidade (ETag) da política de imutabilidade a ser atualizada. Um valor de "*" pode ser usado para aplicar a operação somente se a política de imutabilidade já existir. Se omitida, essa operação sempre será aplicada. O valor padrão é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
Retornos
ImmutabilityPolicy ou o resultado de cls(response)
Tipo de retorno
Exceções
lease
A operação Contêiner de Concessão estabelece e gerencia um bloqueio em um contêiner para operações de exclusão. A duração do bloqueio pode ser de 15 a 60 segundos, ou pode ser infinita.
async lease(resource_group_name: str, account_name: str, container_name: str, parameters: _models.LeaseContainerRequest | None = None, *, content_type: str = 'application/json', **kwargs: Any) -> _models.LeaseContainerResponse
Parâmetros
- resource_group_name
- str
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.
- account_name
- str
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas. Obrigatórios.
- container_name
- str
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes de contêiner de blob devem ter entre 3 e 63 caracteres e usar números, letras minúsculas e traço (-). Todo caractere de traço (-) precisa ser precedido e seguido imediatamente por uma letra ou um número. Obrigatórios.
- parameters
- LeaseContainerRequest ou IO
Corpo da solicitação do contêiner de concessão. É um tipo LeaseContainerRequest ou um tipo de E/S. O valor padrão é Nenhum.
- content_type
- str
Body Parameter content-type. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
Retornos
LeaseContainerResponse ou o resultado de cls(response)
Tipo de retorno
Exceções
list
Lista todos os contêineres e não dá suporte a um prefixo como plano de dados. Além disso, o SRP hoje não retorna o token de continuação.
list(resource_group_name: str, account_name: str, maxpagesize: str | None = None, filter: str | None = None, include: str | ListContainersInclude | None = None, **kwargs: Any) -> AsyncIterable[ListContainerItem]
Parâmetros
- resource_group_name
- str
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.
- account_name
- str
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas. Obrigatórios.
- maxpagesize
- str
Opcional. Número máximo especificado de contêineres que podem ser incluídos na lista. O valor padrão é Nenhum.
- filter
- str
Opcional. Quando especificado, somente os nomes de contêiner que começam com o filtro serão listados. O valor padrão é Nenhum.
- include
- str ou ListContainersInclude
Opcional, usado para incluir as propriedades para contêineres de blob com exclusão reversível. "excluído" O valor padrão é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
Retornos
Um iterador como a instância de ListContainerItem ou o resultado de cls(response)
Tipo de retorno
Exceções
lock_immutability_policy
Define ImmutabilityPolicy como Estado bloqueado. A única ação permitida em uma política Bloqueada é a ação ExtendImmutabilityPolicy. A ETag no If-Match é necessária para essa operação.
async lock_immutability_policy(resource_group_name: str, account_name: str, container_name: str, if_match: str, **kwargs: Any) -> ImmutabilityPolicy
Parâmetros
- resource_group_name
- str
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.
- account_name
- str
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas. Obrigatórios.
- container_name
- str
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes de contêiner de blob devem ter entre 3 e 63 caracteres e usar números, letras minúsculas e traço (-). Todo caractere de traço (-) precisa ser precedido e seguido imediatamente por uma letra ou um número. Obrigatórios.
- if_match
- str
A versão de estado da entidade (ETag) da política de imutabilidade a ser atualizada. Um valor de "*" pode ser usado para aplicar a operação somente se a política de imutabilidade já existir. Se omitida, essa operação sempre será aplicada. Obrigatórios.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
Retornos
ImmutabilityPolicy ou o resultado de cls(response)
Tipo de retorno
Exceções
set_legal_hold
Define marcas de retenção legais. Definir a mesma marca resulta em uma operação idempotente. SetLegalHold segue um padrão de acréscimo e não limpa as marcas existentes que não são especificadas na solicitação.
async set_legal_hold(resource_group_name: str, account_name: str, container_name: str, legal_hold: _models.LegalHold, *, content_type: str = 'application/json', **kwargs: Any) -> _models.LegalHold
Parâmetros
- resource_group_name
- str
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.
- account_name
- str
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas. Obrigatórios.
- container_name
- str
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes de contêiner de blob devem ter entre 3 e 63 caracteres e usar números, letras minúsculas e traço (-). Todo caractere de traço (-) precisa ser precedido e seguido imediatamente por uma letra ou um número. Obrigatórios.
A propriedade LegalHold que será definida como um contêiner de blob. É um tipo LegalHold ou um tipo de E/S. Obrigatórios.
- content_type
- str
Body Parameter content-type. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
Retornos
LegalHold ou o resultado de cls(response)
Tipo de retorno
Exceções
update
Atualizações propriedades de contêiner conforme especificado no corpo da solicitação. As propriedades não mencionadas na solicitação não serão alteradas. A atualização falhará se o contêiner especificado ainda não existir.
async update(resource_group_name: str, account_name: str, container_name: str, blob_container: _models.BlobContainer, *, content_type: str = 'application/json', **kwargs: Any) -> _models.BlobContainer
Parâmetros
- resource_group_name
- str
O nome do grupo de recursos na assinatura do usuário. O nome diferencia maiúsculas de minúsculas. Obrigatórios.
- account_name
- str
O nome da conta de armazenamento dentro do grupo de recursos especificado. Os nomes da conta de armazenamento devem ter entre 3 e 24 caracteres, usar números e apenas letras minúsculas. Obrigatórios.
- container_name
- str
O nome do contêiner de blob dentro da conta de armazenamento especificada. Os nomes de contêiner de blob devem ter entre 3 e 63 caracteres e usar números, letras minúsculas e traço (-). Todo caractere de traço (-) precisa ser precedido e seguido imediatamente por uma letra ou um número. Obrigatórios.
- blob_container
- BlobContainer ou IO
Propriedades a serem atualizadas para o contêiner de blob. É um tipo BlobContainer ou um tipo de E/S. Obrigatórios.
- content_type
- str
Body Parameter content-type. Os valores conhecidos são: 'application/json'. O valor padrão é Nenhum.
- cls
- callable
Um tipo ou função personalizado que será passado para a resposta direta
Retornos
BlobContainer ou o resultado de cls(response)
Tipo de retorno
Exceções
Atributos
models
models = <module 'azure.mgmt.storage.v2020_08_01_preview.models' from 'C:\\hostedtoolcache\\windows\\Python\\3.11.7\\x64\\Lib\\site-packages\\azure\\mgmt\\storage\\v2020_08_01_preview\\models\\__init__.py'>
Azure SDK for Python