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

324 строки
24 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.sphere.models.Devices"
fullName: "com.azure.resourcemanager.sphere.models.Devices"
name: "Devices"
nameWithType: "Devices"
summary: "Resource collection API of Devices."
syntax: "public interface **Devices**"
methods:
- uid: "com.azure.resourcemanager.sphere.models.Devices.define(java.lang.String)"
fullName: "com.azure.resourcemanager.sphere.models.Devices.define(String name)"
name: "define(String name)"
nameWithType: "Devices.define(String name)"
summary: "Begins definition for a new Device 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 Device.DefinitionStages.Blank define(String name)"
desc: "Begins definition for a new Device resource."
returns:
description: "the first stage of the new Device definition."
type: "<xref href=\"com.azure.resourcemanager.sphere.models.Device.DefinitionStages.Blank?alt=com.azure.resourcemanager.sphere.models.Device.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sphere.models.Devices.delete(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.sphere.models.Devices.delete(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deviceName)"
name: "delete(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deviceName)"
nameWithType: "Devices.delete(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deviceName)"
summary: "Delete a Device."
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: "Device name."
name: "deviceName"
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 deviceName)"
desc: "Delete a Device."
- uid: "com.azure.resourcemanager.sphere.models.Devices.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.Devices.delete(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deviceName, Context context)"
name: "delete(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deviceName, Context context)"
nameWithType: "Devices.delete(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deviceName, Context context)"
summary: "Delete a Device."
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: "Device name."
name: "deviceName"
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 deviceName, Context context)"
desc: "Delete a Device."
- uid: "com.azure.resourcemanager.sphere.models.Devices.deleteById(java.lang.String)"
fullName: "com.azure.resourcemanager.sphere.models.Devices.deleteById(String id)"
name: "deleteById(String id)"
nameWithType: "Devices.deleteById(String id)"
summary: "Delete a Device."
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 Device."
- uid: "com.azure.resourcemanager.sphere.models.Devices.deleteByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.sphere.models.Devices.deleteByIdWithResponse(String id, Context context)"
name: "deleteByIdWithResponse(String id, Context context)"
nameWithType: "Devices.deleteByIdWithResponse(String id, Context context)"
summary: "Delete a Device."
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 Device."
- uid: "com.azure.resourcemanager.sphere.models.Devices.generateCapabilityImage(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.sphere.models.GenerateCapabilityImageRequest)"
fullName: "com.azure.resourcemanager.sphere.models.Devices.generateCapabilityImage(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deviceName, GenerateCapabilityImageRequest generateDeviceCapabilityRequest)"
name: "generateCapabilityImage(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deviceName, GenerateCapabilityImageRequest generateDeviceCapabilityRequest)"
nameWithType: "Devices.generateCapabilityImage(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deviceName, GenerateCapabilityImageRequest generateDeviceCapabilityRequest)"
summary: "Generates the capability image for the device."
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: "Device name."
name: "deviceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Generate capability image request body."
name: "generateDeviceCapabilityRequest"
type: "<xref href=\"com.azure.resourcemanager.sphere.models.GenerateCapabilityImageRequest?alt=com.azure.resourcemanager.sphere.models.GenerateCapabilityImageRequest&text=GenerateCapabilityImageRequest\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract SignedCapabilityImageResponse generateCapabilityImage(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deviceName, GenerateCapabilityImageRequest generateDeviceCapabilityRequest)"
desc: "Generates the capability image for the device. Use '.unassigned' or '.default' for the device group and product names to generate the image for a device that does not belong to a specific device group and product."
returns:
description: "signed device capability image response."
type: "<xref href=\"com.azure.resourcemanager.sphere.models.SignedCapabilityImageResponse?alt=com.azure.resourcemanager.sphere.models.SignedCapabilityImageResponse&text=SignedCapabilityImageResponse\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sphere.models.Devices.generateCapabilityImage(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.sphere.models.GenerateCapabilityImageRequest,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.sphere.models.Devices.generateCapabilityImage(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deviceName, GenerateCapabilityImageRequest generateDeviceCapabilityRequest, Context context)"
name: "generateCapabilityImage(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deviceName, GenerateCapabilityImageRequest generateDeviceCapabilityRequest, Context context)"
nameWithType: "Devices.generateCapabilityImage(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deviceName, GenerateCapabilityImageRequest generateDeviceCapabilityRequest, Context context)"
summary: "Generates the capability image for the device."
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: "Device name."
name: "deviceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Generate capability image request body."
name: "generateDeviceCapabilityRequest"
type: "<xref href=\"com.azure.resourcemanager.sphere.models.GenerateCapabilityImageRequest?alt=com.azure.resourcemanager.sphere.models.GenerateCapabilityImageRequest&text=GenerateCapabilityImageRequest\" 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 SignedCapabilityImageResponse generateCapabilityImage(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deviceName, GenerateCapabilityImageRequest generateDeviceCapabilityRequest, Context context)"
desc: "Generates the capability image for the device. Use '.unassigned' or '.default' for the device group and product names to generate the image for a device that does not belong to a specific device group and product."
returns:
description: "signed device capability image response."
type: "<xref href=\"com.azure.resourcemanager.sphere.models.SignedCapabilityImageResponse?alt=com.azure.resourcemanager.sphere.models.SignedCapabilityImageResponse&text=SignedCapabilityImageResponse\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sphere.models.Devices.get(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.sphere.models.Devices.get(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deviceName)"
name: "get(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deviceName)"
nameWithType: "Devices.get(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deviceName)"
summary: "Get a Device."
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: "Device name."
name: "deviceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Device get(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deviceName)"
desc: "Get a Device. Use '.unassigned' or '.default' for the device group and product names when a device does not belong to a device group and product."
returns:
description: "a Device."
type: "<xref href=\"com.azure.resourcemanager.sphere.models.Device?alt=com.azure.resourcemanager.sphere.models.Device&text=Device\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sphere.models.Devices.getById(java.lang.String)"
fullName: "com.azure.resourcemanager.sphere.models.Devices.getById(String id)"
name: "getById(String id)"
nameWithType: "Devices.getById(String id)"
summary: "Get a Device."
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 Device getById(String id)"
desc: "Get a Device. Use '.unassigned' or '.default' for the device group and product names when a device does not belong to a device group and product."
returns:
description: "a Device 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.Device?alt=com.azure.resourcemanager.sphere.models.Device&text=Device\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.sphere.models.Devices.getByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.sphere.models.Devices.getByIdWithResponse(String id, Context context)"
name: "getByIdWithResponse(String id, Context context)"
nameWithType: "Devices.getByIdWithResponse(String id, Context context)"
summary: "Get a Device."
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<Device> getByIdWithResponse(String id, Context context)"
desc: "Get a Device. Use '.unassigned' or '.default' for the device group and product names when a device does not belong to a device group and product."
returns:
description: "a Device 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.Device?alt=com.azure.resourcemanager.sphere.models.Device&text=Device\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.sphere.models.Devices.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.Devices.getWithResponse(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deviceName, Context context)"
name: "getWithResponse(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deviceName, Context context)"
nameWithType: "Devices.getWithResponse(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deviceName, Context context)"
summary: "Get a Device."
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: "Device name."
name: "deviceName"
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<Device> getWithResponse(String resourceGroupName, String catalogName, String productName, String deviceGroupName, String deviceName, Context context)"
desc: "Get a Device. Use '.unassigned' or '.default' for the device group and product names when a device does not belong to a device group and product."
returns:
description: "a Device 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.Device?alt=com.azure.resourcemanager.sphere.models.Device&text=Device\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.sphere.models.Devices.listByDeviceGroup(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.sphere.models.Devices.listByDeviceGroup(String resourceGroupName, String catalogName, String productName, String deviceGroupName)"
name: "listByDeviceGroup(String resourceGroupName, String catalogName, String productName, String deviceGroupName)"
nameWithType: "Devices.listByDeviceGroup(String resourceGroupName, String catalogName, String productName, String deviceGroupName)"
summary: "List Device 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<Device> listByDeviceGroup(String resourceGroupName, String catalogName, String productName, String deviceGroupName)"
desc: "List Device 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 Device 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.Device?alt=com.azure.resourcemanager.sphere.models.Device&text=Device\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.sphere.models.Devices.listByDeviceGroup(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.sphere.models.Devices.listByDeviceGroup(String resourceGroupName, String catalogName, String productName, String deviceGroupName, Context context)"
name: "listByDeviceGroup(String resourceGroupName, String catalogName, String productName, String deviceGroupName, Context context)"
nameWithType: "Devices.listByDeviceGroup(String resourceGroupName, String catalogName, String productName, String deviceGroupName, Context context)"
summary: "List Device 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: "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<Device> listByDeviceGroup(String resourceGroupName, String catalogName, String productName, String deviceGroupName, Context context)"
desc: "List Device 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 Device 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.Device?alt=com.azure.resourcemanager.sphere.models.Device&text=Device\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "interface"
desc: "Resource collection API of Devices."
metadata: {}
package: "com.azure.resourcemanager.sphere.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-sphere:1.0.0