253 строки
19 KiB
YAML
253 строки
19 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.elasticsan.models.Volumes"
|
|
fullName: "com.azure.resourcemanager.elasticsan.models.Volumes"
|
|
name: "Volumes"
|
|
nameWithType: "Volumes"
|
|
summary: "Resource collection API of Volumes."
|
|
syntax: "public interface **Volumes**"
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.elasticsan.models.Volumes.define(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.elasticsan.models.Volumes.define(String name)"
|
|
name: "define(String name)"
|
|
nameWithType: "Volumes.define(String name)"
|
|
summary: "Begins definition for a new Volume resource."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "resource name."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract Volume.DefinitionStages.Blank define(String name)"
|
|
desc: "Begins definition for a new Volume resource."
|
|
returns:
|
|
description: "the first stage of the new Volume definition."
|
|
type: "<xref href=\"com.azure.resourcemanager.elasticsan.models.Volume.DefinitionStages.Blank?alt=com.azure.resourcemanager.elasticsan.models.Volume.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.elasticsan.models.Volumes.delete(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.elasticsan.models.Volumes.delete(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName)"
|
|
name: "delete(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName)"
|
|
nameWithType: "Volumes.delete(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName)"
|
|
summary: "Delete an Volume."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group. The name is case 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 ElasticSan."
|
|
name: "elasticSanName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the VolumeGroup."
|
|
name: "volumeGroupName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the Volume."
|
|
name: "volumeName"
|
|
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 elasticSanName, String volumeGroupName, String volumeName)"
|
|
desc: "Delete an Volume."
|
|
- uid: "com.azure.resourcemanager.elasticsan.models.Volumes.delete(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.elasticsan.models.XMsDeleteSnapshots,com.azure.resourcemanager.elasticsan.models.XMsForceDelete,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.elasticsan.models.Volumes.delete(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName, XMsDeleteSnapshots xMsDeleteSnapshots, XMsForceDelete xMsForceDelete, Context context)"
|
|
name: "delete(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName, XMsDeleteSnapshots xMsDeleteSnapshots, XMsForceDelete xMsForceDelete, Context context)"
|
|
nameWithType: "Volumes.delete(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName, XMsDeleteSnapshots xMsDeleteSnapshots, XMsForceDelete xMsForceDelete, Context context)"
|
|
summary: "Delete an Volume."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group. The name is case 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 ElasticSan."
|
|
name: "elasticSanName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the VolumeGroup."
|
|
name: "volumeGroupName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the Volume."
|
|
name: "volumeName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Optional, used to delete snapshots under volume. Allowed value are only true or false.\n Default value is false."
|
|
name: "xMsDeleteSnapshots"
|
|
type: "<xref href=\"com.azure.resourcemanager.elasticsan.models.XMsDeleteSnapshots?alt=com.azure.resourcemanager.elasticsan.models.XMsDeleteSnapshots&text=XMsDeleteSnapshots\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Optional, used to delete volume if active sessions present. Allowed value are only true or\n false. Default value is false."
|
|
name: "xMsForceDelete"
|
|
type: "<xref href=\"com.azure.resourcemanager.elasticsan.models.XMsForceDelete?alt=com.azure.resourcemanager.elasticsan.models.XMsForceDelete&text=XMsForceDelete\" 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 void delete(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName, XMsDeleteSnapshots xMsDeleteSnapshots, XMsForceDelete xMsForceDelete, Context context)"
|
|
desc: "Delete an Volume."
|
|
- uid: "com.azure.resourcemanager.elasticsan.models.Volumes.deleteById(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.elasticsan.models.Volumes.deleteById(String id)"
|
|
name: "deleteById(String id)"
|
|
nameWithType: "Volumes.deleteById(String id)"
|
|
summary: "Delete an Volume."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the resource ID."
|
|
name: "id"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract void deleteById(String id)"
|
|
desc: "Delete an Volume."
|
|
- uid: "com.azure.resourcemanager.elasticsan.models.Volumes.deleteByIdWithResponse(java.lang.String,com.azure.resourcemanager.elasticsan.models.XMsDeleteSnapshots,com.azure.resourcemanager.elasticsan.models.XMsForceDelete,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.elasticsan.models.Volumes.deleteByIdWithResponse(String id, XMsDeleteSnapshots xMsDeleteSnapshots, XMsForceDelete xMsForceDelete, Context context)"
|
|
name: "deleteByIdWithResponse(String id, XMsDeleteSnapshots xMsDeleteSnapshots, XMsForceDelete xMsForceDelete, Context context)"
|
|
nameWithType: "Volumes.deleteByIdWithResponse(String id, XMsDeleteSnapshots xMsDeleteSnapshots, XMsForceDelete xMsForceDelete, Context context)"
|
|
summary: "Delete an Volume."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the resource ID."
|
|
name: "id"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Optional, used to delete snapshots under volume. Allowed value are only true or false.\n Default value is false."
|
|
name: "xMsDeleteSnapshots"
|
|
type: "<xref href=\"com.azure.resourcemanager.elasticsan.models.XMsDeleteSnapshots?alt=com.azure.resourcemanager.elasticsan.models.XMsDeleteSnapshots&text=XMsDeleteSnapshots\" data-throw-if-not-resolved=\"False\" />"
|
|
- description: "Optional, used to delete volume if active sessions present. Allowed value are only true or\n false. Default value is false."
|
|
name: "xMsForceDelete"
|
|
type: "<xref href=\"com.azure.resourcemanager.elasticsan.models.XMsForceDelete?alt=com.azure.resourcemanager.elasticsan.models.XMsForceDelete&text=XMsForceDelete\" 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 void deleteByIdWithResponse(String id, XMsDeleteSnapshots xMsDeleteSnapshots, XMsForceDelete xMsForceDelete, Context context)"
|
|
desc: "Delete an Volume."
|
|
- uid: "com.azure.resourcemanager.elasticsan.models.Volumes.get(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.elasticsan.models.Volumes.get(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName)"
|
|
name: "get(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName)"
|
|
nameWithType: "Volumes.get(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName)"
|
|
summary: "Get an Volume."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group. The name is case 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 ElasticSan."
|
|
name: "elasticSanName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the VolumeGroup."
|
|
name: "volumeGroupName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the Volume."
|
|
name: "volumeName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract Volume get(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName)"
|
|
desc: "Get an Volume."
|
|
returns:
|
|
description: "an Volume."
|
|
type: "<xref href=\"com.azure.resourcemanager.elasticsan.models.Volume?alt=com.azure.resourcemanager.elasticsan.models.Volume&text=Volume\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.elasticsan.models.Volumes.getById(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.elasticsan.models.Volumes.getById(String id)"
|
|
name: "getById(String id)"
|
|
nameWithType: "Volumes.getById(String id)"
|
|
summary: "Get an Volume."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the resource ID."
|
|
name: "id"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract Volume getById(String id)"
|
|
desc: "Get an Volume."
|
|
returns:
|
|
description: "an Volume 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.resourcemanager.elasticsan.models.Volume?alt=com.azure.resourcemanager.elasticsan.models.Volume&text=Volume\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.elasticsan.models.Volumes.getByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.elasticsan.models.Volumes.getByIdWithResponse(String id, Context context)"
|
|
name: "getByIdWithResponse(String id, Context context)"
|
|
nameWithType: "Volumes.getByIdWithResponse(String id, Context context)"
|
|
summary: "Get an Volume."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "the resource ID."
|
|
name: "id"
|
|
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<Volume> getByIdWithResponse(String id, Context context)"
|
|
desc: "Get an Volume."
|
|
returns:
|
|
description: "an Volume 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\" /><<xref href=\"com.azure.resourcemanager.elasticsan.models.Volume?alt=com.azure.resourcemanager.elasticsan.models.Volume&text=Volume\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.elasticsan.models.Volumes.getWithResponse(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.elasticsan.models.Volumes.getWithResponse(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName, Context context)"
|
|
name: "getWithResponse(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName, Context context)"
|
|
nameWithType: "Volumes.getWithResponse(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName, Context context)"
|
|
summary: "Get an Volume."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group. The name is case 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 ElasticSan."
|
|
name: "elasticSanName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the VolumeGroup."
|
|
name: "volumeGroupName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the Volume."
|
|
name: "volumeName"
|
|
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<Volume> getWithResponse(String resourceGroupName, String elasticSanName, String volumeGroupName, String volumeName, Context context)"
|
|
desc: "Get an Volume."
|
|
returns:
|
|
description: "an Volume 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\" /><<xref href=\"com.azure.resourcemanager.elasticsan.models.Volume?alt=com.azure.resourcemanager.elasticsan.models.Volume&text=Volume\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.elasticsan.models.Volumes.listByVolumeGroup(java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.elasticsan.models.Volumes.listByVolumeGroup(String resourceGroupName, String elasticSanName, String volumeGroupName)"
|
|
name: "listByVolumeGroup(String resourceGroupName, String elasticSanName, String volumeGroupName)"
|
|
nameWithType: "Volumes.listByVolumeGroup(String resourceGroupName, String elasticSanName, String volumeGroupName)"
|
|
summary: "List Volumes in a Volume<wbr>Group."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group. The name is case 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 ElasticSan."
|
|
name: "elasticSanName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the VolumeGroup."
|
|
name: "volumeGroupName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract PagedIterable<Volume> listByVolumeGroup(String resourceGroupName, String elasticSanName, String volumeGroupName)"
|
|
desc: "List Volumes in a VolumeGroup."
|
|
returns:
|
|
description: "list of Volumes 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\" /><<xref href=\"com.azure.resourcemanager.elasticsan.models.Volume?alt=com.azure.resourcemanager.elasticsan.models.Volume&text=Volume\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.elasticsan.models.Volumes.listByVolumeGroup(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.elasticsan.models.Volumes.listByVolumeGroup(String resourceGroupName, String elasticSanName, String volumeGroupName, Context context)"
|
|
name: "listByVolumeGroup(String resourceGroupName, String elasticSanName, String volumeGroupName, Context context)"
|
|
nameWithType: "Volumes.listByVolumeGroup(String resourceGroupName, String elasticSanName, String volumeGroupName, Context context)"
|
|
summary: "List Volumes in a Volume<wbr>Group."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group. The name is case 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 ElasticSan."
|
|
name: "elasticSanName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the VolumeGroup."
|
|
name: "volumeGroupName"
|
|
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<Volume> listByVolumeGroup(String resourceGroupName, String elasticSanName, String volumeGroupName, Context context)"
|
|
desc: "List Volumes in a VolumeGroup."
|
|
returns:
|
|
description: "list of Volumes 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\" /><<xref href=\"com.azure.resourcemanager.elasticsan.models.Volume?alt=com.azure.resourcemanager.elasticsan.models.Volume&text=Volume\" data-throw-if-not-resolved=\"False\" />>"
|
|
type: "interface"
|
|
desc: "Resource collection API of Volumes."
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.elasticsan.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-elasticsan:1.1.0
|