BlobServiceClient Klass

En klient som ska interagera med Blob Service på kontonivå.

Den här klienten tillhandahåller åtgärder för att hämta och konfigurera kontoegenskaper samt lista, skapa och ta bort containrar i kontot. För åtgärder som rör en specifik container eller blob kan klienter för dessa entiteter också hämtas med hjälp av get_client-funktionerna .

Klicka här om du vill ha mer valfri konfiguration.

Arv

azure.storage.blob._shared.base_client.StorageAccountHostsMixin

BlobServiceClient

azure.storage.blob._encryption.StorageEncryptionMixin

BlobServiceClient

Konstruktor

BlobServiceClient(account_url: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any)

Parametrar

account_url

str

Obligatorisk

URL:en till bloblagringskontot. Andra entiteter som ingår i URL-sökvägen (t.ex. container eller blob) tas bort. Den här URL:en kan även autentiseras med en SAS-token.

credential

standardvärde: None

De autentiseringsuppgifter som ska autentiseras med. Detta är valfritt om konto-URL:en redan har en SAS-token. Värdet kan vara en SAS-tokensträng, en instans av en AzureSasCredential eller AzureNamedKeyCredential från azure.core.credentials, en kontodelad åtkomstnyckel eller en instans av en TokenCredentials-klass från azure.identity. Om resurs-URI:n redan innehåller en SAS-token ignoreras detta till förmån för en explicit autentiseringsuppgift

• utom när det gäller AzureSasCredential, där de motstridiga SAS-token genererar en ValueError. Om du använder en instans av AzureNamedKeyCredential ska "namn" vara lagringskontots namn och "nyckel" ska vara lagringskontonyckeln.

api_version

str

Lagrings-API-versionen som ska användas för begäranden. Standardvärdet är den senaste tjänstversionen som är kompatibel med den aktuella SDK:en. Om du anger en äldre version kan det leda till minskad funktionskompatibilitet.

Ny i version 12.2.0.

secondary_hostname

str

Värdnamnet för den sekundära slutpunkten.

max_block_size

int

Den maximala segmentstorleken för att ladda upp en blockblob i segment. Standardvärdet är 4*1024*1024 eller 4 MB.

max_single_put_size

int

Om blobstorleken är mindre än eller lika med max_single_put_size laddas bloben upp med endast en http PUT-begäran. Om blobstorleken är större än max_single_put_size laddas bloben upp i segment. Standardvärdet är 64*1024*1024 eller 64 MB.

min_large_block_upload_threshold

int

Den minsta segmentstorlek som krävs för att använda den minneseffektiva algoritmen när du laddar upp en blockblob. Standardvärdet är 4*1024*1024+1.

use_byte_buffer

bool

Använd en bytebuffert för blockblobuppladdningar. Standardvärdet är Falskt.

max_page_size

int

Den maximala segmentstorleken för att ladda upp en sidblob. Standardvärdet är 4*1024*1024 eller 4 MB.

max_single_get_size

int

Den maximala storleken för en blob som ska laddas ned i ett enda anrop. Den överskred delen laddas ned i segment (kan vara parallell). Standardvärdet är 32*1024*1024 eller 32 MB.

max_chunk_get_size

int

Den maximala segmentstorleken som används för att ladda ned en blob. Standardvärdet är 4*1024*1024 eller 4 MB.

Metoder

close	Den här metoden är att stänga de sockets som öppnats av klienten. Den behöver inte användas när du använder med en kontexthanterare.
create_container	Skapar en ny container under det angivna kontot. Om containern med samma namn redan finns utlöses en ResourceExistsError. Den här metoden returnerar en klient som du kan interagera med den nyligen skapade containern med.
delete_container	Markerar den angivna containern för borttagning. Containern och eventuella blobar som finns i den tas senare bort under skräpinsamlingen. Om containern inte hittas utlöses en ResourceNotFoundError.
find_blobs_by_tags	Åtgärden Filterblobar gör det möjligt för anropare att lista blobar över alla containrar vars taggar matchar ett visst sökuttryck. Filterblobar söker i alla containrar i ett lagringskonto men kan begränsas i uttrycket till en enda container.
from_connection_string	Skapa BlobServiceClient från en anslutningssträng.
get_account_information	Hämtar information om lagringskontot. Informationen kan också hämtas om användaren har en SAS till en container eller blob. Nycklarna i den returnerade ordlistan innehåller "sku_name" och "account_kind".
get_blob_client	Hämta en klient för att interagera med den angivna bloben. Bloben behöver inte redan finnas.
get_container_client	Hämta en klient för att interagera med den angivna containern. Containern behöver inte redan finnas.
get_service_properties	Hämtar egenskaperna för ett lagringskontos blobtjänst, inklusive Azure Lagringsanalys.
get_service_stats	Hämtar statistik relaterad till replikering för Blob Service. Den är endast tillgänglig när geo-redundant replikering med läsbehörighet är aktiverad för lagringskontot. Med geo-redundant replikering underhåller Azure Storage dina data på två platser. På båda platserna upprätthåller Azure Storage ständigt flera felfria repliker av dina data. Den plats där du läser, skapar, uppdaterar eller tar bort data är den primära lagringskontoplatsen. Den primära platsen finns i den region som du väljer när du skapar ett konto via den klassiska Azure-portalen för Azure-hantering, till exempel USA, norra centrala. Platsen som dina data replikeras till är den sekundära platsen. Den sekundära platsen bestäms automatiskt baserat på platsen för den primära platsen. det finns i ett andra datacenter som finns i samma region som den primära platsen. Skrivskyddad åtkomst är tillgänglig från den sekundära platsen, om geo-redundant replikering med läsbehörighet är aktiverad för ditt lagringskonto.
get_user_delegation_key	Hämta en nyckel för användardelegering i syfte att signera SAS-token. En tokenautentiseringsuppgift måste finnas på tjänstobjektet för att begäran ska lyckas.
list_containers	Returnerar en generator för att visa containrarna under det angivna kontot. Generatorn följer lazily fortsättningstoken som returneras av tjänsten och stoppar när alla containrar har returnerats.
set_service_properties	Anger egenskaperna för ett lagringskontos blobtjänst, inklusive Azure Lagringsanalys. Om ett element (t.ex. analytics_logging) lämnas kvar som Ingen bevaras de befintliga inställningarna för tjänsten för den funktionen.
undelete_container	Återställer mjuk borttagningscontainer. Åtgärden lyckas endast om den används inom det angivna antalet dagar som anges i kvarhållningsprincipen för borttagning. Ny i version 12.4.0: Den här åtgärden introducerades i API-versionen "2019-12-12".

close

Den här metoden är att stänga de sockets som öppnats av klienten. Den behöver inte användas när du använder med en kontexthanterare.

close()

create_container

Skapar en ny container under det angivna kontot.

Om containern med samma namn redan finns utlöses en ResourceExistsError. Den här metoden returnerar en klient som du kan interagera med den nyligen skapade containern med.

create_container(name: str, metadata: Dict[str, str] | None = None, public_access: PublicAccess | str | None = None, **kwargs) -> ContainerClient

Parametrar

name

str

Obligatorisk

Namnet på containern som ska skapas.

metadata

dict(str, str)

Obligatorisk

En diktamen med namn/värde-par som ska associeras med containern som metadata. Exempel: {'Category':'test'}

public_access

str eller PublicAccess

Obligatorisk

Möjliga värden är: "container", "blob".

container_encryption_scope

dict eller ContainerEncryptionScope

Anger standardkrypteringsomfånget som ska anges på containern och används för alla framtida skrivningar.

Ny i version 12.2.0.

timeout

int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returtyp

ContainerClient

delete_container

Markerar den angivna containern för borttagning.

Containern och eventuella blobar som finns i den tas senare bort under skräpinsamlingen. Om containern inte hittas utlöses en ResourceNotFoundError.

delete_container(container: ContainerProperties | str, lease: BlobLeaseClient | str | None = None, **kwargs) -> None

Parametrar

container

str eller ContainerProperties

Obligatorisk

Containern som ska tas bort. Detta kan antingen vara namnet på containern eller en instans av ContainerProperties.

lease

Obligatorisk

Om det anges lyckas delete_container bara om containerns lån är aktivt och matchar det här ID:t. Krävs om containern har ett aktivt lån.

if_modified_since

datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen har ändrats sedan den angivna tiden.

if_unmodified_since

datetime

Ett DateTime-värde. Azure förväntar sig att det datumvärde som skickas in är UTC. Om tidszonen ingår konverteras alla icke-UTC-datetimes till UTC. Om ett datum skickas utan tidszonsinformation antas det vara UTC. Ange det här huvudet för att utföra åtgärden endast om resursen inte har ändrats sedan det angivna datumet/tiden.

etag

str

Ett ETag-värde eller jokertecknet (*). Används för att kontrollera om resursen har ändrats och agera enligt villkoret som anges av parametern match_condition .

match_condition

MatchConditions

Matchningsvillkoret som ska användas på etag.

timeout

int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returtyp

None

find_blobs_by_tags

Åtgärden Filterblobar gör det möjligt för anropare att lista blobar över alla containrar vars taggar matchar ett visst sökuttryck. Filterblobar söker i alla containrar i ett lagringskonto men kan begränsas i uttrycket till en enda container.

find_blobs_by_tags(filter_expression: str, **kwargs: Any) -> ItemPaged[FilteredBlob]

Parametrar

filter_expression

str

Obligatorisk

Uttrycket för att hitta blobar vars taggar matchar det angivna villkoret. t.ex. ""yourtagname"='firsttag' och "yourtagname2"='secondtag'" För att ange en container, t.ex. "@container='containerName' och "Name"='C'"

results_per_page

int

Det maximala resultatet per sida vid sidnumrering.

timeout

int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Ett iterabelt svar (automatisk sidindelning) för BlobProperties.

Returtyp

ItemPaged[FilteredBlob]

from_connection_string

Skapa BlobServiceClient från en anslutningssträng.

from_connection_string(conn_str: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self

Parametrar

conn_str

str

Obligatorisk

En anslutningssträng till ett Azure Storage-konto.

credential

standardvärde: None

De autentiseringsuppgifter som ska autentiseras med. Detta är valfritt om konto-URL:en redan har en SAS-token, eller om anslutningssträngen redan har värden för delad åtkomstnyckel. Värdet kan vara en SAS-tokensträng, en instans av en AzureSasCredential eller AzureNamedKeyCredential från azure.core.credentials, en kontodelad åtkomstnyckel eller en instans av en TokenCredentials-klass från azure.identity. Autentiseringsuppgifterna som anges här har företräde framför dem i anslutningssträngen. Om du använder en instans av AzureNamedKeyCredential ska "name" vara lagringskontots namn och "nyckel" ska vara lagringskontonyckeln.

Returer

En Blob Service-klient.

Returtyp

BlobServiceClient

get_account_information

Hämtar information om lagringskontot.

Informationen kan också hämtas om användaren har en SAS till en container eller blob. Nycklarna i den returnerade ordlistan innehåller "sku_name" och "account_kind".

get_account_information(**kwargs: Any) -> Dict[str, str]

Returer

En diktering av kontoinformation (SKU och kontotyp).

Returtyp

dict(str, str)

get_blob_client

Hämta en klient för att interagera med den angivna bloben.

Bloben behöver inte redan finnas.

get_blob_client(container: ContainerProperties | str, blob: BlobProperties | str, snapshot: Dict[str, Any] | str | None = None, *, version_id: str | None = None) -> BlobClient

Parametrar

container

str eller ContainerProperties

Obligatorisk

Containern som bloben finns i. Detta kan antingen vara namnet på containern eller en instans av ContainerProperties.

blob

str eller BlobProperties

Obligatorisk

Bloben som du vill interagera med. Detta kan antingen vara namnet på bloben eller en instans av BlobProperties.

snapshot

str eller dict(str, Any)

standardvärde: None

Den valfria blobögonblicksbilden som ska användas. Detta kan antingen vara ID för ögonblicksbilden eller en ordlisteutdata som returneras av create_snapshot.

version_id

str

Parametern för versions-ID är ett täckande DateTime-värde som, när det finns, anger vilken version av bloben som ska användas.

Returer

En BlobClient.

Returtyp

BlobClient

get_container_client

Hämta en klient för att interagera med den angivna containern.

Containern behöver inte redan finnas.

get_container_client(container: ContainerProperties | str) -> ContainerClient

Parametrar

container

str eller ContainerProperties

Obligatorisk

Containern. Detta kan antingen vara namnet på containern eller en instans av ContainerProperties.

Returer

En ContainerClient.

Returtyp

ContainerClient

get_service_properties

Hämtar egenskaperna för ett lagringskontos blobtjänst, inklusive Azure Lagringsanalys.

get_service_properties(**kwargs: Any) -> Dict[str, Any]

Parametrar

timeout

int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Ett objekt som innehåller blobtjänstegenskaper som analysloggning, tim-/minutmått, cors-regler osv.

Returtyp

Dict[str, Any]

get_service_stats

Hämtar statistik relaterad till replikering för Blob Service.

Den är endast tillgänglig när geo-redundant replikering med läsbehörighet är aktiverad för lagringskontot.

Med geo-redundant replikering underhåller Azure Storage dina data på två platser. På båda platserna upprätthåller Azure Storage ständigt flera felfria repliker av dina data. Den plats där du läser, skapar, uppdaterar eller tar bort data är den primära lagringskontoplatsen. Den primära platsen finns i den region som du väljer när du skapar ett konto via den klassiska Azure-portalen för Azure-hantering, till exempel USA, norra centrala. Platsen som dina data replikeras till är den sekundära platsen. Den sekundära platsen bestäms automatiskt baserat på platsen för den primära platsen. det finns i ett andra datacenter som finns i samma region som den primära platsen. Skrivskyddad åtkomst är tillgänglig från den sekundära platsen, om geo-redundant replikering med läsbehörighet är aktiverad för ditt lagringskonto.

get_service_stats(**kwargs: Any) -> Dict[str, Any]

Parametrar

timeout

int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Statistik för blobtjänsten.

Returtyp

Dict[str, Any]

get_user_delegation_key

Hämta en nyckel för användardelegering i syfte att signera SAS-token. En tokenautentiseringsuppgift måste finnas på tjänstobjektet för att begäran ska lyckas.

get_user_delegation_key(key_start_time: datetime, key_expiry_time: datetime, **kwargs: Any) -> UserDelegationKey

Parametrar

key_start_time

datetime

Obligatorisk

Ett DateTime-värde. Anger när nyckeln blir giltig.

key_expiry_time

datetime

Obligatorisk

Ett DateTime-värde. Anger när nyckeln slutar vara giltig.

timeout

int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Användarens delegeringsnyckel.

Returtyp

UserDelegationKey

list_containers

Returnerar en generator för att visa containrarna under det angivna kontot.

Generatorn följer lazily fortsättningstoken som returneras av tjänsten och stoppar när alla containrar har returnerats.

list_containers(name_starts_with: str | None = None, include_metadata: bool | None = False, **kwargs) -> ItemPaged[ContainerProperties]

Parametrar

name_starts_with

str

Obligatorisk

Filtrerar resultatet så att endast containrar vars namn börjar med det angivna prefixet returneras.

include_metadata

bool

Obligatorisk

Anger att containermetadata ska returneras i svaret. Standardvärdet är False.

include_deleted

bool

Anger att borttagna containrar ska returneras i svaret. Detta gäller för kontot för containeråterställning aktiverat. Standardvärdet är False. .. versionadded:: 12.4.0

include_system

bool

Flagga som anger att systemcontainrar ska inkluderas. .. versionadded:: 12.10.0

results_per_page

int

Det maximala antalet containernamn som ska hämtas per API-anrop. Om begäran inte anger returnerar servern upp till 5 000 objekt.

timeout

int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

En iterabel (automatisk sidindelning) med ContainerProperties.

Returtyp

ItemPaged[ContainerProperties]

set_service_properties

Anger egenskaperna för ett lagringskontos blobtjänst, inklusive Azure Lagringsanalys.

Om ett element (t.ex. analytics_logging) lämnas kvar som Ingen bevaras de befintliga inställningarna för tjänsten för den funktionen.

set_service_properties(analytics_logging: BlobAnalyticsLogging | None = None, hour_metrics: Metrics | None = None, minute_metrics: Metrics | None = None, cors: List[CorsRule] | None = None, target_version: str | None = None, delete_retention_policy: RetentionPolicy | None = None, static_website: StaticWebsite | None = None, **kwargs) -> None

Parametrar

analytics_logging

BlobAnalyticsLogging

Obligatorisk

Grupperar loggningsinställningarna för Azure Analytics.

hour_metrics

Metrics

Obligatorisk

Inställningarna för timmått ger en sammanfattning av begärandestatistik grupperad efter API i timaggregeringar för blobar.

minute_metrics

Metrics

Obligatorisk

Minutmåttinställningarna tillhandahåller begärandestatistik för varje minut för blobar.

cors

list[CorsRule]

Obligatorisk

Du kan inkludera upp till fem CorsRule-element i listan. Om en tom lista anges tas alla CORS-regler bort och CORS inaktiveras för tjänsten.

target_version

str

Obligatorisk

Anger standardversionen som ska användas för begäranden om en inkommande begärans version inte har angetts.

delete_retention_policy

RetentionPolicy

Obligatorisk

Kvarhållningsprincipen för borttagning anger om borttagna blobar ska behållas. Den anger också antalet dagar och versioner av bloben som ska behållas.

static_website

StaticWebsite

Obligatorisk

Anger om funktionen för statisk webbplats är aktiverad och om ja anger indexdokumentet och 404-feldokumentet som ska användas.

timeout

int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returtyp

None

undelete_container

Återställer mjuk borttagningscontainer.

Åtgärden lyckas endast om den används inom det angivna antalet dagar som anges i kvarhållningsprincipen för borttagning.

Ny i version 12.4.0: Den här åtgärden introducerades i API-versionen "2019-12-12".

undelete_container(deleted_container_name: str, deleted_container_version: str, **kwargs: Any) -> ContainerClient

Parametrar

deleted_container_name

str

Obligatorisk

Anger namnet på den borttagna container som ska återställas.

deleted_container_version

str

Obligatorisk

Anger vilken version av den borttagna containern som ska återställas.

timeout

int

Anger tidsgränsen på serversidan för åtgärden i sekunder. Mer information finns i: https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Det här värdet spåras eller verifieras inte på klienten. Information om hur du konfigurerar tidsgränser för nätverk på klientsidan finns här.

Returer

Den ej borttagningsklara ContainerClient.

Returtyp

ContainerClient

Attribut

api_version

Den version av lagrings-API:et som används för begäranden.

location_mode

Det platsläge som klienten använder för närvarande.

Som standard är detta "primärt". Alternativen är "primär" och "sekundär".

primary_endpoint

Den fullständiga primära slutpunkts-URL:en.

primary_hostname

Värdnamnet för den primära slutpunkten.

secondary_endpoint

Den fullständiga sekundära slutpunkts-URL:en om den har konfigurerats.

Om den inte är tillgänglig utlöses en ValueError. Om du uttryckligen vill ange ett sekundärt värdnamn använder du det valfria nyckelordsargumentet secondary_hostname vid instansiering.

Undantag

ValueError

secondary_hostname

Värdnamnet för den sekundära slutpunkten.

Om det inte är tillgängligt blir det Ingen. Om du uttryckligen vill ange ett sekundärt värdnamn använder du det valfria nyckelordsargumentet secondary_hostname vid instansiering.

url

Den fullständiga slutpunkts-URL:en till den här entiteten, inklusive SAS-token om den används.

Detta kan vara antingen den primära slutpunkten eller den sekundära slutpunkten beroende på aktuell location_mode. :returns: Den fullständiga slutpunkts-URL:en till den här entiteten, inklusive SAS-token om den används. :rtype: str