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

286 строки
23 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins"
fullName: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins"
name: "DigitalTwins"
nameWithType: "DigitalTwins"
summary: "Resource collection API of Digital<wbr>Twins."
syntax: "public interface **DigitalTwins**"
methods:
- uid: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.checkNameAvailability(java.lang.String,com.azure.resourcemanager.digitaltwins.models.CheckNameRequest)"
fullName: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.checkNameAvailability(String location, CheckNameRequest digitalTwinsInstanceCheckName)"
name: "checkNameAvailability(String location, CheckNameRequest digitalTwinsInstanceCheckName)"
nameWithType: "DigitalTwins.checkNameAvailability(String location, CheckNameRequest digitalTwinsInstanceCheckName)"
summary: "Check if a Digital<wbr>Twins<wbr>Instance name is available."
modifiers:
- "abstract"
parameters:
- description: "Location of DigitalTwinsInstance."
name: "location"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Set the name parameter in the DigitalTwinsInstanceCheckName structure to the\n name of the DigitalTwinsInstance to check."
name: "digitalTwinsInstanceCheckName"
type: "<xref href=\"com.azure.resourcemanager.digitaltwins.models.CheckNameRequest?alt=com.azure.resourcemanager.digitaltwins.models.CheckNameRequest&text=CheckNameRequest\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract CheckNameResult checkNameAvailability(String location, CheckNameRequest digitalTwinsInstanceCheckName)"
desc: "Check if a DigitalTwinsInstance name is available."
returns:
description: "the result returned from a check name availability request."
type: "<xref href=\"com.azure.resourcemanager.digitaltwins.models.CheckNameResult?alt=com.azure.resourcemanager.digitaltwins.models.CheckNameResult&text=CheckNameResult\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.checkNameAvailabilityWithResponse(java.lang.String,com.azure.resourcemanager.digitaltwins.models.CheckNameRequest,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.checkNameAvailabilityWithResponse(String location, CheckNameRequest digitalTwinsInstanceCheckName, Context context)"
name: "checkNameAvailabilityWithResponse(String location, CheckNameRequest digitalTwinsInstanceCheckName, Context context)"
nameWithType: "DigitalTwins.checkNameAvailabilityWithResponse(String location, CheckNameRequest digitalTwinsInstanceCheckName, Context context)"
summary: "Check if a Digital<wbr>Twins<wbr>Instance name is available."
modifiers:
- "abstract"
parameters:
- description: "Location of DigitalTwinsInstance."
name: "location"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "Set the name parameter in the DigitalTwinsInstanceCheckName structure to the\n name of the DigitalTwinsInstance to check."
name: "digitalTwinsInstanceCheckName"
type: "<xref href=\"com.azure.resourcemanager.digitaltwins.models.CheckNameRequest?alt=com.azure.resourcemanager.digitaltwins.models.CheckNameRequest&text=CheckNameRequest\" 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 Response<CheckNameResult> checkNameAvailabilityWithResponse(String location, CheckNameRequest digitalTwinsInstanceCheckName, Context context)"
desc: "Check if a DigitalTwinsInstance name is available."
returns:
description: "the result returned from a check name availability request 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.digitaltwins.models.CheckNameResult?alt=com.azure.resourcemanager.digitaltwins.models.CheckNameResult&text=CheckNameResult\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.define(java.lang.String)"
fullName: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.define(String name)"
name: "define(String name)"
nameWithType: "DigitalTwins.define(String name)"
summary: "Begins definition for a new Digital<wbr>Twins<wbr>Description 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 DigitalTwinsDescription.DefinitionStages.Blank define(String name)"
desc: "Begins definition for a new DigitalTwinsDescription resource."
returns:
description: "the first stage of the new DigitalTwinsDescription definition."
type: "<xref href=\"com.azure.resourcemanager.digitaltwins.models.DigitalTwinsDescription.DefinitionStages.Blank?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsDescription.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.delete(java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.delete(String resourceGroupName, String resourceName, Context context)"
name: "delete(String resourceGroupName, String resourceName, Context context)"
nameWithType: "DigitalTwins.delete(String resourceGroupName, String resourceName, Context context)"
summary: "Delete a Digital<wbr>Twins<wbr>Instance."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the DigitalTwinsInstance."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the DigitalTwinsInstance."
name: "resourceName"
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 DigitalTwinsDescription delete(String resourceGroupName, String resourceName, Context context)"
desc: "Delete a DigitalTwinsInstance."
returns:
description: "the description of the DigitalTwins service."
type: "<xref href=\"com.azure.resourcemanager.digitaltwins.models.DigitalTwinsDescription?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsDescription&text=DigitalTwinsDescription\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.deleteById(java.lang.String)"
fullName: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.deleteById(String id)"
name: "deleteById(String id)"
nameWithType: "DigitalTwins.deleteById(String id)"
summary: "Delete a Digital<wbr>Twins<wbr>Instance."
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 DigitalTwinsDescription deleteById(String id)"
desc: "Delete a DigitalTwinsInstance."
returns:
description: "the description of the DigitalTwins service."
type: "<xref href=\"com.azure.resourcemanager.digitaltwins.models.DigitalTwinsDescription?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsDescription&text=DigitalTwinsDescription\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.deleteByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.deleteByIdWithResponse(String id, Context context)"
name: "deleteByIdWithResponse(String id, Context context)"
nameWithType: "DigitalTwins.deleteByIdWithResponse(String id, Context context)"
summary: "Delete a Digital<wbr>Twins<wbr>Instance."
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 DigitalTwinsDescription deleteByIdWithResponse(String id, Context context)"
desc: "Delete a DigitalTwinsInstance."
returns:
description: "the description of the DigitalTwins service."
type: "<xref href=\"com.azure.resourcemanager.digitaltwins.models.DigitalTwinsDescription?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsDescription&text=DigitalTwinsDescription\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.deleteByResourceGroup(java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.deleteByResourceGroup(String resourceGroupName, String resourceName)"
name: "deleteByResourceGroup(String resourceGroupName, String resourceName)"
nameWithType: "DigitalTwins.deleteByResourceGroup(String resourceGroupName, String resourceName)"
summary: "Delete a Digital<wbr>Twins<wbr>Instance."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the DigitalTwinsInstance."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the DigitalTwinsInstance."
name: "resourceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract DigitalTwinsDescription deleteByResourceGroup(String resourceGroupName, String resourceName)"
desc: "Delete a DigitalTwinsInstance."
returns:
description: "the description of the DigitalTwins service."
type: "<xref href=\"com.azure.resourcemanager.digitaltwins.models.DigitalTwinsDescription?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsDescription&text=DigitalTwinsDescription\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.getById(java.lang.String)"
fullName: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.getById(String id)"
name: "getById(String id)"
nameWithType: "DigitalTwins.getById(String id)"
summary: "Get Digital<wbr>Twins<wbr>Instances resource."
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 DigitalTwinsDescription getById(String id)"
desc: "Get DigitalTwinsInstances resource."
returns:
description: "digitalTwinsInstances resource 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.digitaltwins.models.DigitalTwinsDescription?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsDescription&text=DigitalTwinsDescription\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.getByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.getByIdWithResponse(String id, Context context)"
name: "getByIdWithResponse(String id, Context context)"
nameWithType: "DigitalTwins.getByIdWithResponse(String id, Context context)"
summary: "Get Digital<wbr>Twins<wbr>Instances resource."
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<DigitalTwinsDescription> getByIdWithResponse(String id, Context context)"
desc: "Get DigitalTwinsInstances resource."
returns:
description: "digitalTwinsInstances resource 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.digitaltwins.models.DigitalTwinsDescription?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsDescription&text=DigitalTwinsDescription\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.getByResourceGroup(java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.getByResourceGroup(String resourceGroupName, String resourceName)"
name: "getByResourceGroup(String resourceGroupName, String resourceName)"
nameWithType: "DigitalTwins.getByResourceGroup(String resourceGroupName, String resourceName)"
summary: "Get Digital<wbr>Twins<wbr>Instances resource."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the DigitalTwinsInstance."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the DigitalTwinsInstance."
name: "resourceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract DigitalTwinsDescription getByResourceGroup(String resourceGroupName, String resourceName)"
desc: "Get DigitalTwinsInstances resource."
returns:
description: "digitalTwinsInstances resource."
type: "<xref href=\"com.azure.resourcemanager.digitaltwins.models.DigitalTwinsDescription?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsDescription&text=DigitalTwinsDescription\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.getByResourceGroupWithResponse(java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.getByResourceGroupWithResponse(String resourceGroupName, String resourceName, Context context)"
name: "getByResourceGroupWithResponse(String resourceGroupName, String resourceName, Context context)"
nameWithType: "DigitalTwins.getByResourceGroupWithResponse(String resourceGroupName, String resourceName, Context context)"
summary: "Get Digital<wbr>Twins<wbr>Instances resource."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the DigitalTwinsInstance."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the DigitalTwinsInstance."
name: "resourceName"
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<DigitalTwinsDescription> getByResourceGroupWithResponse(String resourceGroupName, String resourceName, Context context)"
desc: "Get DigitalTwinsInstances resource."
returns:
description: "digitalTwinsInstances resource 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.digitaltwins.models.DigitalTwinsDescription?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsDescription&text=DigitalTwinsDescription\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.list()"
fullName: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.list()"
name: "list()"
nameWithType: "DigitalTwins.list()"
summary: "Get all the Digital<wbr>Twins<wbr>Instances in a subscription."
modifiers:
- "abstract"
syntax: "public abstract PagedIterable<DigitalTwinsDescription> list()"
desc: "Get all the DigitalTwinsInstances in a subscription."
returns:
description: "all the DigitalTwinsInstances in a subscription 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.digitaltwins.models.DigitalTwinsDescription?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsDescription&text=DigitalTwinsDescription\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.list(com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.list(Context context)"
name: "list(Context context)"
nameWithType: "DigitalTwins.list(Context context)"
summary: "Get all the Digital<wbr>Twins<wbr>Instances in a subscription."
modifiers:
- "abstract"
parameters:
- 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<DigitalTwinsDescription> list(Context context)"
desc: "Get all the DigitalTwinsInstances in a subscription."
returns:
description: "all the DigitalTwinsInstances in a subscription 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.digitaltwins.models.DigitalTwinsDescription?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsDescription&text=DigitalTwinsDescription\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.listByResourceGroup(java.lang.String)"
fullName: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.listByResourceGroup(String resourceGroupName)"
name: "listByResourceGroup(String resourceGroupName)"
nameWithType: "DigitalTwins.listByResourceGroup(String resourceGroupName)"
summary: "Get all the Digital<wbr>Twins<wbr>Instances in a resource group."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the DigitalTwinsInstance."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract PagedIterable<DigitalTwinsDescription> listByResourceGroup(String resourceGroupName)"
desc: "Get all the DigitalTwinsInstances in a resource group."
returns:
description: "all the DigitalTwinsInstances in a resource group 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.digitaltwins.models.DigitalTwinsDescription?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsDescription&text=DigitalTwinsDescription\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.listByResourceGroup(java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.digitaltwins.models.DigitalTwins.listByResourceGroup(String resourceGroupName, Context context)"
name: "listByResourceGroup(String resourceGroupName, Context context)"
nameWithType: "DigitalTwins.listByResourceGroup(String resourceGroupName, Context context)"
summary: "Get all the Digital<wbr>Twins<wbr>Instances in a resource group."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the DigitalTwinsInstance."
name: "resourceGroupName"
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<DigitalTwinsDescription> listByResourceGroup(String resourceGroupName, Context context)"
desc: "Get all the DigitalTwinsInstances in a resource group."
returns:
description: "all the DigitalTwinsInstances in a resource group 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.digitaltwins.models.DigitalTwinsDescription?alt=com.azure.resourcemanager.digitaltwins.models.DigitalTwinsDescription&text=DigitalTwinsDescription\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "interface"
desc: "Resource collection API of DigitalTwins."
metadata: {}
package: "com.azure.resourcemanager.digitaltwins.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-digitaltwins:1.2.0