azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.s...

729 строки
77 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.storage.fluent.FileSharesClient"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient"
name: "FileSharesClient"
nameWithType: "FileSharesClient"
summary: "An instance of this class provides access to all the operations defined in File<wbr>Shares<wbr>Client."
syntax: "public interface **FileSharesClient**"
methods:
- uid: "com.azure.resourcemanager.storage.fluent.FileSharesClient.create(java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.storage.fluent.models.FileShareInner)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.create(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare)"
name: "create(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare)"
nameWithType: "FileSharesClient.create(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare)"
summary: "Creates a new share under the specified account as described by request body."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file share within the specified storage account. File share names must be\n between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-)\n character must be immediately preceded and followed by a letter or number."
name: "shareName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Properties of the file share to create."
name: "fileShare"
type: "<xref href=\"com.azure.resourcemanager.storage.fluent.models.FileShareInner?alt=com.azure.resourcemanager.storage.fluent.models.FileShareInner&text=FileShareInner\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract FileShareInner create(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare)"
desc: "Creates a new share under the specified account as described by request body. The share resource includes metadata and properties for that share. It does not include a list of the files contained by the share."
returns:
description: "properties of the file share, including Id, resource name, resource type, Etag."
type: "<xref href=\"com.azure.resourcemanager.storage.fluent.models.FileShareInner?alt=com.azure.resourcemanager.storage.fluent.models.FileShareInner&text=FileShareInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.storage.fluent.FileSharesClient.createAsync(java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.storage.fluent.models.FileShareInner)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.createAsync(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare)"
name: "createAsync(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare)"
nameWithType: "FileSharesClient.createAsync(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare)"
summary: "Creates a new share under the specified account as described by request body."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file share within the specified storage account. File share names must be\n between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-)\n character must be immediately preceded and followed by a letter or number."
name: "shareName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Properties of the file share to create."
name: "fileShare"
type: "<xref href=\"com.azure.resourcemanager.storage.fluent.models.FileShareInner?alt=com.azure.resourcemanager.storage.fluent.models.FileShareInner&text=FileShareInner\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Mono<FileShareInner> createAsync(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare)"
desc: "Creates a new share under the specified account as described by request body. The share resource includes metadata and properties for that share. It does not include a list of the files contained by the share."
returns:
description: "properties of the file share, including Id, resource name, resource type, Etag on successful completion\n of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.resourcemanager.storage.fluent.models.FileShareInner?alt=com.azure.resourcemanager.storage.fluent.models.FileShareInner&text=FileShareInner\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.storage.fluent.FileSharesClient.createWithResponse(java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.storage.fluent.models.FileShareInner,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.createWithResponse(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare, String expand, Context context)"
name: "createWithResponse(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare, String expand, Context context)"
nameWithType: "FileSharesClient.createWithResponse(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare, String expand, Context context)"
summary: "Creates a new share under the specified account as described by request body."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file share within the specified storage account. File share names must be\n between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-)\n character must be immediately preceded and followed by a letter or number."
name: "shareName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Properties of the file share to create."
name: "fileShare"
type: "<xref href=\"com.azure.resourcemanager.storage.fluent.models.FileShareInner?alt=com.azure.resourcemanager.storage.fluent.models.FileShareInner&text=FileShareInner\" data-throw-if-not-resolved=\"False\" />"
- description: "Optional, used to expand the properties within share's properties. Valid values are: snapshots.\n Should be passed as a string with delimiter ','."
name: "expand"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The context to associate with this operation."
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 abstract Response<FileShareInner> createWithResponse(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare, String expand, Context context)"
desc: "Creates a new share under the specified account as described by request body. The share resource includes metadata and properties for that share. It does not include a list of the files contained by the share."
returns:
description: "properties of the file share, including Id, resource name, resource type, Etag along with\n <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
type: "<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.resourcemanager.storage.fluent.models.FileShareInner?alt=com.azure.resourcemanager.storage.fluent.models.FileShareInner&text=FileShareInner\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.storage.fluent.FileSharesClient.createWithResponseAsync(java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.storage.fluent.models.FileShareInner,java.lang.String)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.createWithResponseAsync(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare, String expand)"
name: "createWithResponseAsync(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare, String expand)"
nameWithType: "FileSharesClient.createWithResponseAsync(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare, String expand)"
summary: "Creates a new share under the specified account as described by request body."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file share within the specified storage account. File share names must be\n between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-)\n character must be immediately preceded and followed by a letter or number."
name: "shareName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Properties of the file share to create."
name: "fileShare"
type: "<xref href=\"com.azure.resourcemanager.storage.fluent.models.FileShareInner?alt=com.azure.resourcemanager.storage.fluent.models.FileShareInner&text=FileShareInner\" data-throw-if-not-resolved=\"False\" />"
- description: "Optional, used to expand the properties within share's properties. Valid values are: snapshots.\n Should be passed as a string with delimiter ','."
name: "expand"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Mono<Response<FileShareInner>> createWithResponseAsync(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare, String expand)"
desc: "Creates a new share under the specified account as described by request body. The share resource includes metadata and properties for that share. It does not include a list of the files contained by the share."
returns:
description: "properties of the file share, including Id, resource name, resource type, Etag along with\n <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
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.resourcemanager.storage.fluent.models.FileShareInner?alt=com.azure.resourcemanager.storage.fluent.models.FileShareInner&text=FileShareInner\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
- uid: "com.azure.resourcemanager.storage.fluent.FileSharesClient.delete(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.delete(String resourceGroupName, String accountName, String shareName)"
name: "delete(String resourceGroupName, String accountName, String shareName)"
nameWithType: "FileSharesClient.delete(String resourceGroupName, String accountName, String shareName)"
summary: "Deletes specified share under its account."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file share within the specified storage account. File share names must be\n between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-)\n character must be immediately preceded and followed by a letter or number."
name: "shareName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract void delete(String resourceGroupName, String accountName, String shareName)"
desc: "Deletes specified share under its account."
- uid: "com.azure.resourcemanager.storage.fluent.FileSharesClient.deleteAsync(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.deleteAsync(String resourceGroupName, String accountName, String shareName)"
name: "deleteAsync(String resourceGroupName, String accountName, String shareName)"
nameWithType: "FileSharesClient.deleteAsync(String resourceGroupName, String accountName, String shareName)"
summary: "Deletes specified share under its account."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file share within the specified storage account. File share names must be\n between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-)\n character must be immediately preceded and followed by a letter or number."
name: "shareName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Mono<Void> deleteAsync(String resourceGroupName, String accountName, String shareName)"
desc: "Deletes specified share under its account."
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> that completes when a successful response is received."
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.resourcemanager.storage.fluent.FileSharesClient.deleteWithResponse(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.deleteWithResponse(String resourceGroupName, String accountName, String shareName, String xMsSnapshot, String include, Context context)"
name: "deleteWithResponse(String resourceGroupName, String accountName, String shareName, String xMsSnapshot, String include, Context context)"
nameWithType: "FileSharesClient.deleteWithResponse(String resourceGroupName, String accountName, String shareName, String xMsSnapshot, String include, Context context)"
summary: "Deletes specified share under its account."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file share within the specified storage account. File share names must be\n between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-)\n character must be immediately preceded and followed by a letter or number."
name: "shareName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Optional, used to delete a snapshot."
name: "xMsSnapshot"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Optional. Valid values are: snapshots, leased-snapshots, none. The default value is snapshots. For\n 'snapshots', the file share is deleted including all of its file share snapshots. If the file share contains\n leased-snapshots, the deletion fails. For 'leased-snapshots', the file share is deleted included all of its file\n share snapshots (leased/unleased). For 'none', the file share is deleted if it has no share snapshots. If the\n file share contains any snapshots (leased or unleased), the deletion fails."
name: "include"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The context to associate with this operation."
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 abstract Response<Void> deleteWithResponse(String resourceGroupName, String accountName, String shareName, String xMsSnapshot, String include, Context context)"
desc: "Deletes specified share under its account."
returns:
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
type: "<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;"
- uid: "com.azure.resourcemanager.storage.fluent.FileSharesClient.deleteWithResponseAsync(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.deleteWithResponseAsync(String resourceGroupName, String accountName, String shareName, String xMsSnapshot, String include)"
name: "deleteWithResponseAsync(String resourceGroupName, String accountName, String shareName, String xMsSnapshot, String include)"
nameWithType: "FileSharesClient.deleteWithResponseAsync(String resourceGroupName, String accountName, String shareName, String xMsSnapshot, String include)"
summary: "Deletes specified share under its account."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file share within the specified storage account. File share names must be\n between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-)\n character must be immediately preceded and followed by a letter or number."
name: "shareName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Optional, used to delete a snapshot."
name: "xMsSnapshot"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Optional. Valid values are: snapshots, leased-snapshots, none. The default value is snapshots. For\n 'snapshots', the file share is deleted including all of its file share snapshots. If the file share contains\n leased-snapshots, the deletion fails. For 'leased-snapshots', the file share is deleted included all of its file\n share snapshots (leased/unleased). For 'none', the file share is deleted if it has no share snapshots. If the\n file share contains any snapshots (leased or unleased), the deletion fails."
name: "include"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Mono<Response<Void>> deleteWithResponseAsync(String resourceGroupName, String accountName, String shareName, String xMsSnapshot, String include)"
desc: "Deletes specified share under its account."
returns:
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
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.resourcemanager.storage.fluent.FileSharesClient.get(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.get(String resourceGroupName, String accountName, String shareName)"
name: "get(String resourceGroupName, String accountName, String shareName)"
nameWithType: "FileSharesClient.get(String resourceGroupName, String accountName, String shareName)"
summary: "Gets properties of a specified share."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file share within the specified storage account. File share names must be\n between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-)\n character must be immediately preceded and followed by a letter or number."
name: "shareName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract FileShareInner get(String resourceGroupName, String accountName, String shareName)"
desc: "Gets properties of a specified share."
returns:
description: "properties of a specified share."
type: "<xref href=\"com.azure.resourcemanager.storage.fluent.models.FileShareInner?alt=com.azure.resourcemanager.storage.fluent.models.FileShareInner&text=FileShareInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.storage.fluent.FileSharesClient.getAsync(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.getAsync(String resourceGroupName, String accountName, String shareName)"
name: "getAsync(String resourceGroupName, String accountName, String shareName)"
nameWithType: "FileSharesClient.getAsync(String resourceGroupName, String accountName, String shareName)"
summary: "Gets properties of a specified share."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file share within the specified storage account. File share names must be\n between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-)\n character must be immediately preceded and followed by a letter or number."
name: "shareName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Mono<FileShareInner> getAsync(String resourceGroupName, String accountName, String shareName)"
desc: "Gets properties of a specified share."
returns:
description: "properties of a specified share on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.resourcemanager.storage.fluent.models.FileShareInner?alt=com.azure.resourcemanager.storage.fluent.models.FileShareInner&text=FileShareInner\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.storage.fluent.FileSharesClient.getWithResponse(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.getWithResponse(String resourceGroupName, String accountName, String shareName, String expand, String xMsSnapshot, Context context)"
name: "getWithResponse(String resourceGroupName, String accountName, String shareName, String expand, String xMsSnapshot, Context context)"
nameWithType: "FileSharesClient.getWithResponse(String resourceGroupName, String accountName, String shareName, String expand, String xMsSnapshot, Context context)"
summary: "Gets properties of a specified share."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file share within the specified storage account. File share names must be\n between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-)\n character must be immediately preceded and followed by a letter or number."
name: "shareName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Optional, used to expand the properties within share's properties. Valid values are: stats. Should\n be passed as a string with delimiter ','."
name: "expand"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Optional, used to retrieve properties of a snapshot."
name: "xMsSnapshot"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The context to associate with this operation."
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 abstract Response<FileShareInner> getWithResponse(String resourceGroupName, String accountName, String shareName, String expand, String xMsSnapshot, Context context)"
desc: "Gets properties of a specified share."
returns:
description: "properties of a specified share along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
type: "<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.resourcemanager.storage.fluent.models.FileShareInner?alt=com.azure.resourcemanager.storage.fluent.models.FileShareInner&text=FileShareInner\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.storage.fluent.FileSharesClient.getWithResponseAsync(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.getWithResponseAsync(String resourceGroupName, String accountName, String shareName, String expand, String xMsSnapshot)"
name: "getWithResponseAsync(String resourceGroupName, String accountName, String shareName, String expand, String xMsSnapshot)"
nameWithType: "FileSharesClient.getWithResponseAsync(String resourceGroupName, String accountName, String shareName, String expand, String xMsSnapshot)"
summary: "Gets properties of a specified share."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file share within the specified storage account. File share names must be\n between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-)\n character must be immediately preceded and followed by a letter or number."
name: "shareName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Optional, used to expand the properties within share's properties. Valid values are: stats. Should\n be passed as a string with delimiter ','."
name: "expand"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Optional, used to retrieve properties of a snapshot."
name: "xMsSnapshot"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Mono<Response<FileShareInner>> getWithResponseAsync(String resourceGroupName, String accountName, String shareName, String expand, String xMsSnapshot)"
desc: "Gets properties of a specified share."
returns:
description: "properties of a specified share along with <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
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.resourcemanager.storage.fluent.models.FileShareInner?alt=com.azure.resourcemanager.storage.fluent.models.FileShareInner&text=FileShareInner\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
- uid: "com.azure.resourcemanager.storage.fluent.FileSharesClient.lease(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.lease(String resourceGroupName, String accountName, String shareName)"
name: "lease(String resourceGroupName, String accountName, String shareName)"
nameWithType: "FileSharesClient.lease(String resourceGroupName, String accountName, String shareName)"
summary: "The Lease Share operation establishes and manages a lock on a share for delete operations."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file share within the specified storage account. File share names must be\n between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-)\n character must be immediately preceded and followed by a letter or number."
name: "shareName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract LeaseShareResponseInner lease(String resourceGroupName, String accountName, String shareName)"
desc: "The Lease Share operation establishes and manages a lock on a share for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite."
returns:
description: "lease Share response schema."
type: "<xref href=\"com.azure.resourcemanager.storage.fluent.models.LeaseShareResponseInner?alt=com.azure.resourcemanager.storage.fluent.models.LeaseShareResponseInner&text=LeaseShareResponseInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.storage.fluent.FileSharesClient.leaseAsync(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.leaseAsync(String resourceGroupName, String accountName, String shareName)"
name: "leaseAsync(String resourceGroupName, String accountName, String shareName)"
nameWithType: "FileSharesClient.leaseAsync(String resourceGroupName, String accountName, String shareName)"
summary: "The Lease Share operation establishes and manages a lock on a share for delete operations."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file share within the specified storage account. File share names must be\n between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-)\n character must be immediately preceded and followed by a letter or number."
name: "shareName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Mono<LeaseShareResponseInner> leaseAsync(String resourceGroupName, String accountName, String shareName)"
desc: "The Lease Share operation establishes and manages a lock on a share for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite."
returns:
description: "lease Share response schema on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.resourcemanager.storage.fluent.models.LeaseShareResponseInner?alt=com.azure.resourcemanager.storage.fluent.models.LeaseShareResponseInner&text=LeaseShareResponseInner\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.storage.fluent.FileSharesClient.leaseWithResponse(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.storage.models.LeaseShareRequest,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.leaseWithResponse(String resourceGroupName, String accountName, String shareName, String xMsSnapshot, LeaseShareRequest parameters, Context context)"
name: "leaseWithResponse(String resourceGroupName, String accountName, String shareName, String xMsSnapshot, LeaseShareRequest parameters, Context context)"
nameWithType: "FileSharesClient.leaseWithResponse(String resourceGroupName, String accountName, String shareName, String xMsSnapshot, LeaseShareRequest parameters, Context context)"
summary: "The Lease Share operation establishes and manages a lock on a share for delete operations."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file share within the specified storage account. File share names must be\n between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-)\n character must be immediately preceded and followed by a letter or number."
name: "shareName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Optional. Specify the snapshot time to lease a snapshot."
name: "xMsSnapshot"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Lease Share request body."
name: "parameters"
type: "<xref href=\"com.azure.resourcemanager.storage.models.LeaseShareRequest?alt=com.azure.resourcemanager.storage.models.LeaseShareRequest&text=LeaseShareRequest\" data-throw-if-not-resolved=\"False\" />"
- description: "The context to associate with this operation."
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 abstract FileSharesLeaseResponse leaseWithResponse(String resourceGroupName, String accountName, String shareName, String xMsSnapshot, LeaseShareRequest parameters, Context context)"
desc: "The Lease Share operation establishes and manages a lock on a share for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite."
returns:
description: "lease Share response schema."
type: "<xref href=\"com.azure.resourcemanager.storage.models.FileSharesLeaseResponse?alt=com.azure.resourcemanager.storage.models.FileSharesLeaseResponse&text=FileSharesLeaseResponse\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.storage.fluent.FileSharesClient.leaseWithResponseAsync(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.storage.models.LeaseShareRequest)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.leaseWithResponseAsync(String resourceGroupName, String accountName, String shareName, String xMsSnapshot, LeaseShareRequest parameters)"
name: "leaseWithResponseAsync(String resourceGroupName, String accountName, String shareName, String xMsSnapshot, LeaseShareRequest parameters)"
nameWithType: "FileSharesClient.leaseWithResponseAsync(String resourceGroupName, String accountName, String shareName, String xMsSnapshot, LeaseShareRequest parameters)"
summary: "The Lease Share operation establishes and manages a lock on a share for delete operations."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file share within the specified storage account. File share names must be\n between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-)\n character must be immediately preceded and followed by a letter or number."
name: "shareName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Optional. Specify the snapshot time to lease a snapshot."
name: "xMsSnapshot"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Lease Share request body."
name: "parameters"
type: "<xref href=\"com.azure.resourcemanager.storage.models.LeaseShareRequest?alt=com.azure.resourcemanager.storage.models.LeaseShareRequest&text=LeaseShareRequest\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Mono<FileSharesLeaseResponse> leaseWithResponseAsync(String resourceGroupName, String accountName, String shareName, String xMsSnapshot, LeaseShareRequest parameters)"
desc: "The Lease Share operation establishes and manages a lock on a share for delete operations. The lock duration can be 15 to 60 seconds, or can be infinite."
returns:
description: "lease Share response schema on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.resourcemanager.storage.models.FileSharesLeaseResponse?alt=com.azure.resourcemanager.storage.models.FileSharesLeaseResponse&text=FileSharesLeaseResponse\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.storage.fluent.FileSharesClient.list(java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.list(String resourceGroupName, String accountName)"
name: "list(String resourceGroupName, String accountName)"
nameWithType: "FileSharesClient.list(String resourceGroupName, String accountName)"
summary: "Lists all shares."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract PagedIterable<FileShareItemInner> list(String resourceGroupName, String accountName)"
desc: "Lists all shares."
returns:
description: "response schema as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.storage.fluent.models.FileShareItemInner?alt=com.azure.resourcemanager.storage.fluent.models.FileShareItemInner&text=FileShareItemInner\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.storage.fluent.FileSharesClient.list(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.list(String resourceGroupName, String accountName, String maxpagesize, String filter, String expand, Context context)"
name: "list(String resourceGroupName, String accountName, String maxpagesize, String filter, String expand, Context context)"
nameWithType: "FileSharesClient.list(String resourceGroupName, String accountName, String maxpagesize, String filter, String expand, Context context)"
summary: "Lists all shares."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Optional. Specified maximum number of shares that can be included in the list."
name: "maxpagesize"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Optional. When specified, only share names starting with the filter will be listed."
name: "filter"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Optional, used to expand the properties within share's properties. Valid values are: deleted,\n snapshots. Should be passed as a string with delimiter ','."
name: "expand"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The context to associate with this operation."
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 abstract PagedIterable<FileShareItemInner> list(String resourceGroupName, String accountName, String maxpagesize, String filter, String expand, Context context)"
desc: "Lists all shares."
returns:
description: "response schema as paginated response with <xref uid=\"com.azure.core.http.rest.PagedIterable\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedIterable\"></xref>."
type: "<xref href=\"com.azure.core.http.rest.PagedIterable?alt=com.azure.core.http.rest.PagedIterable&text=PagedIterable\" data-throw-if-not-resolved=\"False\" />&lt;<xref href=\"com.azure.resourcemanager.storage.fluent.models.FileShareItemInner?alt=com.azure.resourcemanager.storage.fluent.models.FileShareItemInner&text=FileShareItemInner\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.storage.fluent.FileSharesClient.listAsync(java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.listAsync(String resourceGroupName, String accountName)"
name: "listAsync(String resourceGroupName, String accountName)"
nameWithType: "FileSharesClient.listAsync(String resourceGroupName, String accountName)"
summary: "Lists all shares."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract PagedFlux<FileShareItemInner> listAsync(String resourceGroupName, String accountName)"
desc: "Lists all shares."
returns:
description: "response schema as paginated response with <xref uid=\"com.azure.core.http.rest.PagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedFlux\"></xref>."
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.resourcemanager.storage.fluent.models.FileShareItemInner?alt=com.azure.resourcemanager.storage.fluent.models.FileShareItemInner&text=FileShareItemInner\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.storage.fluent.FileSharesClient.listAsync(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.listAsync(String resourceGroupName, String accountName, String maxpagesize, String filter, String expand)"
name: "listAsync(String resourceGroupName, String accountName, String maxpagesize, String filter, String expand)"
nameWithType: "FileSharesClient.listAsync(String resourceGroupName, String accountName, String maxpagesize, String filter, String expand)"
summary: "Lists all shares."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Optional. Specified maximum number of shares that can be included in the list."
name: "maxpagesize"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Optional. When specified, only share names starting with the filter will be listed."
name: "filter"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Optional, used to expand the properties within share's properties. Valid values are: deleted,\n snapshots. Should be passed as a string with delimiter ','."
name: "expand"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract PagedFlux<FileShareItemInner> listAsync(String resourceGroupName, String accountName, String maxpagesize, String filter, String expand)"
desc: "Lists all shares."
returns:
description: "response schema as paginated response with <xref uid=\"com.azure.core.http.rest.PagedFlux\" data-throw-if-not-resolved=\"false\" data-raw-source=\"PagedFlux\"></xref>."
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.resourcemanager.storage.fluent.models.FileShareItemInner?alt=com.azure.resourcemanager.storage.fluent.models.FileShareItemInner&text=FileShareItemInner\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.storage.fluent.FileSharesClient.restore(java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.storage.models.DeletedShare)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.restore(String resourceGroupName, String accountName, String shareName, DeletedShare deletedShare)"
name: "restore(String resourceGroupName, String accountName, String shareName, DeletedShare deletedShare)"
nameWithType: "FileSharesClient.restore(String resourceGroupName, String accountName, String shareName, DeletedShare deletedShare)"
summary: "Restore a file share within a valid retention days if share soft delete is enabled."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file share within the specified storage account. File share names must be\n between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-)\n character must be immediately preceded and followed by a letter or number."
name: "shareName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The deletedShare parameter."
name: "deletedShare"
type: "<xref href=\"com.azure.resourcemanager.storage.models.DeletedShare?alt=com.azure.resourcemanager.storage.models.DeletedShare&text=DeletedShare\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract void restore(String resourceGroupName, String accountName, String shareName, DeletedShare deletedShare)"
desc: "Restore a file share within a valid retention days if share soft delete is enabled."
- uid: "com.azure.resourcemanager.storage.fluent.FileSharesClient.restoreAsync(java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.storage.models.DeletedShare)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.restoreAsync(String resourceGroupName, String accountName, String shareName, DeletedShare deletedShare)"
name: "restoreAsync(String resourceGroupName, String accountName, String shareName, DeletedShare deletedShare)"
nameWithType: "FileSharesClient.restoreAsync(String resourceGroupName, String accountName, String shareName, DeletedShare deletedShare)"
summary: "Restore a file share within a valid retention days if share soft delete is enabled."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file share within the specified storage account. File share names must be\n between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-)\n character must be immediately preceded and followed by a letter or number."
name: "shareName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The deletedShare parameter."
name: "deletedShare"
type: "<xref href=\"com.azure.resourcemanager.storage.models.DeletedShare?alt=com.azure.resourcemanager.storage.models.DeletedShare&text=DeletedShare\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Mono<Void> restoreAsync(String resourceGroupName, String accountName, String shareName, DeletedShare deletedShare)"
desc: "Restore a file share within a valid retention days if share soft delete is enabled."
returns:
description: "A <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref> that completes when a successful response is received."
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.resourcemanager.storage.fluent.FileSharesClient.restoreWithResponse(java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.storage.models.DeletedShare,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.restoreWithResponse(String resourceGroupName, String accountName, String shareName, DeletedShare deletedShare, Context context)"
name: "restoreWithResponse(String resourceGroupName, String accountName, String shareName, DeletedShare deletedShare, Context context)"
nameWithType: "FileSharesClient.restoreWithResponse(String resourceGroupName, String accountName, String shareName, DeletedShare deletedShare, Context context)"
summary: "Restore a file share within a valid retention days if share soft delete is enabled."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file share within the specified storage account. File share names must be\n between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-)\n character must be immediately preceded and followed by a letter or number."
name: "shareName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The deletedShare parameter."
name: "deletedShare"
type: "<xref href=\"com.azure.resourcemanager.storage.models.DeletedShare?alt=com.azure.resourcemanager.storage.models.DeletedShare&text=DeletedShare\" data-throw-if-not-resolved=\"False\" />"
- description: "The context to associate with this operation."
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 abstract Response<Void> restoreWithResponse(String resourceGroupName, String accountName, String shareName, DeletedShare deletedShare, Context context)"
desc: "Restore a file share within a valid retention days if share soft delete is enabled."
returns:
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
type: "<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;"
- uid: "com.azure.resourcemanager.storage.fluent.FileSharesClient.restoreWithResponseAsync(java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.storage.models.DeletedShare)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.restoreWithResponseAsync(String resourceGroupName, String accountName, String shareName, DeletedShare deletedShare)"
name: "restoreWithResponseAsync(String resourceGroupName, String accountName, String shareName, DeletedShare deletedShare)"
nameWithType: "FileSharesClient.restoreWithResponseAsync(String resourceGroupName, String accountName, String shareName, DeletedShare deletedShare)"
summary: "Restore a file share within a valid retention days if share soft delete is enabled."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file share within the specified storage account. File share names must be\n between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-)\n character must be immediately preceded and followed by a letter or number."
name: "shareName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The deletedShare parameter."
name: "deletedShare"
type: "<xref href=\"com.azure.resourcemanager.storage.models.DeletedShare?alt=com.azure.resourcemanager.storage.models.DeletedShare&text=DeletedShare\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Mono<Response<Void>> restoreWithResponseAsync(String resourceGroupName, String accountName, String shareName, DeletedShare deletedShare)"
desc: "Restore a file share within a valid retention days if share soft delete is enabled."
returns:
description: "the <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
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.resourcemanager.storage.fluent.FileSharesClient.update(java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.storage.fluent.models.FileShareInner)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.update(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare)"
name: "update(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare)"
nameWithType: "FileSharesClient.update(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare)"
summary: "Updates share properties as specified in request body."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file share within the specified storage account. File share names must be\n between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-)\n character must be immediately preceded and followed by a letter or number."
name: "shareName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Properties to update for the file share."
name: "fileShare"
type: "<xref href=\"com.azure.resourcemanager.storage.fluent.models.FileShareInner?alt=com.azure.resourcemanager.storage.fluent.models.FileShareInner&text=FileShareInner\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract FileShareInner update(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare)"
desc: "Updates share properties as specified in request body. Properties not mentioned in the request will not be changed. Update fails if the specified share does not already exist."
returns:
description: "properties of the file share, including Id, resource name, resource type, Etag."
type: "<xref href=\"com.azure.resourcemanager.storage.fluent.models.FileShareInner?alt=com.azure.resourcemanager.storage.fluent.models.FileShareInner&text=FileShareInner\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.storage.fluent.FileSharesClient.updateAsync(java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.storage.fluent.models.FileShareInner)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.updateAsync(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare)"
name: "updateAsync(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare)"
nameWithType: "FileSharesClient.updateAsync(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare)"
summary: "Updates share properties as specified in request body."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file share within the specified storage account. File share names must be\n between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-)\n character must be immediately preceded and followed by a letter or number."
name: "shareName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Properties to update for the file share."
name: "fileShare"
type: "<xref href=\"com.azure.resourcemanager.storage.fluent.models.FileShareInner?alt=com.azure.resourcemanager.storage.fluent.models.FileShareInner&text=FileShareInner\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Mono<FileShareInner> updateAsync(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare)"
desc: "Updates share properties as specified in request body. Properties not mentioned in the request will not be changed. Update fails if the specified share does not already exist."
returns:
description: "properties of the file share, including Id, resource name, resource type, Etag on successful completion\n of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
type: "<a href=\"https://projectreactor.io/docs/core/release/api/reactor/core/publisher/Mono.html\">Mono</a>&lt;<xref href=\"com.azure.resourcemanager.storage.fluent.models.FileShareInner?alt=com.azure.resourcemanager.storage.fluent.models.FileShareInner&text=FileShareInner\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.storage.fluent.FileSharesClient.updateWithResponse(java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.storage.fluent.models.FileShareInner,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.updateWithResponse(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare, Context context)"
name: "updateWithResponse(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare, Context context)"
nameWithType: "FileSharesClient.updateWithResponse(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare, Context context)"
summary: "Updates share properties as specified in request body."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file share within the specified storage account. File share names must be\n between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-)\n character must be immediately preceded and followed by a letter or number."
name: "shareName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Properties to update for the file share."
name: "fileShare"
type: "<xref href=\"com.azure.resourcemanager.storage.fluent.models.FileShareInner?alt=com.azure.resourcemanager.storage.fluent.models.FileShareInner&text=FileShareInner\" data-throw-if-not-resolved=\"False\" />"
- description: "The context to associate with this operation."
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 abstract Response<FileShareInner> updateWithResponse(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare, Context context)"
desc: "Updates share properties as specified in request body. Properties not mentioned in the request will not be changed. Update fails if the specified share does not already exist."
returns:
description: "properties of the file share, including Id, resource name, resource type, Etag along with\n <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref>."
type: "<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.resourcemanager.storage.fluent.models.FileShareInner?alt=com.azure.resourcemanager.storage.fluent.models.FileShareInner&text=FileShareInner\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.storage.fluent.FileSharesClient.updateWithResponseAsync(java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.storage.fluent.models.FileShareInner)"
fullName: "com.azure.resourcemanager.storage.fluent.FileSharesClient.updateWithResponseAsync(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare)"
name: "updateWithResponseAsync(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare)"
nameWithType: "FileSharesClient.updateWithResponseAsync(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare)"
summary: "Updates share properties as specified in request body."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group within the user's subscription. The name is case\n insensitive."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the storage account within the specified resource group. Storage account names\n must be between 3 and 24 characters in length and use numbers and lower-case letters only."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the file share within the specified storage account. File share names must be\n between 3 and 63 characters in length and use numbers, lower-case letters and dash (-) only. Every dash (-)\n character must be immediately preceded and followed by a letter or number."
name: "shareName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Properties to update for the file share."
name: "fileShare"
type: "<xref href=\"com.azure.resourcemanager.storage.fluent.models.FileShareInner?alt=com.azure.resourcemanager.storage.fluent.models.FileShareInner&text=FileShareInner\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract Mono<Response<FileShareInner>> updateWithResponseAsync(String resourceGroupName, String accountName, String shareName, FileShareInner fileShare)"
desc: "Updates share properties as specified in request body. Properties not mentioned in the request will not be changed. Update fails if the specified share does not already exist."
returns:
description: "properties of the file share, including Id, resource name, resource type, Etag along with\n <xref uid=\"com.azure.core.http.rest.Response\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Response\"></xref> on successful completion of <xref uid=\"reactor.core.publisher.Mono\" data-throw-if-not-resolved=\"false\" data-raw-source=\"Mono\"></xref>."
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.resourcemanager.storage.fluent.models.FileShareInner?alt=com.azure.resourcemanager.storage.fluent.models.FileShareInner&text=FileShareInner\" data-throw-if-not-resolved=\"False\" />&gt;&gt;"
type: "interface"
desc: "An instance of this class provides access to all the operations defined in FileSharesClient."
metadata: {}
package: "com.azure.resourcemanager.storage.fluent"
artifact: com.azure.resourcemanager:azure-resourcemanager-storage:2.42.0