azure-docs-sdk-java/docs-ref-autogen/com.azure.storage.blob.Blob...

461 строка
66 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.storage.blob.BlobServiceAsyncClient"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient"
name: "BlobServiceAsyncClient"
nameWithType: "BlobServiceAsyncClient"
summary: "Client to a storage account."
inheritances:
- "<xref href=\"java.lang.Object?displayProperty=fullName\" data-throw-if-not-resolved=\"False\" />"
inheritedClassMethods:
- classRef: "java.lang.<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html\">Object</a>"
methodsRef:
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--\">clone</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-\">equals</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--\">finalize</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--\">getClass</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--\">hashCode</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--\">notify</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--\">notifyAll</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#toString--\">toString</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-\">wait</a>"
- "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-\">wait</a>"
syntax: "public final class **BlobServiceAsyncClient**"
methods:
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.createBlobContainer(java.lang.String)"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.createBlobContainer(String containerName)"
name: "createBlobContainer(String containerName)"
nameWithType: "BlobServiceAsyncClient.createBlobContainer(String containerName)"
summary: "Creates a new container within a storage account."
parameters:
- description: "Name of the container to create"
name: "containerName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<BlobContainerAsyncClient> createBlobContainer(String containerName)"
desc: "Creates a new container within a storage account. If a container with the same name already exists, the operation fails. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nBlobContainerAsyncClient blobContainerAsyncClient =\n client.createBlobContainer(\"containerName\").block();\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/create-container"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing a <xref uid=\"com.azure.storage.blob.BlobContainerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerAsyncClient\"></xref> used to interact with the container created."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.storage.blob.BlobContainerAsyncClient?alt=com.azure.storage.blob.BlobContainerAsyncClient&text=BlobContainerAsyncClient\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.createBlobContainerIfNotExists(java.lang.String)"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.createBlobContainerIfNotExists(String containerName)"
name: "createBlobContainerIfNotExists(String containerName)"
nameWithType: "BlobServiceAsyncClient.createBlobContainerIfNotExists(String containerName)"
summary: "Creates a new container within a storage account if it does not exist."
parameters:
- description: "Name of the container to create"
name: "containerName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<BlobContainerAsyncClient> createBlobContainerIfNotExists(String containerName)"
desc: "Creates a new container within a storage account if it does not exist. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nBlobContainerAsyncClient blobContainerAsyncClient =\n client.createBlobContainerIfNotExists(\"containerName\").block();\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/create-container"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing a <xref uid=\"com.azure.storage.blob.BlobContainerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerAsyncClient\"></xref> used to interact with the container created."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.storage.blob.BlobContainerAsyncClient?alt=com.azure.storage.blob.BlobContainerAsyncClient&text=BlobContainerAsyncClient\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.createBlobContainerIfNotExistsWithResponse(java.lang.String,com.azure.storage.blob.options.BlobContainerCreateOptions)"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.createBlobContainerIfNotExistsWithResponse(String containerName, BlobContainerCreateOptions options)"
name: "createBlobContainerIfNotExistsWithResponse(String containerName, BlobContainerCreateOptions options)"
nameWithType: "BlobServiceAsyncClient.createBlobContainerIfNotExistsWithResponse(String containerName, BlobContainerCreateOptions options)"
summary: "Creates a new container within a storage account if it does not exist."
parameters:
- description: "Name of the container to create"
name: "containerName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "<xref uid=\"com.azure.storage.blob.options.BlobContainerCreateOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerCreateOptions\"></xref>"
name: "options"
type: "<xref href=\"com.azure.storage.blob.options.BlobContainerCreateOptions?alt=com.azure.storage.blob.options.BlobContainerCreateOptions&text=BlobContainerCreateOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<BlobContainerAsyncClient>> createBlobContainerIfNotExistsWithResponse(String containerName, BlobContainerCreateOptions options)"
desc: "Creates a new container within a storage account if it does not exist. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nMap<String, String> metadata = Collections.singletonMap(\"metadata\", \"value\");\n BlobContainerCreateOptions options = new BlobContainerCreateOptions().setMetadata(metadata)\n .setPublicAccessType(PublicAccessType.CONTAINER);\n\n client.createBlobContainerIfNotExistsWithResponse(\"containerName\", options).subscribe(response -> {\n if (response.getStatusCode() == 409) {\n System.out.println(\"Already exists.\");\n } else {\n System.out.println(\"successfully created.\");\n }\n });\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/create-container"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing a <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> whose <xref uid=\"com.azure.core.http.rest.Response.getValue*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"value\"></xref> contains a <xref uid=\"com.azure.storage.blob.BlobContainerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerAsyncClient\"></xref> used to interact with the container created. If <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>'s status code is 201,\n a new container was successfully created. If status code is 409, a container with the same name already existed\n at this location."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.blob.BlobContainerAsyncClient?alt=com.azure.storage.blob.BlobContainerAsyncClient&text=BlobContainerAsyncClient\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.createBlobContainerWithResponse(java.lang.String,java.util.Map<java.lang.String,java.lang.String>,com.azure.storage.blob.models.PublicAccessType)"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.createBlobContainerWithResponse(String containerName, Map<String,String> metadata, PublicAccessType accessType)"
name: "createBlobContainerWithResponse(String containerName, Map<String,String> metadata, PublicAccessType accessType)"
nameWithType: "BlobServiceAsyncClient.createBlobContainerWithResponse(String containerName, Map<String,String> metadata, PublicAccessType accessType)"
summary: "Creates a new container within a storage account."
parameters:
- description: "Name of the container to create"
name: "containerName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Metadata to associate with the container. If there is leading or trailing whitespace in any\n metadata key or value, it must be removed or encoded."
name: "metadata"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/Map.html\">Map</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>,<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- description: "Specifies how the data in this container is available to the public. See the\n x-ms-blob-public-access header in the Azure Docs for more information. Pass null for no public access."
name: "accessType"
type: "<xref href=\"com.azure.storage.blob.models.PublicAccessType?alt=com.azure.storage.blob.models.PublicAccessType&text=PublicAccessType\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<BlobContainerAsyncClient>> createBlobContainerWithResponse(String containerName, Map<String,String> metadata, PublicAccessType accessType)"
desc: "Creates a new container within a storage account. If a container with the same name already exists, the operation fails. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nMap<String, String> metadata = Collections.singletonMap(\"metadata\", \"value\");\n\n BlobContainerAsyncClient containerClient = client\n .createBlobContainerWithResponse(\"containerName\", metadata, PublicAccessType.CONTAINER).block().getValue();\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/create-container"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing a <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> whose <xref uid=\"com.azure.core.http.rest.Response.getValue*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"value\"></xref> contains a <xref uid=\"com.azure.storage.blob.BlobContainerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerAsyncClient\"></xref> used to interact with the container created."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.blob.BlobContainerAsyncClient?alt=com.azure.storage.blob.BlobContainerAsyncClient&text=BlobContainerAsyncClient\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.deleteBlobContainer(java.lang.String)"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.deleteBlobContainer(String containerName)"
name: "deleteBlobContainer(String containerName)"
nameWithType: "BlobServiceAsyncClient.deleteBlobContainer(String containerName)"
summary: "Deletes the specified container in the storage account."
parameters:
- description: "Name of the container to delete"
name: "containerName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<Void> deleteBlobContainer(String containerName)"
desc: "Deletes the specified container in the storage account. If the container doesn't exist the operation fails. For more information see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nclient.deleteBlobContainer(\"containerName\").subscribe(\n response -> System.out.printf(\"Delete container completed%n\"),\n error -> System.out.printf(\"Delete container failed: %s%n\", error));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/delete-container"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing status code and HTTP headers"
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.deleteBlobContainerIfExists(java.lang.String)"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.deleteBlobContainerIfExists(String containerName)"
name: "deleteBlobContainerIfExists(String containerName)"
nameWithType: "BlobServiceAsyncClient.deleteBlobContainerIfExists(String containerName)"
summary: "Deletes the specified container in the storage account if it exists."
parameters:
- description: "Name of the container to delete"
name: "containerName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<Boolean> deleteBlobContainerIfExists(String containerName)"
desc: "Deletes the specified container in the storage account if it exists. For more information see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nclient.deleteBlobContainerIfExists(\"containerName\").subscribe(deleted -> {\n if (deleted) {\n System.out.println(\"Successfully deleted.\");\n } else {\n System.out.println(\"Does not exist.\");\n }\n });\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/delete-container"
returns:
description: "A reactive <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> signaling completion. <code>true</code> indicates that the container was deleted.\n <code>false</code> indicates the container does not exist at this location."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>&gt;"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.deleteBlobContainerIfExistsWithResponse(java.lang.String)"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.deleteBlobContainerIfExistsWithResponse(String containerName)"
name: "deleteBlobContainerIfExistsWithResponse(String containerName)"
nameWithType: "BlobServiceAsyncClient.deleteBlobContainerIfExistsWithResponse(String containerName)"
summary: "Deletes the specified container in the storage account if it exists."
parameters:
- description: "Name of the container to delete"
name: "containerName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<Response<Boolean>> deleteBlobContainerIfExistsWithResponse(String containerName)"
desc: "Deletes the specified container in the storage account if it exists. For more information see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nContext context = new Context(\"Key\", \"Value\");\n client.deleteBlobContainerIfExistsWithResponse(\"containerName\").subscribe(response -> {\n if (response.getStatusCode() == 404) {\n System.out.println(\"Does not exist.\");\n } else {\n System.out.println(\"successfully deleted.\");\n }\n });\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/delete-container"
returns:
description: "A reactive response signaling completion. If <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>'s status code is 202, the blob container was\n successfully deleted. If status code is 404, the blob container does not exist."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Boolean.html\">Boolean</a>&gt;&gt;"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.deleteBlobContainerWithResponse(java.lang.String)"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.deleteBlobContainerWithResponse(String containerName)"
name: "deleteBlobContainerWithResponse(String containerName)"
nameWithType: "BlobServiceAsyncClient.deleteBlobContainerWithResponse(String containerName)"
summary: "Deletes the specified container in the storage account."
parameters:
- description: "Name of the container to delete"
name: "containerName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<Response<Void>> deleteBlobContainerWithResponse(String containerName)"
desc: "Deletes the specified container in the storage account. If the container doesn't exist the operation fails. For more information see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nContext context = new Context(\"Key\", \"Value\");\n client.deleteBlobContainerWithResponse(\"containerName\").subscribe(response ->\n System.out.printf(\"Delete container completed with status %d%n\", response.getStatusCode()));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/delete-container"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing status code and HTTP headers"
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;&gt;"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.findBlobsByTags(com.azure.storage.blob.options.FindBlobsOptions)"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.findBlobsByTags(FindBlobsOptions options)"
name: "findBlobsByTags(FindBlobsOptions options)"
nameWithType: "BlobServiceAsyncClient.findBlobsByTags(FindBlobsOptions options)"
summary: "Returns a reactive Publisher emitting the blobs in this account whose tags match the query expression."
parameters:
- description: "<xref uid=\"com.azure.storage.blob.options.FindBlobsOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"FindBlobsOptions\"></xref>"
name: "options"
type: "<xref href=\"com.azure.storage.blob.options.FindBlobsOptions?alt=com.azure.storage.blob.options.FindBlobsOptions&text=FindBlobsOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PagedFlux<TaggedBlobItem> findBlobsByTags(FindBlobsOptions options)"
desc: "Returns a reactive Publisher emitting the blobs in this account whose tags match the query expression. For more information, including information on the query syntax, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nclient.findBlobsByTags(new FindBlobsOptions(\"where=tag=value\").setMaxResultsPerPage(10))\n .subscribe(blob -> System.out.printf(\"Name: %s%n\", blob.getName()));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/find-blobs-by-tags"
returns:
description: "A reactive response emitting the list of blobs."
type: "<xref href=\"com.azure.core.http.rest.PagedFlux?alt=com.azure.core.http.rest.PagedFlux&text=PagedFlux\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.blob.models.TaggedBlobItem?alt=com.azure.storage.blob.models.TaggedBlobItem&text=TaggedBlobItem\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.findBlobsByTags(java.lang.String)"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.findBlobsByTags(String query)"
name: "findBlobsByTags(String query)"
nameWithType: "BlobServiceAsyncClient.findBlobsByTags(String query)"
summary: "Returns a reactive Publisher emitting the blobs in this account whose tags match the query expression."
parameters:
- description: "Filters the results to return only blobs whose tags match the specified expression."
name: "query"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public PagedFlux<TaggedBlobItem> findBlobsByTags(String query)"
desc: "Returns a reactive Publisher emitting the blobs in this account whose tags match the query expression. For more information, including information on the query syntax, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nclient.findBlobsByTags(\"where=tag=value\").subscribe(blob -> System.out.printf(\"Name: %s%n\", blob.getName()));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/find-blobs-by-tags"
returns:
description: "A reactive response emitting the list of blobs."
type: "<xref href=\"com.azure.core.http.rest.PagedFlux?alt=com.azure.core.http.rest.PagedFlux&text=PagedFlux\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.blob.models.TaggedBlobItem?alt=com.azure.storage.blob.models.TaggedBlobItem&text=TaggedBlobItem\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.generateAccountSas(com.azure.storage.common.sas.AccountSasSignatureValues)"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.generateAccountSas(AccountSasSignatureValues accountSasSignatureValues)"
name: "generateAccountSas(AccountSasSignatureValues accountSasSignatureValues)"
nameWithType: "BlobServiceAsyncClient.generateAccountSas(AccountSasSignatureValues accountSasSignatureValues)"
summary: "Generates an account SAS for the Azure Storage account using the specified <xref uid=\"com.azure.storage.common.sas.AccountSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasSignatureValues\"></xref>."
parameters:
- description: "<xref uid=\"com.azure.storage.common.sas.AccountSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasSignatureValues\"></xref>"
name: "accountSasSignatureValues"
type: "<xref href=\"com.azure.storage.common.sas.AccountSasSignatureValues?alt=com.azure.storage.common.sas.AccountSasSignatureValues&text=AccountSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
syntax: "public String generateAccountSas(AccountSasSignatureValues accountSasSignatureValues)"
desc: "Generates an account SAS for the Azure Storage account using the specified <xref uid=\"com.azure.storage.common.sas.AccountSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasSignatureValues\"></xref>.\n\nNote : The client must be authenticated via <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"StorageSharedKeyCredential\"></xref>\n\nSee <xref uid=\"com.azure.storage.common.sas.AccountSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasSignatureValues\"></xref> for more information on how to construct an account SAS.\n\nThe snippet below generates a SAS that lasts for two days and gives the user read and list access to blob containers and file shares.\n\n```java\nAccountSasPermission permissions = new AccountSasPermission()\n .setListPermission(true)\n .setReadPermission(true);\n AccountSasResourceType resourceTypes = new AccountSasResourceType().setContainer(true);\n AccountSasService services = new AccountSasService().setBlobAccess(true).setFileAccess(true);\n OffsetDateTime expiryTime = OffsetDateTime.now().plus(Duration.ofDays(2));\n\n AccountSasSignatureValues sasValues =\n new AccountSasSignatureValues(expiryTime, permissions, services, resourceTypes);\n\n // Client must be authenticated via StorageSharedKeyCredential\n String sas = client.generateAccountSas(sasValues);\n```"
returns:
description: "A <code>String</code> representing the SAS query parameters."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.generateAccountSas(com.azure.storage.common.sas.AccountSasSignatureValues,com.azure.core.util.Context)"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.generateAccountSas(AccountSasSignatureValues accountSasSignatureValues, Context context)"
name: "generateAccountSas(AccountSasSignatureValues accountSasSignatureValues, Context context)"
nameWithType: "BlobServiceAsyncClient.generateAccountSas(AccountSasSignatureValues accountSasSignatureValues, Context context)"
summary: "Generates an account SAS for the Azure Storage account using the specified <xref uid=\"com.azure.storage.common.sas.AccountSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasSignatureValues\"></xref>."
parameters:
- description: "<xref uid=\"com.azure.storage.common.sas.AccountSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasSignatureValues\"></xref>"
name: "accountSasSignatureValues"
type: "<xref href=\"com.azure.storage.common.sas.AccountSasSignatureValues?alt=com.azure.storage.common.sas.AccountSasSignatureValues&text=AccountSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
- description: "Additional context that is passed through the code when generating a SAS."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public String generateAccountSas(AccountSasSignatureValues accountSasSignatureValues, Context context)"
desc: "Generates an account SAS for the Azure Storage account using the specified <xref uid=\"com.azure.storage.common.sas.AccountSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasSignatureValues\"></xref>.\n\nNote : The client must be authenticated via <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"StorageSharedKeyCredential\"></xref>\n\nSee <xref uid=\"com.azure.storage.common.sas.AccountSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasSignatureValues\"></xref> for more information on how to construct an account SAS.\n\nThe snippet below generates a SAS that lasts for two days and gives the user read and list access to blob containers and file shares.\n\n```java\nAccountSasPermission permissions = new AccountSasPermission()\n .setListPermission(true)\n .setReadPermission(true);\n AccountSasResourceType resourceTypes = new AccountSasResourceType().setContainer(true);\n AccountSasService services = new AccountSasService().setBlobAccess(true).setFileAccess(true);\n OffsetDateTime expiryTime = OffsetDateTime.now().plus(Duration.ofDays(2));\n\n AccountSasSignatureValues sasValues =\n new AccountSasSignatureValues(expiryTime, permissions, services, resourceTypes);\n\n // Client must be authenticated via StorageSharedKeyCredential\n String sas = client.generateAccountSas(sasValues, new Context(\"key\", \"value\"));\n```"
returns:
description: "A <code>String</code> representing the SAS query parameters."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.generateAccountSas(com.azure.storage.common.sas.AccountSasSignatureValues,java.util.function.Consumer<java.lang.String>,com.azure.core.util.Context)"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.generateAccountSas(AccountSasSignatureValues accountSasSignatureValues, Consumer<String> stringToSignHandler, Context context)"
name: "generateAccountSas(AccountSasSignatureValues accountSasSignatureValues, Consumer<String> stringToSignHandler, Context context)"
nameWithType: "BlobServiceAsyncClient.generateAccountSas(AccountSasSignatureValues accountSasSignatureValues, Consumer<String> stringToSignHandler, Context context)"
summary: "Generates an account SAS for the Azure Storage account using the specified <xref uid=\"com.azure.storage.common.sas.AccountSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasSignatureValues\"></xref>."
parameters:
- description: "<xref uid=\"com.azure.storage.common.sas.AccountSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasSignatureValues\"></xref>"
name: "accountSasSignatureValues"
type: "<xref href=\"com.azure.storage.common.sas.AccountSasSignatureValues?alt=com.azure.storage.common.sas.AccountSasSignatureValues&text=AccountSasSignatureValues\" data-throw-if-not-resolved=\"False\" />"
- description: "For debugging purposes only. Returns the string to sign that was used to generate the\n signature."
name: "stringToSignHandler"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/util/function/Consumer.html\">Consumer</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>&gt;"
- description: "Additional context that is passed through the code when generating a SAS."
name: "context"
type: "<xref href=\"com.azure.core.util.Context?alt=com.azure.core.util.Context&text=Context\" data-throw-if-not-resolved=\"False\" />"
syntax: "public String generateAccountSas(AccountSasSignatureValues accountSasSignatureValues, Consumer<String> stringToSignHandler, Context context)"
desc: "Generates an account SAS for the Azure Storage account using the specified <xref uid=\"com.azure.storage.common.sas.AccountSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasSignatureValues\"></xref>.\n\nNote : The client must be authenticated via <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"StorageSharedKeyCredential\"></xref>\n\nSee <xref uid=\"com.azure.storage.common.sas.AccountSasSignatureValues\" data-throw-if-not-resolved=\"false\" data-raw-source=\"AccountSasSignatureValues\"></xref> for more information on how to construct an account SAS."
returns:
description: "A <code>String</code> representing the SAS query parameters."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.getAccountInfo()"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.getAccountInfo()"
name: "getAccountInfo()"
nameWithType: "BlobServiceAsyncClient.getAccountInfo()"
summary: "Returns the sku name and account kind for the account."
syntax: "public Mono<StorageAccountInfo> getAccountInfo()"
desc: "Returns the sku name and account kind for the account. For more information, please see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nclient.getAccountInfo().subscribe(response ->\n System.out.printf(\"Account kind: %s, SKU: %s%n\", response.getAccountKind(), response.getSkuName()));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/get-account-information"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the storage account info."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.storage.blob.models.StorageAccountInfo?alt=com.azure.storage.blob.models.StorageAccountInfo&text=StorageAccountInfo\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.getAccountInfoWithResponse()"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.getAccountInfoWithResponse()"
name: "getAccountInfoWithResponse()"
nameWithType: "BlobServiceAsyncClient.getAccountInfoWithResponse()"
summary: "Returns the sku name and account kind for the account."
syntax: "public Mono<Response<StorageAccountInfo>> getAccountInfoWithResponse()"
desc: "Returns the sku name and account kind for the account. For more information, please see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nclient.getAccountInfoWithResponse().subscribe(response ->\n System.out.printf(\"Account kind: %s, SKU: %s%n\", response.getValue().getAccountKind(),\n response.getValue().getSkuName()));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/get-account-information"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing a <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> whose <xref uid=\"com.azure.core.http.rest.Response.getValue*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"value\"></xref> the storage account\n info."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.blob.models.StorageAccountInfo?alt=com.azure.storage.blob.models.StorageAccountInfo&text=StorageAccountInfo\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.getAccountName()"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.getAccountName()"
name: "getAccountName()"
nameWithType: "BlobServiceAsyncClient.getAccountName()"
summary: "Get associated account name."
syntax: "public String getAccountName()"
desc: "Get associated account name."
returns:
description: "account name associated with this storage resource."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.getAccountUrl()"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.getAccountUrl()"
name: "getAccountUrl()"
nameWithType: "BlobServiceAsyncClient.getAccountUrl()"
summary: "Gets the URL of the storage account represented by this client."
syntax: "public String getAccountUrl()"
desc: "Gets the URL of the storage account represented by this client."
returns:
description: "the URL."
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.getBlobContainerAsyncClient(java.lang.String)"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.getBlobContainerAsyncClient(String containerName)"
name: "getBlobContainerAsyncClient(String containerName)"
nameWithType: "BlobServiceAsyncClient.getBlobContainerAsyncClient(String containerName)"
summary: "Initializes a <xref uid=\"com.azure.storage.blob.BlobContainerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerAsyncClient\"></xref> object pointing to the specified container."
parameters:
- description: "The name of the container to point to. A value of null or empty string will be interpreted\n as pointing to the root container and will be replaced by \"$root\"."
name: "containerName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public BlobContainerAsyncClient getBlobContainerAsyncClient(String containerName)"
desc: "Initializes a <xref uid=\"com.azure.storage.blob.BlobContainerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerAsyncClient\"></xref> object pointing to the specified container. This method does not create a container. It simply constructs the URL to the container and offers access to methods relevant to containers.\n\n**Code Samples**\n\n```java\nBlobContainerAsyncClient blobContainerAsyncClient = client.getBlobContainerAsyncClient(\"containerName\");\n```"
returns:
description: "A <xref uid=\"com.azure.storage.blob.BlobContainerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerAsyncClient\"></xref> object pointing to the specified container"
type: "<xref href=\"com.azure.storage.blob.BlobContainerAsyncClient?alt=com.azure.storage.blob.BlobContainerAsyncClient&text=BlobContainerAsyncClient\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.getHttpPipeline()"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.getHttpPipeline()"
name: "getHttpPipeline()"
nameWithType: "BlobServiceAsyncClient.getHttpPipeline()"
summary: "Gets the <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> powering this client."
syntax: "public HttpPipeline getHttpPipeline()"
desc: "Gets the <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref> powering this client."
returns:
description: "The pipeline."
type: "<xref href=\"com.azure.core.http.HttpPipeline?alt=com.azure.core.http.HttpPipeline&text=HttpPipeline\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.getProperties()"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.getProperties()"
name: "getProperties()"
nameWithType: "BlobServiceAsyncClient.getProperties()"
summary: "Gets the properties of a storage account\\\\u2019s Blob service."
syntax: "public Mono<BlobServiceProperties> getProperties()"
desc: "Gets the properties of a storage account\\\\u2019s Blob service. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nclient.getProperties().subscribe(response ->\n System.out.printf(\"Hour metrics enabled: %b, Minute metrics enabled: %b%n\",\n response.getHourMetrics().isEnabled(),\n response.getMinuteMetrics().isEnabled()));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/get-blob-service-properties"
returns:
description: "A reactive response containing the storage account properties."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.storage.blob.models.BlobServiceProperties?alt=com.azure.storage.blob.models.BlobServiceProperties&text=BlobServiceProperties\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.getPropertiesWithResponse()"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.getPropertiesWithResponse()"
name: "getPropertiesWithResponse()"
nameWithType: "BlobServiceAsyncClient.getPropertiesWithResponse()"
summary: "Gets the properties of a storage account\\\\u2019s Blob service."
syntax: "public Mono<Response<BlobServiceProperties>> getPropertiesWithResponse()"
desc: "Gets the properties of a storage account\\\\u2019s Blob service. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nclient.getPropertiesWithResponse().subscribe(response ->\n System.out.printf(\"Hour metrics enabled: %b, Minute metrics enabled: %b%n\",\n response.getValue().getHourMetrics().isEnabled(),\n response.getValue().getMinuteMetrics().isEnabled()));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/get-blob-service-properties"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing a <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> whose <xref uid=\"com.azure.core.http.rest.Response.getValue*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"value\"></xref> contains the storage\n account properties."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.blob.models.BlobServiceProperties?alt=com.azure.storage.blob.models.BlobServiceProperties&text=BlobServiceProperties\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.getServiceVersion()"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.getServiceVersion()"
name: "getServiceVersion()"
nameWithType: "BlobServiceAsyncClient.getServiceVersion()"
summary: "Gets the service version the client is using."
syntax: "public BlobServiceVersion getServiceVersion()"
desc: "Gets the service version the client is using."
returns:
description: "the service version the client is using."
type: "<xref href=\"com.azure.storage.blob.BlobServiceVersion?alt=com.azure.storage.blob.BlobServiceVersion&text=BlobServiceVersion\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.getStatistics()"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.getStatistics()"
name: "getStatistics()"
nameWithType: "BlobServiceAsyncClient.getStatistics()"
summary: "Retrieves statistics related to replication for the Blob service."
syntax: "public Mono<BlobServiceStatistics> getStatistics()"
desc: "Retrieves statistics related to replication for the Blob service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nclient.getStatistics().subscribe(response ->\n System.out.printf(\"Geo-replication status: %s%n\", response.getGeoReplication().getStatus()));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/get-blob-service-stats"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the storage account statistics."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.storage.blob.models.BlobServiceStatistics?alt=com.azure.storage.blob.models.BlobServiceStatistics&text=BlobServiceStatistics\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.getStatisticsWithResponse()"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.getStatisticsWithResponse()"
name: "getStatisticsWithResponse()"
nameWithType: "BlobServiceAsyncClient.getStatisticsWithResponse()"
summary: "Retrieves statistics related to replication for the Blob service."
syntax: "public Mono<Response<BlobServiceStatistics>> getStatisticsWithResponse()"
desc: "Retrieves statistics related to replication for the Blob service. It is only available on the secondary location endpoint when read-access geo-redundant replication is enabled for the storage account. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nclient.getStatisticsWithResponse().subscribe(response ->\n System.out.printf(\"Geo-replication status: %s%n\", response.getValue().getGeoReplication().getStatus()));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/get-blob-service-stats"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing a <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> whose <xref uid=\"com.azure.core.http.rest.Response.getValue*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"value\"></xref> containing the\n storage account statistics."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.blob.models.BlobServiceStatistics?alt=com.azure.storage.blob.models.BlobServiceStatistics&text=BlobServiceStatistics\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.getUserDelegationKey(java.time.OffsetDateTime,java.time.OffsetDateTime)"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.getUserDelegationKey(OffsetDateTime start, OffsetDateTime expiry)"
name: "getUserDelegationKey(OffsetDateTime start, OffsetDateTime expiry)"
nameWithType: "BlobServiceAsyncClient.getUserDelegationKey(OffsetDateTime start, OffsetDateTime expiry)"
summary: "Gets a user delegation key for use with this account's blob storage."
parameters:
- description: "Start time for the key's validity. Null indicates immediate start."
name: "start"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- description: "Expiration of the key's validity."
name: "expiry"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
syntax: "public Mono<UserDelegationKey> getUserDelegationKey(OffsetDateTime start, OffsetDateTime expiry)"
desc: "Gets a user delegation key for use with this account's blob storage. Note: This method call is only valid when using <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> in this object's <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref>.\n\n**Code Samples**\n\n```java\nclient.getUserDelegationKey(delegationKeyStartTime, delegationKeyExpiryTime).subscribe(response ->\n System.out.printf(\"User delegation key: %s%n\", response.getValue()));\n```"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the user delegation key."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.storage.blob.models.UserDelegationKey?alt=com.azure.storage.blob.models.UserDelegationKey&text=UserDelegationKey\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.getUserDelegationKeyWithResponse(java.time.OffsetDateTime,java.time.OffsetDateTime)"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.getUserDelegationKeyWithResponse(OffsetDateTime start, OffsetDateTime expiry)"
name: "getUserDelegationKeyWithResponse(OffsetDateTime start, OffsetDateTime expiry)"
nameWithType: "BlobServiceAsyncClient.getUserDelegationKeyWithResponse(OffsetDateTime start, OffsetDateTime expiry)"
summary: "Gets a user delegation key for use with this account's blob storage."
parameters:
- description: "Start time for the key's validity. Null indicates immediate start."
name: "start"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
- description: "Expiration of the key's validity."
name: "expiry"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/time/OffsetDateTime.html\">OffsetDateTime</a>"
syntax: "public Mono<Response<UserDelegationKey>> getUserDelegationKeyWithResponse(OffsetDateTime start, OffsetDateTime expiry)"
desc: "Gets a user delegation key for use with this account's blob storage. Note: This method call is only valid when using <xref uid=\"\" data-throw-if-not-resolved=\"false\" data-raw-source=\"TokenCredential\"></xref> in this object's <xref uid=\"com.azure.core.http.HttpPipeline\" data-throw-if-not-resolved=\"false\" data-raw-source=\"HttpPipeline\"></xref>.\n\n**Code Samples**\n\n```java\nclient.getUserDelegationKeyWithResponse(delegationKeyStartTime, delegationKeyExpiryTime).subscribe(response ->\n System.out.printf(\"User delegation key: %s%n\", response.getValue().getValue()));\n```"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing a <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> whose <xref uid=\"com.azure.core.http.rest.Response.getValue*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"value\"></xref> containing the user\n delegation key."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.blob.models.UserDelegationKey?alt=com.azure.storage.blob.models.UserDelegationKey&text=UserDelegationKey\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.listBlobContainers()"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.listBlobContainers()"
name: "listBlobContainers()"
nameWithType: "BlobServiceAsyncClient.listBlobContainers()"
summary: "Returns a reactive Publisher emitting all the containers in this account lazily as needed."
syntax: "public PagedFlux<BlobContainerItem> listBlobContainers()"
desc: "Returns a reactive Publisher emitting all the containers in this account lazily as needed. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nclient.listBlobContainers().subscribe(container -> System.out.printf(\"Name: %s%n\", container.getName()));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/list-containers2"
returns:
description: "A reactive response emitting the list of containers."
type: "<xref href=\"com.azure.core.http.rest.PagedFlux?alt=com.azure.core.http.rest.PagedFlux&text=PagedFlux\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.blob.models.BlobContainerItem?alt=com.azure.storage.blob.models.BlobContainerItem&text=BlobContainerItem\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.listBlobContainers(com.azure.storage.blob.models.ListBlobContainersOptions)"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.listBlobContainers(ListBlobContainersOptions options)"
name: "listBlobContainers(ListBlobContainersOptions options)"
nameWithType: "BlobServiceAsyncClient.listBlobContainers(ListBlobContainersOptions options)"
summary: "Returns a reactive Publisher emitting all the containers in this account lazily as needed."
parameters:
- description: "A <xref uid=\"com.azure.storage.blob.models.ListBlobContainersOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"ListBlobContainersOptions\"></xref> which specifies what data should be returned by the service."
name: "options"
type: "<xref href=\"com.azure.storage.blob.models.ListBlobContainersOptions?alt=com.azure.storage.blob.models.ListBlobContainersOptions&text=ListBlobContainersOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public PagedFlux<BlobContainerItem> listBlobContainers(ListBlobContainersOptions options)"
desc: "Returns a reactive Publisher emitting all the containers in this account lazily as needed. For more information, see the [Azure Docs][].\n\n**Code Samples**\n\n```java\nListBlobContainersOptions options = new ListBlobContainersOptions()\n .setPrefix(\"containerNamePrefixToMatch\")\n .setDetails(new BlobContainerListDetails().setRetrieveMetadata(true));\n\n client.listBlobContainers(options).subscribe(container -> System.out.printf(\"Name: %s%n\", container.getName()));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/list-containers2"
returns:
description: "A reactive response emitting the list of containers."
type: "<xref href=\"com.azure.core.http.rest.PagedFlux?alt=com.azure.core.http.rest.PagedFlux&text=PagedFlux\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.blob.models.BlobContainerItem?alt=com.azure.storage.blob.models.BlobContainerItem&text=BlobContainerItem\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.setProperties(com.azure.storage.blob.models.BlobServiceProperties)"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.setProperties(BlobServiceProperties properties)"
name: "setProperties(BlobServiceProperties properties)"
nameWithType: "BlobServiceAsyncClient.setProperties(BlobServiceProperties properties)"
summary: "Sets properties for a storage account's Blob service endpoint."
parameters:
- description: "Configures the service."
name: "properties"
type: "<xref href=\"com.azure.storage.blob.models.BlobServiceProperties?alt=com.azure.storage.blob.models.BlobServiceProperties&text=BlobServiceProperties\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Void> setProperties(BlobServiceProperties properties)"
desc: "Sets properties for a storage account's Blob service endpoint. For more information, see the [Azure Docs][]. Note that setting the default service version has no effect when using this client because this client explicitly sets the version header on each request, overriding the default.\n\nThis method checks to ensure the properties being sent follow the specifications indicated in the Azure Docs. If CORS policies are set, CORS parameters that are not set default to the empty string.\n\n**Code Samples**\n\n```java\nBlobRetentionPolicy loggingRetentionPolicy = new BlobRetentionPolicy().setEnabled(true).setDays(3);\n BlobRetentionPolicy metricsRetentionPolicy = new BlobRetentionPolicy().setEnabled(true).setDays(1);\n\n BlobServiceProperties properties = new BlobServiceProperties()\n .setLogging(new BlobAnalyticsLogging()\n .setWrite(true)\n .setDelete(true)\n .setRetentionPolicy(loggingRetentionPolicy))\n .setHourMetrics(new BlobMetrics()\n .setEnabled(true)\n .setRetentionPolicy(metricsRetentionPolicy))\n .setMinuteMetrics(new BlobMetrics()\n .setEnabled(true)\n .setRetentionPolicy(metricsRetentionPolicy));\n\n client.setProperties(properties).subscribe(\n response -> System.out.printf(\"Setting properties completed%n\"),\n error -> System.out.printf(\"Setting properties failed: %s%n\", error));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/set-blob-service-properties"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the storage account properties."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.setPropertiesWithResponse(com.azure.storage.blob.models.BlobServiceProperties)"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.setPropertiesWithResponse(BlobServiceProperties properties)"
name: "setPropertiesWithResponse(BlobServiceProperties properties)"
nameWithType: "BlobServiceAsyncClient.setPropertiesWithResponse(BlobServiceProperties properties)"
summary: "Sets properties for a storage account's Blob service endpoint."
parameters:
- description: "Configures the service."
name: "properties"
type: "<xref href=\"com.azure.storage.blob.models.BlobServiceProperties?alt=com.azure.storage.blob.models.BlobServiceProperties&text=BlobServiceProperties\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<Void>> setPropertiesWithResponse(BlobServiceProperties properties)"
desc: "Sets properties for a storage account's Blob service endpoint. For more information, see the [Azure Docs][]. Note that setting the default service version has no effect when using this client because this client explicitly sets the version header on each request, overriding the default.\n\nThis method checks to ensure the properties being sent follow the specifications indicated in the Azure Docs. If CORS policies are set, CORS parameters that are not set default to the empty string.\n\n**Code Samples**\n\n```java\nBlobRetentionPolicy loggingRetentionPolicy = new BlobRetentionPolicy().setEnabled(true).setDays(3);\n BlobRetentionPolicy metricsRetentionPolicy = new BlobRetentionPolicy().setEnabled(true).setDays(1);\n\n BlobServiceProperties properties = new BlobServiceProperties()\n .setLogging(new BlobAnalyticsLogging()\n .setWrite(true)\n .setDelete(true)\n .setRetentionPolicy(loggingRetentionPolicy))\n .setHourMetrics(new BlobMetrics()\n .setEnabled(true)\n .setRetentionPolicy(metricsRetentionPolicy))\n .setMinuteMetrics(new BlobMetrics()\n .setEnabled(true)\n .setRetentionPolicy(metricsRetentionPolicy));\n\n client.setPropertiesWithResponse(properties).subscribe(response ->\n System.out.printf(\"Setting properties completed with status %d%n\", response.getStatusCode()));\n```\n\n\n[Azure Docs]: https://docs.microsoft.com/rest/api/storageservices/set-blob-service-properties"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing the storage account properties."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;&gt;"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.undeleteBlobContainer(java.lang.String,java.lang.String)"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.undeleteBlobContainer(String deletedContainerName, String deletedContainerVersion)"
name: "undeleteBlobContainer(String deletedContainerName, String deletedContainerVersion)"
nameWithType: "BlobServiceAsyncClient.undeleteBlobContainer(String deletedContainerName, String deletedContainerVersion)"
summary: "Restores a previously deleted container."
parameters:
- description: "The name of the previously deleted container."
name: "deletedContainerName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The version of the previously deleted container."
name: "deletedContainerVersion"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public Mono<BlobContainerAsyncClient> undeleteBlobContainer(String deletedContainerName, String deletedContainerVersion)"
desc: "Restores a previously deleted container. If the container associated with provided `deletedContainerName` already exists, this call will result in a 409 (conflict). This API is only functional if Container Soft Delete is enabled for the storage account associated with the container.\n\n**Code Samples**\n\n```java\nListBlobContainersOptions listBlobContainersOptions = new ListBlobContainersOptions();\n listBlobContainersOptions.getDetails().setRetrieveDeleted(true);\n client.listBlobContainers(listBlobContainersOptions).flatMap(\n deletedContainer -> {\n Mono<BlobContainerAsyncClient> blobContainerClient = client.undeleteBlobContainer(\n deletedContainer.getName(), deletedContainer.getVersion());\n return blobContainerClient;\n }\n ).then().block();\n```"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing a <xref uid=\"com.azure.storage.blob.BlobContainerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerAsyncClient\"></xref> used\n to interact with the restored container."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.storage.blob.BlobContainerAsyncClient?alt=com.azure.storage.blob.BlobContainerAsyncClient&text=BlobContainerAsyncClient\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.storage.blob.BlobServiceAsyncClient.undeleteBlobContainerWithResponse(com.azure.storage.blob.options.UndeleteBlobContainerOptions)"
fullName: "com.azure.storage.blob.BlobServiceAsyncClient.undeleteBlobContainerWithResponse(UndeleteBlobContainerOptions options)"
name: "undeleteBlobContainerWithResponse(UndeleteBlobContainerOptions options)"
nameWithType: "BlobServiceAsyncClient.undeleteBlobContainerWithResponse(UndeleteBlobContainerOptions options)"
summary: "Restores a previously deleted container."
parameters:
- description: "<xref uid=\"com.azure.storage.blob.options.UndeleteBlobContainerOptions\" data-throw-if-not-resolved=\"false\" data-raw-source=\"UndeleteBlobContainerOptions\"></xref>."
name: "options"
type: "<xref href=\"com.azure.storage.blob.options.UndeleteBlobContainerOptions?alt=com.azure.storage.blob.options.UndeleteBlobContainerOptions&text=UndeleteBlobContainerOptions\" data-throw-if-not-resolved=\"False\" />"
syntax: "public Mono<Response<BlobContainerAsyncClient>> undeleteBlobContainerWithResponse(UndeleteBlobContainerOptions options)"
desc: "Restores a previously deleted container. The restored container will be renamed to the `destinationContainerName` if provided in `options`. Otherwise `deletedContainerName` is used as destination container name. If the container associated with provided `destinationContainerName` already exists, this call will result in a 409 (conflict). This API is only functional if Container Soft Delete is enabled for the storage account associated with the container.\n\n**Code Samples**\n\n```java\nListBlobContainersOptions listBlobContainersOptions = new ListBlobContainersOptions();\n listBlobContainersOptions.getDetails().setRetrieveDeleted(true);\n client.listBlobContainers(listBlobContainersOptions).flatMap(\n deletedContainer -> {\n Mono<BlobContainerAsyncClient> blobContainerClient = client.undeleteBlobContainerWithResponse(\n new UndeleteBlobContainerOptions(deletedContainer.getName(), deletedContainer.getVersion()))\n .map(Response::getValue);\n return blobContainerClient;\n }\n ).then().block();\n```"
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> containing a <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> whose <xref uid=\"com.azure.core.http.rest.Response.getValue*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"value\"></xref> contains a <xref uid=\"com.azure.storage.blob.BlobContainerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerAsyncClient\"></xref> used to interact with the restored container."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.core.http.rest.Response?alt=com.azure.core.http.rest.Response&text=Response\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.storage.blob.BlobContainerAsyncClient?alt=com.azure.storage.blob.BlobContainerAsyncClient&text=BlobContainerAsyncClient\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
type: "class"
desc: "Client to a storage account. It may only be instantiated through a <xref uid=\"com.azure.storage.blob.BlobServiceClientBuilder\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobServiceClientBuilder\"></xref>. This class does not hold any state about a particular storage account but is instead a convenient way of sending off appropriate requests to the resource on the service. It may also be used to construct URLs to blobs and containers.\n\nThis client contains operations on a blob. Operations on a container are available on <xref uid=\"com.azure.storage.blob.BlobContainerAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobContainerAsyncClient\"></xref> through <xref uid=\"com.azure.storage.blob.BlobServiceAsyncClient.getBlobContainerAsyncClient(java.lang.String)\" data-throw-if-not-resolved=\"false\" data-raw-source=\"#getBlobContainerAsyncClient(String)\"></xref>, and operations on a blob are available on <xref uid=\"com.azure.storage.blob.BlobAsyncClient\" data-throw-if-not-resolved=\"false\" data-raw-source=\"BlobAsyncClient\"></xref>.\n\nPlease see the [Azure Docs][] for more information on containers.\n\nNote this client is an async client that returns reactive responses from Spring Reactor Core project (https://projectreactor.io/). Calling the methods in this client will **NOT** start the actual network operation, until `.subscribe()` is called on the reactive response. You can simply convert one of these responses to a [CompletableFuture][] object through <xref uid=\"reactor.core.publisher.Mono.toFuture*\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono#toFuture()\"></xref>.\n\n\n[Azure Docs]: https://docs.microsoft.com/azure/storage/blobs/storage-blobs-introduction\n[CompletableFuture]: https://docs.oracle.com/javase/8/docs/api/java/util/concurrent/CompletableFuture.html"
metadata: {}
package: "com.azure.storage.blob"
artifact: com.azure:azure-storage-blob:12.28.1