241 строка
16 KiB
YAML
241 строка
16 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.devtestlabs.models.Users"
|
|
fullName: "com.azure.resourcemanager.devtestlabs.models.Users"
|
|
name: "Users"
|
|
nameWithType: "Users"
|
|
summary: "Resource collection API of Users."
|
|
syntax: "public interface **Users**"
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.devtestlabs.models.Users.define(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.devtestlabs.models.Users.define(String name)"
|
|
name: "define(String name)"
|
|
nameWithType: "Users.define(String name)"
|
|
summary: "Begins definition for a new User 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 User.DefinitionStages.Blank define(String name)"
|
|
desc: "Begins definition for a new User resource."
|
|
returns:
|
|
description: "the first stage of the new User definition."
|
|
type: "<xref href=\"com.azure.resourcemanager.devtestlabs.models.User.DefinitionStages.Blank?alt=com.azure.resourcemanager.devtestlabs.models.User.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.devtestlabs.models.Users.delete(java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.devtestlabs.models.Users.delete(String resourceGroupName, String labName, String name)"
|
|
name: "delete(String resourceGroupName, String labName, String name)"
|
|
nameWithType: "Users.delete(String resourceGroupName, String labName, String name)"
|
|
summary: "Delete user profile."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group."
|
|
name: "resourceGroupName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the lab."
|
|
name: "labName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the user profile."
|
|
name: "name"
|
|
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 labName, String name)"
|
|
desc: "Delete user profile. This operation can take a while to complete."
|
|
- uid: "com.azure.resourcemanager.devtestlabs.models.Users.delete(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.devtestlabs.models.Users.delete(String resourceGroupName, String labName, String name, Context context)"
|
|
name: "delete(String resourceGroupName, String labName, String name, Context context)"
|
|
nameWithType: "Users.delete(String resourceGroupName, String labName, String name, Context context)"
|
|
summary: "Delete user profile."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group."
|
|
name: "resourceGroupName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the lab."
|
|
name: "labName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the user profile."
|
|
name: "name"
|
|
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 labName, String name, Context context)"
|
|
desc: "Delete user profile. This operation can take a while to complete."
|
|
- uid: "com.azure.resourcemanager.devtestlabs.models.Users.deleteById(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.devtestlabs.models.Users.deleteById(String id)"
|
|
name: "deleteById(String id)"
|
|
nameWithType: "Users.deleteById(String id)"
|
|
summary: "Delete user profile."
|
|
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 user profile. This operation can take a while to complete."
|
|
- uid: "com.azure.resourcemanager.devtestlabs.models.Users.deleteByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.devtestlabs.models.Users.deleteByIdWithResponse(String id, Context context)"
|
|
name: "deleteByIdWithResponse(String id, Context context)"
|
|
nameWithType: "Users.deleteByIdWithResponse(String id, Context context)"
|
|
summary: "Delete user profile."
|
|
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 user profile. This operation can take a while to complete."
|
|
- uid: "com.azure.resourcemanager.devtestlabs.models.Users.get(java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.devtestlabs.models.Users.get(String resourceGroupName, String labName, String name)"
|
|
name: "get(String resourceGroupName, String labName, String name)"
|
|
nameWithType: "Users.get(String resourceGroupName, String labName, String name)"
|
|
summary: "Get user profile."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group."
|
|
name: "resourceGroupName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the lab."
|
|
name: "labName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the user profile."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract User get(String resourceGroupName, String labName, String name)"
|
|
desc: "Get user profile."
|
|
returns:
|
|
description: "user profile."
|
|
type: "<xref href=\"com.azure.resourcemanager.devtestlabs.models.User?alt=com.azure.resourcemanager.devtestlabs.models.User&text=User\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.devtestlabs.models.Users.getById(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.devtestlabs.models.Users.getById(String id)"
|
|
name: "getById(String id)"
|
|
nameWithType: "Users.getById(String id)"
|
|
summary: "Get user profile."
|
|
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 User getById(String id)"
|
|
desc: "Get user profile."
|
|
returns:
|
|
description: "user profile 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.devtestlabs.models.User?alt=com.azure.resourcemanager.devtestlabs.models.User&text=User\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.devtestlabs.models.Users.getByIdWithResponse(java.lang.String,java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.devtestlabs.models.Users.getByIdWithResponse(String id, String expand, Context context)"
|
|
name: "getByIdWithResponse(String id, String expand, Context context)"
|
|
nameWithType: "Users.getByIdWithResponse(String id, String expand, Context context)"
|
|
summary: "Get user profile."
|
|
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: "Specify the $expand query. Example: 'properties($select=identity)'."
|
|
name: "expand"
|
|
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<User> getByIdWithResponse(String id, String expand, Context context)"
|
|
desc: "Get user profile."
|
|
returns:
|
|
description: "user profile 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\" /><<xref href=\"com.azure.resourcemanager.devtestlabs.models.User?alt=com.azure.resourcemanager.devtestlabs.models.User&text=User\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.devtestlabs.models.Users.getWithResponse(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.devtestlabs.models.Users.getWithResponse(String resourceGroupName, String labName, String name, String expand, Context context)"
|
|
name: "getWithResponse(String resourceGroupName, String labName, String name, String expand, Context context)"
|
|
nameWithType: "Users.getWithResponse(String resourceGroupName, String labName, String name, String expand, Context context)"
|
|
summary: "Get user profile."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group."
|
|
name: "resourceGroupName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the lab."
|
|
name: "labName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the user profile."
|
|
name: "name"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Specify the $expand query. Example: 'properties($select=identity)'."
|
|
name: "expand"
|
|
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<User> getWithResponse(String resourceGroupName, String labName, String name, String expand, Context context)"
|
|
desc: "Get user profile."
|
|
returns:
|
|
description: "user profile 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\" /><<xref href=\"com.azure.resourcemanager.devtestlabs.models.User?alt=com.azure.resourcemanager.devtestlabs.models.User&text=User\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.devtestlabs.models.Users.list(java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.devtestlabs.models.Users.list(String resourceGroupName, String labName)"
|
|
name: "list(String resourceGroupName, String labName)"
|
|
nameWithType: "Users.list(String resourceGroupName, String labName)"
|
|
summary: "List user profiles in a given lab."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group."
|
|
name: "resourceGroupName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the lab."
|
|
name: "labName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract PagedIterable<User> list(String resourceGroupName, String labName)"
|
|
desc: "List user profiles in a given lab."
|
|
returns:
|
|
description: "the response of a 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\" /><<xref href=\"com.azure.resourcemanager.devtestlabs.models.User?alt=com.azure.resourcemanager.devtestlabs.models.User&text=User\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.devtestlabs.models.Users.list(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.Integer,java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.devtestlabs.models.Users.list(String resourceGroupName, String labName, String expand, String filter, Integer top, String orderby, Context context)"
|
|
name: "list(String resourceGroupName, String labName, String expand, String filter, Integer top, String orderby, Context context)"
|
|
nameWithType: "Users.list(String resourceGroupName, String labName, String expand, String filter, Integer top, String orderby, Context context)"
|
|
summary: "List user profiles in a given lab."
|
|
modifiers:
|
|
- "abstract"
|
|
parameters:
|
|
- description: "The name of the resource group."
|
|
name: "resourceGroupName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the lab."
|
|
name: "labName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "Specify the $expand query. Example: 'properties($select=identity)'."
|
|
name: "expand"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The filter to apply to the operation. Example: '$filter=contains(name,'myName')."
|
|
name: "filter"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The maximum number of resources to return from the operation. Example: '$top=10'."
|
|
name: "top"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Integer.html\">Integer</a>"
|
|
- description: "The ordering expression for the results, using OData notation. Example: '$orderby=name desc'."
|
|
name: "orderby"
|
|
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<User> list(String resourceGroupName, String labName, String expand, String filter, Integer top, String orderby, Context context)"
|
|
desc: "List user profiles in a given lab."
|
|
returns:
|
|
description: "the response of a 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\" /><<xref href=\"com.azure.resourcemanager.devtestlabs.models.User?alt=com.azure.resourcemanager.devtestlabs.models.User&text=User\" data-throw-if-not-resolved=\"False\" />>"
|
|
type: "interface"
|
|
desc: "Resource collection API of Users."
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.devtestlabs.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-devtestlabs:1.0.0
|