BlobServiceClient Klas
Een client voor interactie met de Blob-service op accountniveau.
Deze client biedt bewerkingen voor het ophalen en configureren van de accounteigenschappen, evenals het weergeven, maken en verwijderen van containers in het account. Voor bewerkingen met betrekking tot een specifieke container of blob kunnen clients voor deze entiteiten ook worden opgehaald met behulp van de get_client-functies .
Klik hier voor meer optionele configuratie.
- Overname
-
azure.storage.blob._shared.base_client.StorageAccountHostsMixinBlobServiceClientazure.storage.blob._encryption.StorageEncryptionMixinBlobServiceClient
Constructor
BlobServiceClient(account_url: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any)
Parameters
- account_url
- str
De URL naar het blob-opslagaccount. Alle andere entiteiten die zijn opgenomen in het URL-pad (bijvoorbeeld container of blob), worden verwijderd. Deze URL kan optioneel worden geverifieerd met een SAS-token.
- credential
De referenties waarmee moet worden geverifieerd. Dit is optioneel als de account-URL al een SAS-token heeft. De waarde kan een SAS-tokentekenreeks zijn, een exemplaar van een AzureSasCredential of AzureNamedKeyCredential van azure.core.credentials, een gedeelde toegangssleutel voor het account of een exemplaar van een TokenCredentials-klasse van azure.identity. Als de resource-URI al een SAS-token bevat, wordt dit genegeerd ten gunste van een expliciete referentie
- behalve in het geval van AzureSasCredential, waarbij de conflicterende SAS-tokens een ValueError genereren. Als u een exemplaar van AzureNamedKeyCredential gebruikt, moet 'name' de naam van het opslagaccount zijn en moet 'sleutel' de sleutel van het opslagaccount zijn.
- api_version
- str
De storage-API-versie die moet worden gebruikt voor aanvragen. De standaardwaarde is de meest recente serviceversie die compatibel is met de huidige SDK. Instellen op een oudere versie kan leiden tot verminderde compatibiliteit van functies.
Nieuw in versie 12.2.0.
- secondary_hostname
- str
De hostnaam van het secundaire eindpunt.
- max_block_size
- int
De maximale segmentgrootte voor het uploaden van een blok-blob in segmenten.
De standaardinstelling is 4*1024*1024
of 4 MB.
- max_single_put_size
- int
Als de blobgrootte kleiner is dan of gelijk is aan max_single_put_size, wordt de blob geüpload met slechts één HTTP PUT-aanvraag. Als de blob groter is dan max_single_put_size, wordt de blob in segmenten geüpload. De standaardwaarde is 64*1024*1024
of 64 MB.
- min_large_block_upload_threshold
- int
De minimale segmentgrootte die is vereist om het geheugenefficiënte algoritme te gebruiken bij het uploaden van een blok-blob. De standaardinstelling is 4*1024*1024
+1.
- use_byte_buffer
- bool
Gebruik een bytebuffer voor blok-blob-uploads. Standaard ingesteld op False.
- max_page_size
- int
De maximale segmentgrootte voor het uploaden van een pagina-blob. De standaardinstelling is 4*1024*1024
of 4 MB.
- max_single_get_size
- int
De maximale grootte voor een blob die in één aanroep moet worden gedownload, het overschreden gedeelte wordt in segmenten gedownload (kan parallel zijn). De standaardwaarde is 32*1024*1024
of 32 MB.
- max_chunk_get_size
- int
De maximale segmentgrootte die wordt gebruikt voor het downloaden van een blob. De standaardinstelling is 4*1024*1024
of 4 MB.
Methoden
close |
Deze methode is het sluiten van de sockets die door de client zijn geopend. Deze hoeft niet te worden gebruikt bij gebruik met een contextbeheerder. |
create_container |
Hiermee maakt u een nieuwe container onder het opgegeven account. Als de container met dezelfde naam al bestaat, wordt er een ResourceExistsError gegenereerd. Deze methode retourneert een client waarmee kan worden gecommuniceerd met de zojuist gemaakte container. |
delete_container |
Markeert de opgegeven container voor verwijdering. De container en eventuele blobs in de container worden later verwijderd tijdens de garbagecollection. Als de container niet wordt gevonden, wordt er een ResourceNotFoundError gegenereerd. |
find_blobs_by_tags |
Met de bewerking Blobs filteren kunnen aanroepers blobs weergeven in alle containers waarvan de tags overeenkomen met een bepaalde zoekexpressie. Filter-blobs doorzoekt alle containers binnen een opslagaccount, maar kan binnen de expressie worden beperkt tot één container. |
from_connection_string |
Maak BlobServiceClient op basis van een verbindingsreeks. |
get_account_information |
Hiermee haalt u informatie op met betrekking tot het opslagaccount. De informatie kan ook worden opgehaald als de gebruiker een SAS naar een container of blob heeft. De toetsen in de geretourneerde woordenlijst bevatten 'sku_name' en 'account_kind'. |
get_blob_client |
Vraag een client om te communiceren met de opgegeven blob. De blob hoeft nog niet te bestaan. |
get_container_client |
Vraag een client om te communiceren met de opgegeven container. De container hoeft nog niet te bestaan. |
get_service_properties |
Hiermee haalt u de eigenschappen op van de Blob-service van een opslagaccount, waaronder Azure Opslaganalyse. |
get_service_stats |
Hiermee worden statistieken opgehaald met betrekking tot replicatie voor de Blob-service. Deze is alleen beschikbaar wanneer geografisch redundante replicatie met leestoegang is ingeschakeld voor het opslagaccount. Met geografisch redundante replicatie houdt Azure Storage uw gegevens duurzaam op twee locaties. Op beide locaties onderhoudt Azure Storage voortdurend meerdere goede replica's van uw gegevens. De locatie waar u gegevens leest, maakt, bijwerkt of verwijdert, is de locatie van het primaire opslagaccount. De primaire locatie bestaat in de regio die u kiest op het moment dat u een account maakt via de klassieke Azure-portal van Azure Management, bijvoorbeeld VS - noord-centraal. De locatie waarnaar uw gegevens worden gerepliceerd, is de secundaire locatie. De secundaire locatie wordt automatisch bepaald op basis van de locatie van de primaire; het bevindt zich in een tweede datacenter dat zich in dezelfde regio bevindt als de primaire locatie. Alleen-lezentoegang is beschikbaar vanaf de secundaire locatie, als geografisch redundante replicatie met leestoegang is ingeschakeld voor uw opslagaccount. |
get_user_delegation_key |
Verkrijg een sleutel voor gebruikersdelegatie voor het ondertekenen van SAS-tokens. Deze aanvraag slaagt alleen als er een tokenreferentie aanwezig is op het serviceobject. |
list_containers |
Retourneert een generator om de containers onder het opgegeven account weer te geven. De generator volgt lazily de vervolgtokens die door de service worden geretourneerd en stopt wanneer alle containers zijn geretourneerd. |
set_service_properties |
Hiermee stelt u de eigenschappen van de Blob-service van een opslagaccount in, waaronder Azure Opslaganalyse. Als een element (bijvoorbeeld analytics_logging) wordt overgelaten op Geen, blijven de bestaande instellingen in de service voor die functionaliteit behouden. |
undelete_container |
Herstelt voorlopig verwijderde container. De bewerking is alleen geslaagd als deze wordt gebruikt binnen het opgegeven aantal dagen dat is ingesteld in het bewaarbeleid voor verwijderen. Nieuw in versie 12.4.0: deze bewerking is geïntroduceerd in API-versie '2019-12-12'. |
close
Deze methode is het sluiten van de sockets die door de client zijn geopend. Deze hoeft niet te worden gebruikt bij gebruik met een contextbeheerder.
close()
create_container
Hiermee maakt u een nieuwe container onder het opgegeven account.
Als de container met dezelfde naam al bestaat, wordt er een ResourceExistsError gegenereerd. Deze methode retourneert een client waarmee kan worden gecommuniceerd met de zojuist gemaakte container.
create_container(name: str, metadata: Dict[str, str] | None = None, public_access: PublicAccess | str | None = None, **kwargs) -> ContainerClient
Parameters
Een dict met naam-waardeparen om als metagegevens aan de container te koppelen. Voorbeeld: {'Category':'test'}
- container_encryption_scope
- dict of ContainerEncryptionScope
Hiermee geeft u het standaardversleutelingsbereik op dat moet worden ingesteld voor de container en moet worden gebruikt voor alle toekomstige schrijfbewerkingen.
Nieuw in versie 12.2.0.
- timeout
- int
Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Zie hier als u netwerktime-outs aan de clientzijde wilt configureren.
Retourtype
delete_container
Markeert de opgegeven container voor verwijdering.
De container en eventuele blobs in de container worden later verwijderd tijdens de garbagecollection. Als de container niet wordt gevonden, wordt er een ResourceNotFoundError gegenereerd.
delete_container(container: ContainerProperties | str, lease: BlobLeaseClient | str | None = None, **kwargs) -> None
Parameters
- container
- str of ContainerProperties
De container die moet worden verwijderd. Dit kan de naam van de container zijn of een exemplaar van ContainerProperties.
- lease
Indien opgegeven, slaagt delete_container alleen als de lease van de container actief is en overeenkomt met deze id. Vereist als de container een actieve lease heeft.
- if_modified_since
- datetime
Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource sinds de opgegeven tijd is gewijzigd.
- if_unmodified_since
- datetime
Een datum/tijd-waarde. Azure verwacht dat de doorgegeven datumwaarde UTC is. Als tijdzone is opgenomen, worden alle niet-UTC-datums geconverteerd naar UTC. Als een datum wordt doorgegeven zonder tijdzone-informatie, wordt ervan uitgegaan dat deze UTC is. Geef deze header op om de bewerking alleen uit te voeren als de resource niet is gewijzigd sinds de opgegeven datum/tijd.
- etag
- str
Een ETag-waarde of het jokerteken (*). Wordt gebruikt om te controleren of de resource is gewijzigd en om te handelen volgens de voorwaarde die is opgegeven door de parameter match_condition .
- match_condition
- MatchConditions
De overeenkomstvoorwaarde die moet worden gebruikt voor de etag.
- timeout
- int
Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Zie hier als u netwerktime-outs aan de clientzijde wilt configureren.
Retourtype
find_blobs_by_tags
Met de bewerking Blobs filteren kunnen aanroepers blobs weergeven in alle containers waarvan de tags overeenkomen met een bepaalde zoekexpressie. Filter-blobs doorzoekt alle containers binnen een opslagaccount, maar kan binnen de expressie worden beperkt tot één container.
find_blobs_by_tags(filter_expression: str, **kwargs: Any) -> ItemPaged[FilteredBlob]
Parameters
- filter_expression
- str
De expressie om blobs te vinden waarvan de tags overeenkomen met de opgegeven voorwaarde. bijvoorbeeld ""yourtagname"='firsttag' en "yourtagname2"='secondtag'" Als u een container wilt opgeven, bijvoorbeeld. "@container='containerName' en "Name"='C'"
- results_per_page
- int
Het maximale resultaat per pagina bij het pagineren.
- timeout
- int
Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.
Retouren
Een iterable (automatisch paging) antwoord van BlobProperties.
Retourtype
from_connection_string
Maak BlobServiceClient op basis van een verbindingsreeks.
from_connection_string(conn_str: str, credential: str | Dict[str, str] | AzureNamedKeyCredential | AzureSasCredential | TokenCredential | None = None, **kwargs: Any) -> Self
Parameters
- credential
De referenties waarmee moet worden geverifieerd. Dit is optioneel als de account-URL al een SAS-token heeft of als de connection string al waarden voor gedeelde toegangssleutels heeft. De waarde kan een SAS-tokentekenreeks zijn, een exemplaar van een AzureSasCredential of AzureNamedKeyCredential van azure.core.credentials, een gedeelde toegangssleutel voor een account of een exemplaar van een TokenCredentials-klasse van azure.identity. Referenties die hier worden opgegeven, hebben voorrang op de referenties in de connection string. Als u een exemplaar van AzureNamedKeyCredential gebruikt, moet 'naam' de naam van het opslagaccount zijn en moet 'sleutel' de sleutel van het opslagaccount zijn.
Retouren
Een Blob-serviceclient.
Retourtype
get_account_information
Hiermee haalt u informatie op met betrekking tot het opslagaccount.
De informatie kan ook worden opgehaald als de gebruiker een SAS naar een container of blob heeft. De toetsen in de geretourneerde woordenlijst bevatten 'sku_name' en 'account_kind'.
get_account_information(**kwargs: Any) -> Dict[str, str]
Retouren
Een beoordeling van accountgegevens (SKU en accounttype).
Retourtype
get_blob_client
Vraag een client om te communiceren met de opgegeven blob.
De blob hoeft nog niet te bestaan.
get_blob_client(container: ContainerProperties | str, blob: BlobProperties | str, snapshot: Dict[str, Any] | str | None = None, *, version_id: str | None = None) -> BlobClient
Parameters
- container
- str of ContainerProperties
De container waarin de blob zich bevindt. Dit kan de naam van de container zijn of een exemplaar van ContainerProperties.
- blob
- str of BlobProperties
De blob waarmee u wilt communiceren. Dit kan de naam van de blob zijn of een exemplaar van BlobEigenschappen.
De optionele blob-momentopname waarop moet worden uitgevoerd. Dit kan de id van de momentopname zijn of een woordenlijstuitvoer die wordt geretourneerd door create_snapshot.
- version_id
- str
De parameter versie-id is een ondoorzichtige DateTime-waarde die, indien aanwezig, aangeeft welke versie van de blob moet worden uitgevoerd.
Retouren
Een BlobClient.
Retourtype
get_container_client
Vraag een client om te communiceren met de opgegeven container.
De container hoeft nog niet te bestaan.
get_container_client(container: ContainerProperties | str) -> ContainerClient
Parameters
- container
- str of ContainerProperties
De container. Dit kan de naam van de container zijn of een exemplaar van ContainerProperties.
Retouren
Een ContainerClient.
Retourtype
get_service_properties
Hiermee haalt u de eigenschappen op van de Blob-service van een opslagaccount, waaronder Azure Opslaganalyse.
get_service_properties(**kwargs: Any) -> Dict[str, Any]
Parameters
- timeout
- int
Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.
Retouren
Een object met blobservice-eigenschappen, zoals logboekregistratie van analyses, metrische gegevens per uur/minuut, cors-regels, enzovoort.
Retourtype
get_service_stats
Hiermee worden statistieken opgehaald met betrekking tot replicatie voor de Blob-service.
Deze is alleen beschikbaar wanneer geografisch redundante replicatie met leestoegang is ingeschakeld voor het opslagaccount.
Met geografisch redundante replicatie houdt Azure Storage uw gegevens duurzaam op twee locaties. Op beide locaties onderhoudt Azure Storage voortdurend meerdere goede replica's van uw gegevens. De locatie waar u gegevens leest, maakt, bijwerkt of verwijdert, is de locatie van het primaire opslagaccount. De primaire locatie bestaat in de regio die u kiest op het moment dat u een account maakt via de klassieke Azure-portal van Azure Management, bijvoorbeeld VS - noord-centraal. De locatie waarnaar uw gegevens worden gerepliceerd, is de secundaire locatie. De secundaire locatie wordt automatisch bepaald op basis van de locatie van de primaire; het bevindt zich in een tweede datacenter dat zich in dezelfde regio bevindt als de primaire locatie. Alleen-lezentoegang is beschikbaar vanaf de secundaire locatie, als geografisch redundante replicatie met leestoegang is ingeschakeld voor uw opslagaccount.
get_service_stats(**kwargs: Any) -> Dict[str, Any]
Parameters
- timeout
- int
Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.
Retouren
De blobservicestatistieken.
Retourtype
get_user_delegation_key
Verkrijg een sleutel voor gebruikersdelegatie voor het ondertekenen van SAS-tokens. Deze aanvraag slaagt alleen als er een tokenreferentie aanwezig is op het serviceobject.
get_user_delegation_key(key_start_time: datetime, key_expiry_time: datetime, **kwargs: Any) -> UserDelegationKey
Parameters
- key_expiry_time
- datetime
Een datum/tijd-waarde. Geeft aan wanneer de sleutel niet meer geldig is.
- timeout
- int
Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.
Retouren
De sleutel voor gebruikersdelegatie.
Retourtype
list_containers
Retourneert een generator om de containers onder het opgegeven account weer te geven.
De generator volgt lazily de vervolgtokens die door de service worden geretourneerd en stopt wanneer alle containers zijn geretourneerd.
list_containers(name_starts_with: str | None = None, include_metadata: bool | None = False, **kwargs) -> ItemPaged[ContainerProperties]
Parameters
- name_starts_with
- str
Filtert de resultaten om alleen containers te retourneren waarvan de naam begint met het opgegeven voorvoegsel.
- include_metadata
- bool
Hiermee geeft u op dat de metagegevens van de container moeten worden geretourneerd in het antwoord. De standaardwaarde is False.
- include_deleted
- bool
Hiermee geeft u op dat verwijderde containers moeten worden geretourneerd in het antwoord. Dit is voor een account waarvoor containerherstel is ingeschakeld. De standaardwaarde is False. .. versionadded:: 12.4.0
- include_system
- bool
Vlag die aangeeft dat systeemcontainers moeten worden opgenomen. .. versionadded:: 12.10.0
- results_per_page
- int
Het maximum aantal containernamen dat per API-aanroep moet worden opgehaald. Als de aanvraag niet opgeeft, retourneert de server maximaal 5000 items.
- timeout
- int
Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.
Retouren
Een iterable (automatisch paging) van ContainerProperties.
Retourtype
set_service_properties
Hiermee stelt u de eigenschappen van de Blob-service van een opslagaccount in, waaronder Azure Opslaganalyse.
Als een element (bijvoorbeeld analytics_logging) wordt overgelaten op Geen, blijven de bestaande instellingen in de service voor die functionaliteit behouden.
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
Parameters
- analytics_logging
- BlobAnalyticsLogging
Groepeert de azure Analytics-instellingen voor logboekregistratie.
- hour_metrics
- Metrics
De instellingen voor metrische uurgegevens bieden een samenvatting van aanvraagstatistieken gegroepeerd per API in aggregaties per uur voor blobs.
- minute_metrics
- Metrics
De instellingen voor metrische minuutgegevens bieden aanvraagstatistieken voor elke minuut voor blobs.
U kunt maximaal vijf CorsRule-elementen in de lijst opnemen. Als er een lege lijst is opgegeven, worden alle CORS-regels verwijderd en CORS uitgeschakeld voor de service.
- target_version
- str
Geeft de standaardversie aan die moet worden gebruikt voor aanvragen als de versie van een binnenkomende aanvraag niet is opgegeven.
- delete_retention_policy
- RetentionPolicy
Het bewaarbeleid voor verwijderen geeft aan of verwijderde blobs moeten worden behouden. Ook wordt het aantal dagen en versies van de blob opgegeven dat moet worden bewaard.
- static_website
- StaticWebsite
Hiermee geeft u op of de functie statische website is ingeschakeld en zo ja, geeft u het indexdocument en het 404-foutdocument aan dat moet worden gebruikt.
- timeout
- int
Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Als u netwerktime-outs aan de clientzijde wilt configureren, raadpleegt u hier.
Retourtype
undelete_container
Herstelt voorlopig verwijderde container.
De bewerking is alleen geslaagd als deze wordt gebruikt binnen het opgegeven aantal dagen dat is ingesteld in het bewaarbeleid voor verwijderen.
Nieuw in versie 12.4.0: deze bewerking is geïntroduceerd in API-versie '2019-12-12'.
undelete_container(deleted_container_name: str, deleted_container_version: str, **kwargs: Any) -> ContainerClient
Parameters
- deleted_container_name
- str
Hiermee geeft u de naam van de verwijderde container te herstellen.
- deleted_container_version
- str
Hiermee geeft u de versie van de verwijderde container te herstellen.
- timeout
- int
Hiermee stelt u de time-out aan de serverzijde voor de bewerking in seconden in. Zie https://learn.microsoft.com/rest/api/storageservices/setting-timeouts-for-blob-service-operations voor meer informatie. Deze waarde wordt niet bijgehouden of gevalideerd op de client. Zie hier als u netwerktime-outs aan de clientzijde wilt configureren.
Retouren
De niet-verwijderde ContainerClient.
Retourtype
Kenmerken
api_version
De versie van de Storage-API die wordt gebruikt voor aanvragen.
location_mode
De locatiemodus die de client momenteel gebruikt.
Dit is standaard 'primair'. Opties zijn 'primair' en 'secundair'.
primary_endpoint
De volledige URL van het primaire eindpunt.
primary_hostname
De hostnaam van het primaire eindpunt.
secondary_endpoint
De volledige url van het secundaire eindpunt, indien geconfigureerd.
Als dit niet beschikbaar is, wordt er een ValueError gegenereerd. Als u expliciet een secundaire hostnaam wilt opgeven, gebruikt u het optionele secondary_hostname trefwoordargument bij instantiëring.
Uitzonderingen
secondary_hostname
De hostnaam van het secundaire eindpunt.
Als dit niet beschikbaar is, is dit Geen. Als u expliciet een secundaire hostnaam wilt opgeven, gebruikt u het optionele secondary_hostname trefwoordargument bij instantiëring.
url
De volledige eindpunt-URL naar deze entiteit, inclusief SAS-token indien gebruikt.
Dit kan het primaire eindpunt of het secundaire eindpunt zijn, afhankelijk van de huidige location_mode. :retourneert: de volledige eindpunt-URL naar deze entiteit, inclusief SAS-token indien gebruikt. :rtype: str
Azure SDK for Python