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

326 строки
24 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.batch.models.Pools"
fullName: "com.azure.resourcemanager.batch.models.Pools"
name: "Pools"
nameWithType: "Pools"
summary: "Resource collection API of Pools."
syntax: "public interface **Pools**"
methods:
- uid: "com.azure.resourcemanager.batch.models.Pools.define(java.lang.String)"
fullName: "com.azure.resourcemanager.batch.models.Pools.define(String name)"
name: "define(String name)"
nameWithType: "Pools.define(String name)"
summary: "Begins definition for a new Pool 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 Pool.DefinitionStages.Blank define(String name)"
desc: "Begins definition for a new Pool resource."
returns:
description: "the first stage of the new Pool definition."
type: "<xref href=\"com.azure.resourcemanager.batch.models.Pool.DefinitionStages.Blank?alt=com.azure.resourcemanager.batch.models.Pool.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.Pools.delete(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.batch.models.Pools.delete(String resourceGroupName, String accountName, String poolName)"
name: "delete(String resourceGroupName, String accountName, String poolName)"
nameWithType: "Pools.delete(String resourceGroupName, String accountName, String poolName)"
summary: "Deletes the specified pool."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the Batch account."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the Batch account."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The pool name. This must be unique within the account."
name: "poolName"
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 poolName)"
desc: "Deletes the specified pool."
- uid: "com.azure.resourcemanager.batch.models.Pools.delete(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.batch.models.Pools.delete(String resourceGroupName, String accountName, String poolName, Context context)"
name: "delete(String resourceGroupName, String accountName, String poolName, Context context)"
nameWithType: "Pools.delete(String resourceGroupName, String accountName, String poolName, Context context)"
summary: "Deletes the specified pool."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the Batch account."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the Batch account."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The pool name. This must be unique within the account."
name: "poolName"
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 void delete(String resourceGroupName, String accountName, String poolName, Context context)"
desc: "Deletes the specified pool."
- uid: "com.azure.resourcemanager.batch.models.Pools.deleteById(java.lang.String)"
fullName: "com.azure.resourcemanager.batch.models.Pools.deleteById(String id)"
name: "deleteById(String id)"
nameWithType: "Pools.deleteById(String id)"
summary: "Deletes the specified pool."
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: "Deletes the specified pool."
- uid: "com.azure.resourcemanager.batch.models.Pools.deleteByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.batch.models.Pools.deleteByIdWithResponse(String id, Context context)"
name: "deleteByIdWithResponse(String id, Context context)"
nameWithType: "Pools.deleteByIdWithResponse(String id, Context context)"
summary: "Deletes the specified pool."
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 void deleteByIdWithResponse(String id, Context context)"
desc: "Deletes the specified pool."
- uid: "com.azure.resourcemanager.batch.models.Pools.disableAutoScale(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.batch.models.Pools.disableAutoScale(String resourceGroupName, String accountName, String poolName)"
name: "disableAutoScale(String resourceGroupName, String accountName, String poolName)"
nameWithType: "Pools.disableAutoScale(String resourceGroupName, String accountName, String poolName)"
summary: "Disables automatic scaling for a pool."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the Batch account."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the Batch account."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The pool name. This must be unique within the account."
name: "poolName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Pool disableAutoScale(String resourceGroupName, String accountName, String poolName)"
desc: "Disables automatic scaling for a pool."
returns:
description: "contains information about a pool."
type: "<xref href=\"com.azure.resourcemanager.batch.models.Pool?alt=com.azure.resourcemanager.batch.models.Pool&text=Pool\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.Pools.disableAutoScaleWithResponse(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.batch.models.Pools.disableAutoScaleWithResponse(String resourceGroupName, String accountName, String poolName, Context context)"
name: "disableAutoScaleWithResponse(String resourceGroupName, String accountName, String poolName, Context context)"
nameWithType: "Pools.disableAutoScaleWithResponse(String resourceGroupName, String accountName, String poolName, Context context)"
summary: "Disables automatic scaling for a pool."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the Batch account."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the Batch account."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The pool name. This must be unique within the account."
name: "poolName"
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<Pool> disableAutoScaleWithResponse(String resourceGroupName, String accountName, String poolName, Context context)"
desc: "Disables automatic scaling for a pool."
returns:
description: "contains information about a pool."
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.batch.models.Pool?alt=com.azure.resourcemanager.batch.models.Pool&text=Pool\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.batch.models.Pools.get(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.batch.models.Pools.get(String resourceGroupName, String accountName, String poolName)"
name: "get(String resourceGroupName, String accountName, String poolName)"
nameWithType: "Pools.get(String resourceGroupName, String accountName, String poolName)"
summary: "Gets information about the specified pool."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the Batch account."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the Batch account."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The pool name. This must be unique within the account."
name: "poolName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Pool get(String resourceGroupName, String accountName, String poolName)"
desc: "Gets information about the specified pool."
returns:
description: "information about the specified pool."
type: "<xref href=\"com.azure.resourcemanager.batch.models.Pool?alt=com.azure.resourcemanager.batch.models.Pool&text=Pool\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.Pools.getById(java.lang.String)"
fullName: "com.azure.resourcemanager.batch.models.Pools.getById(String id)"
name: "getById(String id)"
nameWithType: "Pools.getById(String id)"
summary: "Gets information about the specified pool."
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 Pool getById(String id)"
desc: "Gets information about the specified pool."
returns:
description: "information about the specified pool."
type: "<xref href=\"com.azure.resourcemanager.batch.models.Pool?alt=com.azure.resourcemanager.batch.models.Pool&text=Pool\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.Pools.getByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.batch.models.Pools.getByIdWithResponse(String id, Context context)"
name: "getByIdWithResponse(String id, Context context)"
nameWithType: "Pools.getByIdWithResponse(String id, Context context)"
summary: "Gets information about the specified pool."
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<Pool> getByIdWithResponse(String id, Context context)"
desc: "Gets information about the specified pool."
returns:
description: "information about the specified pool."
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.batch.models.Pool?alt=com.azure.resourcemanager.batch.models.Pool&text=Pool\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.batch.models.Pools.getWithResponse(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.batch.models.Pools.getWithResponse(String resourceGroupName, String accountName, String poolName, Context context)"
name: "getWithResponse(String resourceGroupName, String accountName, String poolName, Context context)"
nameWithType: "Pools.getWithResponse(String resourceGroupName, String accountName, String poolName, Context context)"
summary: "Gets information about the specified pool."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the Batch account."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the Batch account."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The pool name. This must be unique within the account."
name: "poolName"
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<Pool> getWithResponse(String resourceGroupName, String accountName, String poolName, Context context)"
desc: "Gets information about the specified pool."
returns:
description: "information about the specified pool."
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.batch.models.Pool?alt=com.azure.resourcemanager.batch.models.Pool&text=Pool\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.batch.models.Pools.listByBatchAccount(java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.batch.models.Pools.listByBatchAccount(String resourceGroupName, String accountName)"
name: "listByBatchAccount(String resourceGroupName, String accountName)"
nameWithType: "Pools.listByBatchAccount(String resourceGroupName, String accountName)"
summary: "Lists all of the pools in the specified account."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the Batch account."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the Batch account."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract PagedIterable<Pool> listByBatchAccount(String resourceGroupName, String accountName)"
desc: "Lists all of the pools in the specified account."
returns:
description: "values returned by the List operation 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.batch.models.Pool?alt=com.azure.resourcemanager.batch.models.Pool&text=Pool\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.batch.models.Pools.listByBatchAccount(java.lang.String,java.lang.String,java.lang.Integer,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.batch.models.Pools.listByBatchAccount(String resourceGroupName, String accountName, Integer maxresults, String select, String filter, Context context)"
name: "listByBatchAccount(String resourceGroupName, String accountName, Integer maxresults, String select, String filter, Context context)"
nameWithType: "Pools.listByBatchAccount(String resourceGroupName, String accountName, Integer maxresults, String select, String filter, Context context)"
summary: "Lists all of the pools in the specified account."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the Batch account."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the Batch account."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The maximum number of items to return in the response."
name: "maxresults"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
- description: "Comma separated list of properties that should be returned. e.g. \"properties/provisioningState\".\n Only top level properties under properties/ are valid for selection."
name: "select"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "OData filter expression. Valid properties for filtering are:\n <p>name properties/allocationState properties/allocationStateTransitionTime properties/creationTime\n properties/provisioningState properties/provisioningStateTransitionTime properties/lastModified\n properties/vmSize properties/interNodeCommunication properties/scaleSettings/autoScale\n properties/scaleSettings/fixedScale."
name: "filter"
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<Pool> listByBatchAccount(String resourceGroupName, String accountName, Integer maxresults, String select, String filter, Context context)"
desc: "Lists all of the pools in the specified account."
returns:
description: "values returned by the List operation 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.batch.models.Pool?alt=com.azure.resourcemanager.batch.models.Pool&text=Pool\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.batch.models.Pools.stopResize(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.batch.models.Pools.stopResize(String resourceGroupName, String accountName, String poolName)"
name: "stopResize(String resourceGroupName, String accountName, String poolName)"
nameWithType: "Pools.stopResize(String resourceGroupName, String accountName, String poolName)"
summary: "This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the Batch account."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the Batch account."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The pool name. This must be unique within the account."
name: "poolName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Pool stopResize(String resourceGroupName, String accountName, String poolName)"
desc: "This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created."
returns:
description: "contains information about a pool."
type: "<xref href=\"com.azure.resourcemanager.batch.models.Pool?alt=com.azure.resourcemanager.batch.models.Pool&text=Pool\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.batch.models.Pools.stopResizeWithResponse(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.batch.models.Pools.stopResizeWithResponse(String resourceGroupName, String accountName, String poolName, Context context)"
name: "stopResizeWithResponse(String resourceGroupName, String accountName, String poolName, Context context)"
nameWithType: "Pools.stopResizeWithResponse(String resourceGroupName, String accountName, String poolName, Context context)"
summary: "This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the Batch account."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the Batch account."
name: "accountName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The pool name. This must be unique within the account."
name: "poolName"
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<Pool> stopResizeWithResponse(String resourceGroupName, String accountName, String poolName, Context context)"
desc: "This does not restore the pool to its previous state before the resize operation: it only stops any further changes being made, and the pool maintains its current state. After stopping, the pool stabilizes at the number of nodes it was at when the stop operation was done. During the stop operation, the pool allocation state changes first to stopping and then to steady. A resize operation need not be an explicit resize pool request; this API can also be used to halt the initial sizing of the pool when it is created."
returns:
description: "contains information about a pool."
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.batch.models.Pool?alt=com.azure.resourcemanager.batch.models.Pool&text=Pool\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "interface"
desc: "Resource collection API of Pools."
metadata: {}
package: "com.azure.resourcemanager.batch.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-batch:1.0.0