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

331 строка
24 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.iotcentral.models.Apps"
fullName: "com.azure.resourcemanager.iotcentral.models.Apps"
name: "Apps"
nameWithType: "Apps"
summary: "Resource collection API of Apps."
syntax: "public interface **Apps**"
methods:
- uid: "com.azure.resourcemanager.iotcentral.models.Apps.checkNameAvailability(com.azure.resourcemanager.iotcentral.models.OperationInputs)"
fullName: "com.azure.resourcemanager.iotcentral.models.Apps.checkNameAvailability(OperationInputs operationInputs)"
name: "checkNameAvailability(OperationInputs operationInputs)"
nameWithType: "Apps.checkNameAvailability(OperationInputs operationInputs)"
summary: "Check if an IoT Central application name is available."
modifiers:
- "abstract"
parameters:
- description: "Set the name parameter in the OperationInputs structure to the name of the IoT Central\n application to check."
name: "operationInputs"
type: "<xref href=\"com.azure.resourcemanager.iotcentral.models.OperationInputs?alt=com.azure.resourcemanager.iotcentral.models.OperationInputs&text=OperationInputs\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract AppAvailabilityInfo checkNameAvailability(OperationInputs operationInputs)"
desc: "Check if an IoT Central application name is available."
returns:
description: "the properties indicating whether a given IoT Central application name or subdomain is available."
type: "<xref href=\"com.azure.resourcemanager.iotcentral.models.AppAvailabilityInfo?alt=com.azure.resourcemanager.iotcentral.models.AppAvailabilityInfo&text=AppAvailabilityInfo\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.iotcentral.models.Apps.checkNameAvailabilityWithResponse(com.azure.resourcemanager.iotcentral.models.OperationInputs,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.iotcentral.models.Apps.checkNameAvailabilityWithResponse(OperationInputs operationInputs, Context context)"
name: "checkNameAvailabilityWithResponse(OperationInputs operationInputs, Context context)"
nameWithType: "Apps.checkNameAvailabilityWithResponse(OperationInputs operationInputs, Context context)"
summary: "Check if an IoT Central application name is available."
modifiers:
- "abstract"
parameters:
- description: "Set the name parameter in the OperationInputs structure to the name of the IoT Central\n application to check."
name: "operationInputs"
type: "<xref href=\"com.azure.resourcemanager.iotcentral.models.OperationInputs?alt=com.azure.resourcemanager.iotcentral.models.OperationInputs&text=OperationInputs\" 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<AppAvailabilityInfo> checkNameAvailabilityWithResponse(OperationInputs operationInputs, Context context)"
desc: "Check if an IoT Central application name is available."
returns:
description: "the properties indicating whether a given IoT Central application name or subdomain is available."
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.iotcentral.models.AppAvailabilityInfo?alt=com.azure.resourcemanager.iotcentral.models.AppAvailabilityInfo&text=AppAvailabilityInfo\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.iotcentral.models.Apps.checkSubdomainAvailability(com.azure.resourcemanager.iotcentral.models.OperationInputs)"
fullName: "com.azure.resourcemanager.iotcentral.models.Apps.checkSubdomainAvailability(OperationInputs operationInputs)"
name: "checkSubdomainAvailability(OperationInputs operationInputs)"
nameWithType: "Apps.checkSubdomainAvailability(OperationInputs operationInputs)"
summary: "Check if an IoT Central application subdomain is available."
modifiers:
- "abstract"
parameters:
- description: "Set the name parameter in the OperationInputs structure to the subdomain of the IoT\n Central application to check."
name: "operationInputs"
type: "<xref href=\"com.azure.resourcemanager.iotcentral.models.OperationInputs?alt=com.azure.resourcemanager.iotcentral.models.OperationInputs&text=OperationInputs\" data-throw-if-not-resolved=\"False\" />"
syntax: "public abstract AppAvailabilityInfo checkSubdomainAvailability(OperationInputs operationInputs)"
desc: "Check if an IoT Central application subdomain is available."
returns:
description: "the properties indicating whether a given IoT Central application name or subdomain is available."
type: "<xref href=\"com.azure.resourcemanager.iotcentral.models.AppAvailabilityInfo?alt=com.azure.resourcemanager.iotcentral.models.AppAvailabilityInfo&text=AppAvailabilityInfo\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.iotcentral.models.Apps.checkSubdomainAvailabilityWithResponse(com.azure.resourcemanager.iotcentral.models.OperationInputs,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.iotcentral.models.Apps.checkSubdomainAvailabilityWithResponse(OperationInputs operationInputs, Context context)"
name: "checkSubdomainAvailabilityWithResponse(OperationInputs operationInputs, Context context)"
nameWithType: "Apps.checkSubdomainAvailabilityWithResponse(OperationInputs operationInputs, Context context)"
summary: "Check if an IoT Central application subdomain is available."
modifiers:
- "abstract"
parameters:
- description: "Set the name parameter in the OperationInputs structure to the subdomain of the IoT\n Central application to check."
name: "operationInputs"
type: "<xref href=\"com.azure.resourcemanager.iotcentral.models.OperationInputs?alt=com.azure.resourcemanager.iotcentral.models.OperationInputs&text=OperationInputs\" 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<AppAvailabilityInfo> checkSubdomainAvailabilityWithResponse(OperationInputs operationInputs, Context context)"
desc: "Check if an IoT Central application subdomain is available."
returns:
description: "the properties indicating whether a given IoT Central application name or subdomain is available."
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.iotcentral.models.AppAvailabilityInfo?alt=com.azure.resourcemanager.iotcentral.models.AppAvailabilityInfo&text=AppAvailabilityInfo\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.iotcentral.models.Apps.define(java.lang.String)"
fullName: "com.azure.resourcemanager.iotcentral.models.Apps.define(String name)"
name: "define(String name)"
nameWithType: "Apps.define(String name)"
summary: "Begins definition for a new App 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 App.DefinitionStages.Blank define(String name)"
desc: "Begins definition for a new App resource."
returns:
description: "the first stage of the new App definition."
type: "<xref href=\"com.azure.resourcemanager.iotcentral.models.App.DefinitionStages.Blank?alt=com.azure.resourcemanager.iotcentral.models.App.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.iotcentral.models.Apps.delete(java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.iotcentral.models.Apps.delete(String resourceGroupName, String resourceName, Context context)"
name: "delete(String resourceGroupName, String resourceName, Context context)"
nameWithType: "Apps.delete(String resourceGroupName, String resourceName, Context context)"
summary: "Delete an IoT Central application."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the IoT Central application."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ARM resource name of the IoT Central application."
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 void delete(String resourceGroupName, String resourceName, Context context)"
desc: "Delete an IoT Central application."
- uid: "com.azure.resourcemanager.iotcentral.models.Apps.deleteById(java.lang.String)"
fullName: "com.azure.resourcemanager.iotcentral.models.Apps.deleteById(String id)"
name: "deleteById(String id)"
nameWithType: "Apps.deleteById(String id)"
summary: "Delete an IoT Central application."
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 an IoT Central application."
- uid: "com.azure.resourcemanager.iotcentral.models.Apps.deleteByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.iotcentral.models.Apps.deleteByIdWithResponse(String id, Context context)"
name: "deleteByIdWithResponse(String id, Context context)"
nameWithType: "Apps.deleteByIdWithResponse(String id, Context context)"
summary: "Delete an IoT Central application."
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 an IoT Central application."
- uid: "com.azure.resourcemanager.iotcentral.models.Apps.deleteByResourceGroup(java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.iotcentral.models.Apps.deleteByResourceGroup(String resourceGroupName, String resourceName)"
name: "deleteByResourceGroup(String resourceGroupName, String resourceName)"
nameWithType: "Apps.deleteByResourceGroup(String resourceGroupName, String resourceName)"
summary: "Delete an IoT Central application."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the IoT Central application."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ARM resource name of the IoT Central application."
name: "resourceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract void deleteByResourceGroup(String resourceGroupName, String resourceName)"
desc: "Delete an IoT Central application."
- uid: "com.azure.resourcemanager.iotcentral.models.Apps.getById(java.lang.String)"
fullName: "com.azure.resourcemanager.iotcentral.models.Apps.getById(String id)"
name: "getById(String id)"
nameWithType: "Apps.getById(String id)"
summary: "Get the metadata of an IoT Central application."
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 App getById(String id)"
desc: "Get the metadata of an IoT Central application."
returns:
description: "the metadata of an IoT Central application."
type: "<xref href=\"com.azure.resourcemanager.iotcentral.models.App?alt=com.azure.resourcemanager.iotcentral.models.App&text=App\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.iotcentral.models.Apps.getByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.iotcentral.models.Apps.getByIdWithResponse(String id, Context context)"
name: "getByIdWithResponse(String id, Context context)"
nameWithType: "Apps.getByIdWithResponse(String id, Context context)"
summary: "Get the metadata of an IoT Central application."
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<App> getByIdWithResponse(String id, Context context)"
desc: "Get the metadata of an IoT Central application."
returns:
description: "the metadata of an IoT Central application."
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.iotcentral.models.App?alt=com.azure.resourcemanager.iotcentral.models.App&text=App\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.iotcentral.models.Apps.getByResourceGroup(java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.iotcentral.models.Apps.getByResourceGroup(String resourceGroupName, String resourceName)"
name: "getByResourceGroup(String resourceGroupName, String resourceName)"
nameWithType: "Apps.getByResourceGroup(String resourceGroupName, String resourceName)"
summary: "Get the metadata of an IoT Central application."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the IoT Central application."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ARM resource name of the IoT Central application."
name: "resourceName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract App getByResourceGroup(String resourceGroupName, String resourceName)"
desc: "Get the metadata of an IoT Central application."
returns:
description: "the metadata of an IoT Central application."
type: "<xref href=\"com.azure.resourcemanager.iotcentral.models.App?alt=com.azure.resourcemanager.iotcentral.models.App&text=App\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.iotcentral.models.Apps.getByResourceGroupWithResponse(java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.iotcentral.models.Apps.getByResourceGroupWithResponse(String resourceGroupName, String resourceName, Context context)"
name: "getByResourceGroupWithResponse(String resourceGroupName, String resourceName, Context context)"
nameWithType: "Apps.getByResourceGroupWithResponse(String resourceGroupName, String resourceName, Context context)"
summary: "Get the metadata of an IoT Central application."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the IoT Central application."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The ARM resource name of the IoT Central application."
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<App> getByResourceGroupWithResponse(String resourceGroupName, String resourceName, Context context)"
desc: "Get the metadata of an IoT Central application."
returns:
description: "the metadata of an IoT Central application."
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.iotcentral.models.App?alt=com.azure.resourcemanager.iotcentral.models.App&text=App\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.iotcentral.models.Apps.list()"
fullName: "com.azure.resourcemanager.iotcentral.models.Apps.list()"
name: "list()"
nameWithType: "Apps.list()"
summary: "Get all IoT Central Applications in a subscription."
modifiers:
- "abstract"
syntax: "public abstract PagedIterable<App> list()"
desc: "Get all IoT Central Applications in a subscription."
returns:
description: "all IoT Central Applications in a subscription."
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.iotcentral.models.App?alt=com.azure.resourcemanager.iotcentral.models.App&text=App\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.iotcentral.models.Apps.list(com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.iotcentral.models.Apps.list(Context context)"
name: "list(Context context)"
nameWithType: "Apps.list(Context context)"
summary: "Get all IoT Central Applications 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<App> list(Context context)"
desc: "Get all IoT Central Applications in a subscription."
returns:
description: "all IoT Central Applications in a subscription."
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.iotcentral.models.App?alt=com.azure.resourcemanager.iotcentral.models.App&text=App\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.iotcentral.models.Apps.listByResourceGroup(java.lang.String)"
fullName: "com.azure.resourcemanager.iotcentral.models.Apps.listByResourceGroup(String resourceGroupName)"
name: "listByResourceGroup(String resourceGroupName)"
nameWithType: "Apps.listByResourceGroup(String resourceGroupName)"
summary: "Get all the IoT Central Applications in a resource group."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the IoT Central application."
name: "resourceGroupName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract PagedIterable<App> listByResourceGroup(String resourceGroupName)"
desc: "Get all the IoT Central Applications in a resource group."
returns:
description: "all the IoT Central Applications in a resource group."
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.iotcentral.models.App?alt=com.azure.resourcemanager.iotcentral.models.App&text=App\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.iotcentral.models.Apps.listByResourceGroup(java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.iotcentral.models.Apps.listByResourceGroup(String resourceGroupName, Context context)"
name: "listByResourceGroup(String resourceGroupName, Context context)"
nameWithType: "Apps.listByResourceGroup(String resourceGroupName, Context context)"
summary: "Get all the IoT Central Applications in a resource group."
modifiers:
- "abstract"
parameters:
- description: "The name of the resource group that contains the IoT Central application."
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<App> listByResourceGroup(String resourceGroupName, Context context)"
desc: "Get all the IoT Central Applications in a resource group."
returns:
description: "all the IoT Central Applications in a resource group."
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.iotcentral.models.App?alt=com.azure.resourcemanager.iotcentral.models.App&text=App\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.iotcentral.models.Apps.listTemplates()"
fullName: "com.azure.resourcemanager.iotcentral.models.Apps.listTemplates()"
name: "listTemplates()"
nameWithType: "Apps.listTemplates()"
summary: "Get all available application templates."
modifiers:
- "abstract"
syntax: "public abstract PagedIterable<AppTemplate> listTemplates()"
desc: "Get all available application templates."
returns:
description: "all available application templates."
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.iotcentral.models.AppTemplate?alt=com.azure.resourcemanager.iotcentral.models.AppTemplate&text=AppTemplate\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.iotcentral.models.Apps.listTemplates(com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.iotcentral.models.Apps.listTemplates(Context context)"
name: "listTemplates(Context context)"
nameWithType: "Apps.listTemplates(Context context)"
summary: "Get all available application templates."
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<AppTemplate> listTemplates(Context context)"
desc: "Get all available application templates."
returns:
description: "all available application templates."
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.iotcentral.models.AppTemplate?alt=com.azure.resourcemanager.iotcentral.models.AppTemplate&text=AppTemplate\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "interface"
desc: "Resource collection API of Apps."
metadata: {}
package: "com.azure.resourcemanager.iotcentral.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-iotcentral:1.0.0