azure-docs-sdk-java/docs-ref-autogen/com.azure.resourcemanager.sphere.models.Deployments.yml

### YamlMime:JavaType
uid: "com.azure.resourcemanager.sphere.models.Deployments"
fullName: "com.azure.resourcemanager.sphere.models.Deployments"
name: "Deployments"
nameWithType: "Deployments"
summary: "Resource collection API of Deployments."
syntax: "public interface **Deployments**"
methods:
- uid: "com.azure.resourcemanager.sphere.models.Deployments.define(java.lang.String)"
  fullName: "com.azure.resourcemanager.sphere.models.Deployments.define(String name)"
  name: "define(String name)"
  nameWithType: "Deployments.define(String name)"
  summary: "Begins definition for a new Deployment 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 Deployment.DefinitionStages.Blank define(String name)"
  desc: "Begins definition for a new Deployment resource."
  returns:
    description: "the first stage of the new Deployment definition."
    type: "<xref href=\"com.azure.resourcemanager.sphere.models.Deployment.DefinitionStages.Blank?alt=com.azure.resourcemanager.sphere.models.Deployment.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sphere.models.Deployments.delete(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
  fullName: "com.azure.resourcemanager.sphere.models.Deployments.delete(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deploymentName)"
  name: "delete(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deploymentName)"
  nameWithType: "Deployments.delete(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deploymentName)"
  summary: "Delete a Deployment."
  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: "Name of catalog."
    name: "catalogName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Name of product."
    name: "productName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Name of device group."
    name: "deviceGroupName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Deployment name. Use .default for deployment creation and to get the current deployment for\n the associated device group."
    name: "deploymentName"
    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 catalogName, String productName, String deviceGroupName, String deploymentName)"
  desc: "Delete a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name."
- uid: "com.azure.resourcemanager.sphere.models.Deployments.delete(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
  fullName: "com.azure.resourcemanager.sphere.models.Deployments.delete(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deploymentName, Context context)"
  name: "delete(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deploymentName, Context context)"
  nameWithType: "Deployments.delete(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deploymentName, Context context)"
  summary: "Delete a Deployment."
  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: "Name of catalog."
    name: "catalogName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Name of product."
    name: "productName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Name of device group."
    name: "deviceGroupName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Deployment name. Use .default for deployment creation and to get the current deployment for\n the associated device group."
    name: "deploymentName"
    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 catalogName, String productName, String deviceGroupName, String deploymentName, Context context)"
  desc: "Delete a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name."
- uid: "com.azure.resourcemanager.sphere.models.Deployments.deleteById(java.lang.String)"
  fullName: "com.azure.resourcemanager.sphere.models.Deployments.deleteById(String id)"
  name: "deleteById(String id)"
  nameWithType: "Deployments.deleteById(String id)"
  summary: "Delete a Deployment."
  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 a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name."
- uid: "com.azure.resourcemanager.sphere.models.Deployments.deleteByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
  fullName: "com.azure.resourcemanager.sphere.models.Deployments.deleteByIdWithResponse(String id, Context context)"
  name: "deleteByIdWithResponse(String id, Context context)"
  nameWithType: "Deployments.deleteByIdWithResponse(String id, Context context)"
  summary: "Delete a Deployment."
  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: "Delete a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name."
- uid: "com.azure.resourcemanager.sphere.models.Deployments.get(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
  fullName: "com.azure.resourcemanager.sphere.models.Deployments.get(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deploymentName)"
  name: "get(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deploymentName)"
  nameWithType: "Deployments.get(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deploymentName)"
  summary: "Get a Deployment."
  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: "Name of catalog."
    name: "catalogName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Name of product."
    name: "productName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Name of device group."
    name: "deviceGroupName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Deployment name. Use .default for deployment creation and to get the current deployment for\n the associated device group."
    name: "deploymentName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public abstract Deployment get(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deploymentName)"
  desc: "Get a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name."
  returns:
    description: "a Deployment."
    type: "<xref href=\"com.azure.resourcemanager.sphere.models.Deployment?alt=com.azure.resourcemanager.sphere.models.Deployment&text=Deployment\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sphere.models.Deployments.getById(java.lang.String)"
  fullName: "com.azure.resourcemanager.sphere.models.Deployments.getById(String id)"
  name: "getById(String id)"
  nameWithType: "Deployments.getById(String id)"
  summary: "Get a Deployment."
  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 Deployment getById(String id)"
  desc: "Get a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name."
  returns:
    description: "a Deployment 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.sphere.models.Deployment?alt=com.azure.resourcemanager.sphere.models.Deployment&text=Deployment\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sphere.models.Deployments.getByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
  fullName: "com.azure.resourcemanager.sphere.models.Deployments.getByIdWithResponse(String id, Context context)"
  name: "getByIdWithResponse(String id, Context context)"
  nameWithType: "Deployments.getByIdWithResponse(String id, Context context)"
  summary: "Get a Deployment."
  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<Deployment> getByIdWithResponse(String id, Context context)"
  desc: "Get a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name."
  returns:
    description: "a Deployment 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.sphere.models.Deployment?alt=com.azure.resourcemanager.sphere.models.Deployment&text=Deployment\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.sphere.models.Deployments.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.sphere.models.Deployments.getWithResponse(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deploymentName, Context context)"
  name: "getWithResponse(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deploymentName, Context context)"
  nameWithType: "Deployments.getWithResponse(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deploymentName, Context context)"
  summary: "Get a Deployment."
  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: "Name of catalog."
    name: "catalogName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Name of product."
    name: "productName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Name of device group."
    name: "deviceGroupName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Deployment name. Use .default for deployment creation and to get the current deployment for\n the associated device group."
    name: "deploymentName"
    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<Deployment> getWithResponse(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deploymentName, Context context)"
  desc: "Get a Deployment. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name."
  returns:
    description: "a Deployment 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.sphere.models.Deployment?alt=com.azure.resourcemanager.sphere.models.Deployment&text=Deployment\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.sphere.models.Deployments.listByDeviceGroup(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
  fullName: "com.azure.resourcemanager.sphere.models.Deployments.listByDeviceGroup(String resourceGroupName, String catalogName, String productName, String deviceGroupName)"
  name: "listByDeviceGroup(String resourceGroupName, String catalogName, String productName, String deviceGroupName)"
  nameWithType: "Deployments.listByDeviceGroup(String resourceGroupName, String catalogName, String productName, String deviceGroupName)"
  summary: "List Deployment resources by Device<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: "Name of catalog."
    name: "catalogName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Name of product."
    name: "productName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Name of device group."
    name: "deviceGroupName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  syntax: "public abstract PagedIterable<Deployment> listByDeviceGroup(String resourceGroupName, String catalogName, String productName, String deviceGroupName)"
  desc: "List Deployment resources by DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name."
  returns:
    description: "the response of a Deployment 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.sphere.models.Deployment?alt=com.azure.resourcemanager.sphere.models.Deployment&text=Deployment\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.sphere.models.Deployments.listByDeviceGroup(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.Integer,java.lang.Integer,java.lang.Integer,com.azure.core.util.Context)"
  fullName: "com.azure.resourcemanager.sphere.models.Deployments.listByDeviceGroup(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String filter, Integer top, Integer skip, Integer maxpagesize, Context context)"
  name: "listByDeviceGroup(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String filter, Integer top, Integer skip, Integer maxpagesize, Context context)"
  nameWithType: "Deployments.listByDeviceGroup(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String filter, Integer top, Integer skip, Integer maxpagesize, Context context)"
  summary: "List Deployment resources by Device<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: "Name of catalog."
    name: "catalogName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Name of product."
    name: "productName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Name of device group."
    name: "deviceGroupName"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "Filter the result list using the given expression."
    name: "filter"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
  - description: "The number of result items to return."
    name: "top"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
  - description: "The number of result items to skip."
    name: "skip"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
  - description: "The maximum number of result items per page."
    name: "maxpagesize"
    type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</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<Deployment> listByDeviceGroup(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String filter, Integer top, Integer skip, Integer maxpagesize, Context context)"
  desc: "List Deployment resources by DeviceGroup. '.default' and '.unassigned' are system defined values and cannot be used for product or device group name."
  returns:
    description: "the response of a Deployment 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.sphere.models.Deployment?alt=com.azure.resourcemanager.sphere.models.Deployment&text=Deployment\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "interface"
desc: "Resource collection API of Deployments."
metadata: {}
package: "com.azure.resourcemanager.sphere.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-sphere:1.0.0