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

317 строки
23 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.sphere.models.Products"
fullName: "com.azure.resourcemanager.sphere.models.Products"
name: "Products"
nameWithType: "Products"
summary: "Resource collection API of Products."
syntax: "public interface **Products**"
methods:
- uid: "com.azure.resourcemanager.sphere.models.Products.countDevices(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.sphere.models.Products.countDevices(String resourceGroupName, String catalogName, String productName)"
name: "countDevices(String resourceGroupName, String catalogName, String productName)"
nameWithType: "Products.countDevices(String resourceGroupName, String catalogName, String productName)"
summary: "Counts devices in product."
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>"
syntax: "public abstract CountDevicesResponse countDevices(String resourceGroupName, String catalogName, String productName)"
desc: "Counts devices in product. '.default' and '.unassigned' are system defined values and cannot be used for product name."
returns:
description: "response to the action call for count devices in a catalog."
type: "<xref href=\"com.azure.resourcemanager.sphere.models.CountDevicesResponse?alt=com.azure.resourcemanager.sphere.models.CountDevicesResponse&text=CountDevicesResponse\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sphere.models.Products.countDevicesWithResponse(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.sphere.models.Products.countDevicesWithResponse(String resourceGroupName, String catalogName, String productName, Context context)"
name: "countDevicesWithResponse(String resourceGroupName, String catalogName, String productName, Context context)"
nameWithType: "Products.countDevicesWithResponse(String resourceGroupName, String catalogName, String productName, Context context)"
summary: "Counts devices in product."
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: "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<CountDevicesResponse> countDevicesWithResponse(String resourceGroupName, String catalogName, String productName, Context context)"
desc: "Counts devices in product. '.default' and '.unassigned' are system defined values and cannot be used for product name."
returns:
description: "response to the action call for count devices in a catalog 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.CountDevicesResponse?alt=com.azure.resourcemanager.sphere.models.CountDevicesResponse&text=CountDevicesResponse\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.sphere.models.Products.define(java.lang.String)"
fullName: "com.azure.resourcemanager.sphere.models.Products.define(String name)"
name: "define(String name)"
nameWithType: "Products.define(String name)"
summary: "Begins definition for a new Product 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 Product.DefinitionStages.Blank define(String name)"
desc: "Begins definition for a new Product resource."
returns:
description: "the first stage of the new Product definition."
type: "<xref href=\"com.azure.resourcemanager.sphere.models.Product.DefinitionStages.Blank?alt=com.azure.resourcemanager.sphere.models.Product.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sphere.models.Products.delete(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.sphere.models.Products.delete(String resourceGroupName, String catalogName, String productName)"
name: "delete(String resourceGroupName, String catalogName, String productName)"
nameWithType: "Products.delete(String resourceGroupName, String catalogName, String productName)"
summary: "Delete a Product."
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>"
syntax: "public abstract void delete(String resourceGroupName, String catalogName, String productName)"
desc: "Delete a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name'."
- uid: "com.azure.resourcemanager.sphere.models.Products.delete(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.sphere.models.Products.delete(String resourceGroupName, String catalogName, String productName, Context context)"
name: "delete(String resourceGroupName, String catalogName, String productName, Context context)"
nameWithType: "Products.delete(String resourceGroupName, String catalogName, String productName, Context context)"
summary: "Delete a Product."
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: "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, Context context)"
desc: "Delete a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name'."
- uid: "com.azure.resourcemanager.sphere.models.Products.deleteById(java.lang.String)"
fullName: "com.azure.resourcemanager.sphere.models.Products.deleteById(String id)"
name: "deleteById(String id)"
nameWithType: "Products.deleteById(String id)"
summary: "Delete a Product."
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 Product. '.default' and '.unassigned' are system defined values and cannot be used for product name'."
- uid: "com.azure.resourcemanager.sphere.models.Products.deleteByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.sphere.models.Products.deleteByIdWithResponse(String id, Context context)"
name: "deleteByIdWithResponse(String id, Context context)"
nameWithType: "Products.deleteByIdWithResponse(String id, Context context)"
summary: "Delete a Product."
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 Product. '.default' and '.unassigned' are system defined values and cannot be used for product name'."
- uid: "com.azure.resourcemanager.sphere.models.Products.generateDefaultDeviceGroups(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.sphere.models.Products.generateDefaultDeviceGroups(String resourceGroupName, String catalogName, String productName)"
name: "generateDefaultDeviceGroups(String resourceGroupName, String catalogName, String productName)"
nameWithType: "Products.generateDefaultDeviceGroups(String resourceGroupName, String catalogName, String productName)"
summary: "Generates default device groups for the product."
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>"
syntax: "public abstract PagedIterable<DeviceGroup> generateDefaultDeviceGroups(String resourceGroupName, String catalogName, String productName)"
desc: "Generates default device groups for the product. '.default' and '.unassigned' are system defined values and cannot be used for product name."
returns:
description: "the response of a DeviceGroup 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.DeviceGroup?alt=com.azure.resourcemanager.sphere.models.DeviceGroup&text=DeviceGroup\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.sphere.models.Products.generateDefaultDeviceGroups(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.sphere.models.Products.generateDefaultDeviceGroups(String resourceGroupName, String catalogName, String productName, Context context)"
name: "generateDefaultDeviceGroups(String resourceGroupName, String catalogName, String productName, Context context)"
nameWithType: "Products.generateDefaultDeviceGroups(String resourceGroupName, String catalogName, String productName, Context context)"
summary: "Generates default device groups for the product."
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: "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<DeviceGroup> generateDefaultDeviceGroups(String resourceGroupName, String catalogName, String productName, Context context)"
desc: "Generates default device groups for the product. '.default' and '.unassigned' are system defined values and cannot be used for product name."
returns:
description: "the response of a DeviceGroup 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.DeviceGroup?alt=com.azure.resourcemanager.sphere.models.DeviceGroup&text=DeviceGroup\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.sphere.models.Products.get(java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.sphere.models.Products.get(String resourceGroupName, String catalogName, String productName)"
name: "get(String resourceGroupName, String catalogName, String productName)"
nameWithType: "Products.get(String resourceGroupName, String catalogName, String productName)"
summary: "Get a Product."
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>"
syntax: "public abstract Product get(String resourceGroupName, String catalogName, String productName)"
desc: "Get a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name."
returns:
description: "a Product."
type: "<xref href=\"com.azure.resourcemanager.sphere.models.Product?alt=com.azure.resourcemanager.sphere.models.Product&text=Product\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sphere.models.Products.getById(java.lang.String)"
fullName: "com.azure.resourcemanager.sphere.models.Products.getById(String id)"
name: "getById(String id)"
nameWithType: "Products.getById(String id)"
summary: "Get a Product."
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 Product getById(String id)"
desc: "Get a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name."
returns:
description: "a Product 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.Product?alt=com.azure.resourcemanager.sphere.models.Product&text=Product\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sphere.models.Products.getByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.sphere.models.Products.getByIdWithResponse(String id, Context context)"
name: "getByIdWithResponse(String id, Context context)"
nameWithType: "Products.getByIdWithResponse(String id, Context context)"
summary: "Get a Product."
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<Product> getByIdWithResponse(String id, Context context)"
desc: "Get a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name."
returns:
description: "a Product 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.Product?alt=com.azure.resourcemanager.sphere.models.Product&text=Product\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.sphere.models.Products.getWithResponse(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.sphere.models.Products.getWithResponse(String resourceGroupName, String catalogName, String productName, Context context)"
name: "getWithResponse(String resourceGroupName, String catalogName, String productName, Context context)"
nameWithType: "Products.getWithResponse(String resourceGroupName, String catalogName, String productName, Context context)"
summary: "Get a Product."
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: "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<Product> getWithResponse(String resourceGroupName, String catalogName, String productName, Context context)"
desc: "Get a Product. '.default' and '.unassigned' are system defined values and cannot be used for product name."
returns:
description: "a Product 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.Product?alt=com.azure.resourcemanager.sphere.models.Product&text=Product\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.sphere.models.Products.listByCatalog(java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.sphere.models.Products.listByCatalog(String resourceGroupName, String catalogName)"
name: "listByCatalog(String resourceGroupName, String catalogName)"
nameWithType: "Products.listByCatalog(String resourceGroupName, String catalogName)"
summary: "List Product resources by Catalog."
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>"
syntax: "public abstract PagedIterable<Product> listByCatalog(String resourceGroupName, String catalogName)"
desc: "List Product resources by Catalog."
returns:
description: "the response of a Product 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.Product?alt=com.azure.resourcemanager.sphere.models.Product&text=Product\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.sphere.models.Products.listByCatalog(java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.sphere.models.Products.listByCatalog(String resourceGroupName, String catalogName, Context context)"
name: "listByCatalog(String resourceGroupName, String catalogName, Context context)"
nameWithType: "Products.listByCatalog(String resourceGroupName, String catalogName, Context context)"
summary: "List Product resources by Catalog."
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: "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<Product> listByCatalog(String resourceGroupName, String catalogName, Context context)"
desc: "List Product resources by Catalog."
returns:
description: "the response of a Product 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.Product?alt=com.azure.resourcemanager.sphere.models.Product&text=Product\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "interface"
desc: "Resource collection API of Products."
metadata: {}
package: "com.azure.resourcemanager.sphere.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-sphere:1.0.0