BlobServiceClient Klasse

Ein Client für die Interaktion mit dem Blobdienst auf Kontoebene.

Dieser Client bietet Vorgänge zum Abrufen und Konfigurieren der Kontoeigenschaften sowie zum Auflisten, Erstellen und Löschen von Containern innerhalb des Kontos. Bei Vorgängen im Zusammenhang mit einem bestimmten Container oder Blob können Clients für diese Entitäten auch mithilfe der get_client-Funktionen abgerufen werden.

Weitere optionale Konfigurationen finden Sie hier.

Vererbung

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)

Parameter

account_url

str

Erforderlich

Die URL des Blobspeicherkontos. Alle anderen Entitäten, die im URL-Pfad enthalten sind (z. B. Container oder Blob), werden verworfen. Diese URL kann optional mit einem SAS-Token authentifiziert werden.

credential

Standardwert: None

Die Anmeldeinformationen, mit denen die Authentifizierung erfolgt. Dies ist optional, wenn die Konto-URL bereits über ein SAS-Token verfügt. Der Wert kann eine SAS-Tokenzeichenfolge, ein instance einer AzureSasCredential- oder AzureNamedKeyCredential-Instanz von azure.core.credentials, ein freigegebener Zugriffsschlüssel für ein Konto oder ein instance einer TokenCredentials-Klasse aus azure.identity sein. Wenn der Ressourcen-URI bereits ein SAS-Token enthält, wird dies zugunsten expliziter Anmeldeinformationen ignoriert.

• außer im Fall von AzureSasCredential, bei dem die in Konflikt stehenden SAS-Token einen ValueError auslösen. Wenn Sie eine instance von AzureNamedKeyCredential verwenden, sollte "name" der Name des Speicherkontos und "key" der Speicherkontoschlüssel sein.

api_version

str

Die Speicher-API-Version, die für Anforderungen verwendet werden soll. Der Standardwert ist die neueste Dienstversion, die mit dem aktuellen SDK kompatibel ist. Die Einstellung auf eine ältere Version kann zu einer geringeren Featurekompatibilität führen.

Neu in Version 12.2.0.

secondary_hostname

str

Der Hostname des sekundären Endpunkts.

max_block_size

int

Die maximale Blockgröße für das Hochladen eines Blockblobs in Blöcken. Standardmäßig 4*1024*1024 oder 4 MB.

max_single_put_size

int

Wenn die Blobgröße kleiner oder gleich max_single_put_size ist, wird das Blob nur mit einer http PUT-Anforderung hochgeladen. Wenn die Blobgröße größer als max_single_put_size ist, wird das Blob in Blöcken hochgeladen. Die Standardwerte sind 64*1024*1024 oder 64 MB.

min_large_block_upload_threshold

int

Die minimale Blockgröße, die erforderlich ist, um den speichereffizienten Algorithmus beim Hochladen eines Blockblobs zu verwenden. Standardwert ist 4*1024*1024+1.

use_byte_buffer

bool

Verwenden Sie einen Bytepuffer für Blockblobuploads. Der Standardwert lautet „False“.

max_page_size

int

Die maximale Blockgröße für das Hochladen eines Seitenblobs. Standardmäßig 4*1024*1024 oder 4 MB.

max_single_get_size

int

Die maximale Größe für ein Blob, das in einem einzelnen Aufruf heruntergeladen werden soll. Der überschrittene Teil wird in Blöcken heruntergeladen (kann parallel sein). Die Standardwerte sind 32*1024*1024 oder 32 MB.

max_chunk_get_size

int

Die maximale Blockgröße, die zum Herunterladen eines Blobs verwendet wird. Standardmäßig 4*1024*1024 oder 4 MB.

Methoden

close	Diese Methode besteht darin, die vom Client geöffneten Sockets zu schließen. Es muss nicht verwendet werden, wenn sie mit einem Kontext-Manager verwendet wird.
create_container	Erstellt einen neuen Container unter dem angegebenen Konto. Wenn der Container mit demselben Namen bereits vorhanden ist, wird ein ResourceExistsError ausgelöst. Diese Methode gibt einen Client zurück, mit dem mit dem neu erstellten Container interagieren soll.
delete_container	Markiert den angegebenen Container zum Löschen. Der Container und alle darin enthaltenen BLOBs werden später während der automatischen Speicherbereinigung gelöscht. Wenn der Container nicht gefunden wird, wird ein ResourceNotFoundError ausgelöst.
find_blobs_by_tags	Mit dem Vorgang "Blob filtern" können Aufrufer Blobs in allen Containern auflisten, deren Tags mit einem bestimmten Suchausdruck übereinstimmen. Filterblobs durchsuchen alle Container innerhalb eines Speicherkontos, können aber innerhalb des Ausdrucks auf einen einzelnen Container festgelegt werden.
from_connection_string	Erstellen Sie BlobServiceClient aus einer Verbindungszeichenfolge.
get_account_information	Ruft Informationen ab, die sich auf das Speicherkonto beziehen. Die Informationen können auch abgerufen werden, wenn der Benutzer über eine SAS für einen Container oder blob verfügt. Die Schlüssel im zurückgegebenen Wörterbuch enthalten "sku_name" und "account_kind".
get_blob_client	Rufen Sie einen Client für die Interaktion mit dem angegebenen Blob ab. Das Blob muss noch nicht vorhanden sein.
get_container_client	Rufen Sie einen Client für die Interaktion mit dem angegebenen Container ab. Der Container muss noch nicht vorhanden sein.
get_service_properties	Ruft die Eigenschaften des Blobdiensts eines Speicherkontos ab, einschließlich Azure Storage Analytics.
get_service_stats	Ruft Statistiken zur Replikation für den Blob-Dienst ab. Sie ist nur verfügbar, wenn die georedundante Replikation mit Lesezugriff für das Speicherkonto aktiviert ist. Mit der georedundanten Replikation behält der Azure-Speicher Daten an zwei Standorten permanent bei. An beiden Standorten behält der Azure-Speicher mehrere fehlerfreie Replikate der Daten bei. Der Standort, an dem Sie Daten lesen, erstellen, aktualisieren oder löschen, ist der primäre Speicherkontostandort. Der primäre Standort befindet sich in der Region, die Sie zum Zeitpunkt der Erstellung eines Kontos über das klassische Azure Management-Azure-Portal ausgewählt haben, z. B. USA, Norden, Mitte. Als sekundärer Standort wird der Standort bezeichnet, an dem die Daten repliziert werden. Der sekundäre Standort wird automatisch auf Grundlage des primären Standorts ermittelt und befindet sich in einem zweiten Rechenzentrum in derselben Region wie der primäre Standort. Der schreibgeschützte Zugriff ist über den sekundären Standort verfügbar, wenn die georedundante Replikation mit Lesezugriff für das Speicherkonto aktiviert ist.
get_user_delegation_key	Rufen Sie einen Benutzerdelegierungsschlüssel zum Signieren von SAS-Token ab. Im Dienstobjekt müssen Tokenanmeldeinformationen vorhanden sein, damit diese Anforderung erfolgreich ist.
list_containers	Gibt einen Generator zurück, um die Container unter dem angegebenen Konto aufzulisten. Der Generator folgt den vom Dienst zurückgegebenen Fortsetzungstoken und wird beendet, wenn alle Container zurückgegeben wurden.
set_service_properties	Legt die Eigenschaften des Blobdiensts eines Speicherkontos fest, einschließlich Azure Storage Analytics. Wenn ein Element (z. B. analytics_logging) als None belassen wird, werden die vorhandenen Einstellungen des Diensts für diese Funktionalität beibehalten.
undelete_container	Stellt vorläufig gelöschte Container wieder her. Der Vorgang ist nur erfolgreich, wenn er innerhalb der angegebenen Anzahl von Tagen verwendet wird, die in der Aufbewahrungsrichtlinie für Löschvorgänge festgelegt ist. Neu in Version 12.4.0: Dieser Vorgang wurde in der API-Version "2019-12-12" eingeführt.

close

Diese Methode besteht darin, die vom Client geöffneten Sockets zu schließen. Es muss nicht verwendet werden, wenn sie mit einem Kontext-Manager verwendet wird.

close()

create_container

Erstellt einen neuen Container unter dem angegebenen Konto.

Wenn der Container mit demselben Namen bereits vorhanden ist, wird ein ResourceExistsError ausgelöst. Diese Methode gibt einen Client zurück, mit dem mit dem neu erstellten Container interagieren soll.

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

Parameter

name

str

Erforderlich

Der Name des zu erstellenden Containers.

metadata

dict(str, str)

Erforderlich

Ein Diktat mit Name-Wert-Paaren, die dem Container als Metadaten zugeordnet werden sollen. Beispiel: {'Category':'test'}

public_access

str oder PublicAccess

Erforderlich

Mögliche Werte sind : "container", "blob".

container_encryption_scope

dict oder ContainerEncryptionScope

Gibt den Standardverschlüsselungsbereich an, der für den Container festgelegt und für alle zukünftigen Schreibvorgänge verwendet werden soll.

Neu in Version 12.2.0.

timeout

int

Legt das serverseitige Timeout für den Vorgang in Sekunden fest. Weitere Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Rückgabetyp

ContainerClient

delete_container

Markiert den angegebenen Container zum Löschen.

Der Container und alle darin enthaltenen BLOBs werden später während der automatischen Speicherbereinigung gelöscht. Wenn der Container nicht gefunden wird, wird ein ResourceNotFoundError ausgelöst.

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

Parameter

container

str oder ContainerProperties

Erforderlich

Der zu löschende Container. Dies kann entweder der Name des Containers oder eine instance von ContainerProperties sein.

lease

Erforderlich

Wenn angegeben, ist delete_container nur erfolgreich, wenn die Lease des Containers aktiv ist und dieser ID entspricht. Erforderlich, wenn der Container über eine aktive Lease verfügt.

if_modified_since

datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit der angegebenen Zeit geändert wurde.

if_unmodified_since

datetime

Ein DateTime-Wert Azure erwartet, dass der übergebene Datumswert UTC ist. Wenn Zeitzone enthalten ist, werden alle Datumstimes ohne UTC in UTC konvertiert. Wenn ein Datum ohne Zeitzoneninformationen übergeben wird, wird davon ausgegangen, dass es UTC ist. Mit diesem Header legen Sie fest, dass der Vorgang nur ausgeführt wird, wenn die Ressource seit dem angegebenen Datum/der angegebenen Uhrzeit nicht geändert wurde.

etag

str

Ein ETag-Wert oder das Platzhalterzeichen (*). Wird verwendet, um zu überprüfen, ob sich die Ressource geändert hat, und handelt gemäß der Bedingung, die vom parameter match_condition angegeben wird.

match_condition

MatchConditions

Die Übereinstimmungsbedingung, die für das etag verwendet werden soll.

timeout

int

Legt das serverseitige Timeout für den Vorgang in Sekunden fest. Weitere Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Rückgabetyp

None

find_blobs_by_tags

Mit dem Vorgang "Blob filtern" können Aufrufer Blobs in allen Containern auflisten, deren Tags mit einem bestimmten Suchausdruck übereinstimmen. Filterblobs durchsuchen alle Container innerhalb eines Speicherkontos, können aber innerhalb des Ausdrucks auf einen einzelnen Container festgelegt werden.

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

Parameter

filter_expression

str

Erforderlich

Der Ausdruck, um Blobs zu finden, deren Tags der angegebenen Bedingung entsprechen. Beispiel: ""yourtagname"='firsttag' und "yourtagname2"='secondtag'" So geben Sie einen Container an, z. B. "@container='containerName' und "Name"='C'"

results_per_page

int

Das maximale Ergebnis pro Seite beim Paginieren.

timeout

int

Legt das serverseitige Timeout für den Vorgang in Sekunden fest. Weitere Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Gibt zurück

Eine iterierbare Antwort (automatisches Paging) von BlobProperties.

Rückgabetyp

ItemPaged[FilteredBlob]

from_connection_string

Erstellen Sie BlobServiceClient aus einer Verbindungszeichenfolge.

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

Parameter

conn_str

str

Erforderlich

Eine Verbindungszeichenfolge zu einem Azure Storage-Konto.

credential

Standardwert: None

Die Anmeldeinformationen, mit denen die Authentifizierung erfolgt. Dies ist optional, wenn die Konto-URL bereits über ein SAS-Token verfügt oder die Verbindungszeichenfolge bereits freigegebene Zugriffsschlüsselwerte aufweist. Der Wert kann eine SAS-Tokenzeichenfolge, ein instance einer AzureSasCredential- oder AzureNamedKeyCredential-Instanz von azure.core.credentials, ein freigegebener Zugriffsschlüssel für ein Konto oder ein instance einer TokenCredentials-Klasse aus azure.identity sein. Die hier angegebenen Anmeldeinformationen haben Vorrang vor denen in der Verbindungszeichenfolge. Wenn Sie eine instance von AzureNamedKeyCredential verwenden, sollte "name" der Name des Speicherkontos und "key" der Speicherkontoschlüssel sein.

Gibt zurück

Ein Blobdienstclient.

Rückgabetyp

BlobServiceClient

get_account_information

Ruft Informationen ab, die sich auf das Speicherkonto beziehen.

Die Informationen können auch abgerufen werden, wenn der Benutzer über eine SAS für einen Container oder blob verfügt. Die Schlüssel im zurückgegebenen Wörterbuch enthalten "sku_name" und "account_kind".

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

Gibt zurück

Ein Dict der Kontoinformationen (SKU und Kontotyp).

Rückgabetyp

dict(str, str)

get_blob_client

Rufen Sie einen Client für die Interaktion mit dem angegebenen Blob ab.

Das Blob muss noch nicht vorhanden sein.

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

Parameter

container

str oder ContainerProperties

Erforderlich

Der Container, in dem sich das Blob befindet. Dies kann entweder der Name des Containers oder eine instance von ContainerProperties sein.

blob

str oder BlobProperties

Erforderlich

Das Blob, mit dem interagiert werden soll. Dies kann entweder der Name des Blobs oder eine instance von BlobProperties sein.

snapshot

str oder dict(str, Any)

Standardwert: None

Das optionale Blob Momentaufnahme, mit dem ausgeführt werden soll. Dies kann entweder die ID des Momentaufnahme oder eine von create_snapshotzurückgegebene Wörterbuchausgabe sein.

version_id

str

Der Versions-ID-Parameter ist ein undurchsichtiger DateTime-Wert, der, wenn vorhanden, die Version des Blobs angibt, mit dem ausgeführt werden soll.

Gibt zurück

Ein BlobClient.

Rückgabetyp

BlobClient

get_container_client

Rufen Sie einen Client für die Interaktion mit dem angegebenen Container ab.

Der Container muss noch nicht vorhanden sein.

get_container_client(container: ContainerProperties | str) -> ContainerClient

Parameter

container

str oder ContainerProperties

Erforderlich

Der Container. Dies kann entweder der Name des Containers oder eine instance von ContainerProperties sein.

Gibt zurück

Ein ContainerClient.

Rückgabetyp

ContainerClient

get_service_properties

Ruft die Eigenschaften des Blobdiensts eines Speicherkontos ab, einschließlich Azure Storage Analytics.

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

Parameter

timeout

int

Legt das serverseitige Timeout für den Vorgang in Sekunden fest. Weitere Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Gibt zurück

Ein Objekt, das Blobdiensteigenschaften wie Analyseprotokollierung, Stunden-/Minutenmetriken, Cors-Regeln usw. enthält.

Rückgabetyp

Dict[str, Any]

get_service_stats

Ruft Statistiken zur Replikation für den Blob-Dienst ab.

Sie ist nur verfügbar, wenn die georedundante Replikation mit Lesezugriff für das Speicherkonto aktiviert ist.

Mit der georedundanten Replikation behält der Azure-Speicher Daten an zwei Standorten permanent bei. An beiden Standorten behält der Azure-Speicher mehrere fehlerfreie Replikate der Daten bei. Der Standort, an dem Sie Daten lesen, erstellen, aktualisieren oder löschen, ist der primäre Speicherkontostandort. Der primäre Standort befindet sich in der Region, die Sie zum Zeitpunkt der Erstellung eines Kontos über das klassische Azure Management-Azure-Portal ausgewählt haben, z. B. USA, Norden, Mitte. Als sekundärer Standort wird der Standort bezeichnet, an dem die Daten repliziert werden. Der sekundäre Standort wird automatisch auf Grundlage des primären Standorts ermittelt und befindet sich in einem zweiten Rechenzentrum in derselben Region wie der primäre Standort. Der schreibgeschützte Zugriff ist über den sekundären Standort verfügbar, wenn die georedundante Replikation mit Lesezugriff für das Speicherkonto aktiviert ist.

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

Parameter

timeout

int

Legt das serverseitige Timeout für den Vorgang in Sekunden fest. Weitere Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Gibt zurück

Die Blob-Dienststatistiken.

Rückgabetyp

Dict[str, Any]

get_user_delegation_key

Rufen Sie einen Benutzerdelegierungsschlüssel zum Signieren von SAS-Token ab. Im Dienstobjekt müssen Tokenanmeldeinformationen vorhanden sein, damit diese Anforderung erfolgreich ist.

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

Parameter

key_start_time

datetime

Erforderlich

Ein DateTime-Wert Gibt an, wann der Schlüssel gültig wird.

key_expiry_time

datetime

Erforderlich

Ein DateTime-Wert Gibt an, wenn der Schlüssel nicht mehr gültig ist.

timeout

int

Legt das serverseitige Timeout für den Vorgang in Sekunden fest. Weitere Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Gibt zurück

Der Benutzerdelegierungsschlüssel.

Rückgabetyp

UserDelegationKey

list_containers

Gibt einen Generator zurück, um die Container unter dem angegebenen Konto aufzulisten.

Der Generator folgt den vom Dienst zurückgegebenen Fortsetzungstoken und wird beendet, wenn alle Container zurückgegeben wurden.

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

Parameter

name_starts_with

str

Erforderlich

Filtert die Ergebnisse so, dass nur Container zurückgegeben werden, deren Namen mit dem angegebenen Präfix beginnen.

include_metadata

bool

Erforderlich

Gibt an, dass Containermetadaten in der Antwort zurückgegeben werden sollen. Der Standardwert ist False.

include_deleted

bool

Gibt an, dass gelöschte Container in der Antwort zurückgegeben werden sollen. Dies gilt für ein Konto, das die Containerwiederherstellung aktiviert hat. Der Standardwert ist False. .. versionadded:: 12.4.0

include_system

bool

Flag, das angibt, dass Systemcontainer enthalten sein sollen. .. versionadded:: 12.10.0

results_per_page

int

Die maximale Anzahl von Containernamen, die pro API-Aufruf abgerufen werden sollen. Wenn die Anforderung nicht angibt, gibt der Server bis zu 5.000 Elemente zurück.

timeout

int

Legt das serverseitige Timeout für den Vorgang in Sekunden fest. Weitere Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Gibt zurück

Ein iterables (automatisches Paging) von ContainerProperties.

Rückgabetyp

ItemPaged[ContainerProperties]

set_service_properties

Legt die Eigenschaften des Blobdiensts eines Speicherkontos fest, einschließlich Azure Storage Analytics.

Wenn ein Element (z. B. analytics_logging) als None belassen wird, werden die vorhandenen Einstellungen des Diensts für diese Funktionalität beibehalten.

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

Parameter

analytics_logging

BlobAnalyticsLogging

Erforderlich

Gruppiert die Logging-Einstellungen für Azure-Analysen.

hour_metrics

Metrics

Erforderlich

Die Einstellungen für Stundenmetriken bieten eine Zusammenfassung der Anforderungsstatistiken, die nach API gruppiert sind, in Stündchenaggregaten für Blobs.

minute_metrics

Metrics

Erforderlich

Die Minutenmetrikeneinstellungen stellen Anforderungsstatistiken für jede Minute für Blobs bereit.

cors

list[CorsRule]

Erforderlich

Sie können bis zu fünf CorsRule-Elemente in die Liste aufnehmen. Wenn eine leere Liste angegeben wird, werden alle CORS-Regeln gelöscht, und CORS wird für den Dienst deaktiviert.

target_version

str

Erforderlich

Gibt die Standardversion an, die für Anforderungen verwendet werden soll, wenn die Version einer eingehenden Anforderung nicht angegeben wird.

delete_retention_policy

RetentionPolicy

Erforderlich

Die Aufbewahrungsrichtlinie zum Löschen gibt an, ob gelöschte Blobs beibehalten werden sollen. Es gibt auch die Anzahl der Tage und Versionen des Blobs an, die beibehalten werden sollen.

static_website

StaticWebsite

Erforderlich

Gibt an, ob die Statische Website-Funktion aktiviert ist, und wenn ja, gibt das Indexdokument und das zu verwendende Fehlerdokument 404 an.

timeout

int

Legt das serverseitige Timeout für den Vorgang in Sekunden fest. Weitere Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Rückgabetyp

None

undelete_container

Stellt vorläufig gelöschte Container wieder her.

Der Vorgang ist nur erfolgreich, wenn er innerhalb der angegebenen Anzahl von Tagen verwendet wird, die in der Aufbewahrungsrichtlinie für Löschvorgänge festgelegt ist.

Neu in Version 12.4.0: Dieser Vorgang wurde in der API-Version "2019-12-12" eingeführt.

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

Parameter

deleted_container_name

str

Erforderlich

Gibt den Namen des gelöschten Containers an, der wiederhergestellt werden soll.

deleted_container_version

str

Erforderlich

Gibt die Version des gelöschten Containers an, der wiederhergestellt werden soll.

timeout

int

Legt das serverseitige Timeout für den Vorgang in Sekunden fest. Weitere Informationen finden Sie unter https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations. Dieser Wert wird nicht auf dem Client nachverfolgt oder überprüft. Informationen zum Konfigurieren clientseitiger Netzwerktimeouts finden Sie hier.

Gibt zurück

Der nicht gelöschte ContainerClient.

Rückgabetyp

ContainerClient

Attribute

api_version

Die Version der Speicher-API, die für Anforderungen verwendet wird.

location_mode

Der Standortmodus, den der Client derzeit verwendet.

Standardmäßig ist dies "primär". Zu den Optionen gehören "primär" und "sekundär".

primary_endpoint

Die vollständige URL des primären Endpunkts.

primary_hostname

Der Hostname des primären Endpunkts.

secondary_endpoint

Die vollständige sekundäre Endpunkt-URL, falls konfiguriert.

Wenn kein Wertfehler verfügbar ist, wird ein ValueError ausgelöst. Um einen sekundären Hostnamen explizit anzugeben, verwenden Sie das optionale secondary_hostname Schlüsselwort (keyword) Argument für die Instanziierung.

Ausnahmen

ValueError

secondary_hostname

Der Hostname des sekundären Endpunkts.

Falls nicht verfügbar, ist dies Keine. Um einen sekundären Hostnamen explizit anzugeben, verwenden Sie das optionale secondary_hostname Schlüsselwort (keyword) Argument für die Instanziierung.

url

Die vollständige Endpunkt-URL für diese Entität, einschließlich SAS-Token, falls verwendet.

Dies kann entweder der primäre Endpunkt oder der sekundäre Endpunkt sein, abhängig vom aktuellen location_mode. :returns: Die vollständige Endpunkt-URL für diese Entität, einschließlich SAS-Token, falls verwendet. :rtype: str