276 строки
19 KiB
YAML
276 строки
19 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.apicenter.models.Workspaces"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.Workspaces"
|
|
name: "Workspaces"
|
|
nameWithType: "Workspaces"
|
|
summary: "Resource collection API of Workspaces."
|
|
syntax: "public interface **Workspaces**"
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.apicenter.models.Workspaces.define(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.Workspaces.define(String name)"
|
|
name: "define(String name)"
|
|
nameWithType: "Workspaces.define(String name)"
|
|
summary: "Begins definition for a new Workspace 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 Workspace.DefinitionStages.Blank define(String name)"
|
|
desc: "Begins definition for a new Workspace resource."
|
|
returns:
|
|
description: "the first stage of the new Workspace definition."
|
|
type: "<xref href=\"com.azure.resourcemanager.apicenter.models.Workspace.DefinitionStages.Blank?alt=com.azure.resourcemanager.apicenter.models.Workspace.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.apicenter.models.Workspaces.delete(java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.Workspaces.delete(String resourceGroupName, String serviceName, String workspaceName)"
|
|
name: "delete(String resourceGroupName, String serviceName, String workspaceName)"
|
|
nameWithType: "Workspaces.delete(String resourceGroupName, String serviceName, String workspaceName)"
|
|
summary: "Deletes specified workspace."
|
|
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: "The name of Azure API Center service."
|
|
name: "serviceName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the workspace."
|
|
name: "workspaceName"
|
|
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 serviceName, String workspaceName)"
|
|
desc: "Deletes specified workspace."
|
|
- uid: "com.azure.resourcemanager.apicenter.models.Workspaces.deleteById(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.Workspaces.deleteById(String id)"
|
|
name: "deleteById(String id)"
|
|
nameWithType: "Workspaces.deleteById(String id)"
|
|
summary: "Deletes specified workspace."
|
|
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: "Deletes specified workspace."
|
|
- uid: "com.azure.resourcemanager.apicenter.models.Workspaces.deleteByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.Workspaces.deleteByIdWithResponse(String id, Context context)"
|
|
name: "deleteByIdWithResponse(String id, Context context)"
|
|
nameWithType: "Workspaces.deleteByIdWithResponse(String id, Context context)"
|
|
summary: "Deletes specified workspace."
|
|
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<Void> deleteByIdWithResponse(String id, Context context)"
|
|
desc: "Deletes specified workspace."
|
|
returns:
|
|
description: "the <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\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.resourcemanager.apicenter.models.Workspaces.deleteWithResponse(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.Workspaces.deleteWithResponse(String resourceGroupName, String serviceName, String workspaceName, Context context)"
|
|
name: "deleteWithResponse(String resourceGroupName, String serviceName, String workspaceName, Context context)"
|
|
nameWithType: "Workspaces.deleteWithResponse(String resourceGroupName, String serviceName, String workspaceName, Context context)"
|
|
summary: "Deletes specified workspace."
|
|
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: "The name of Azure API Center service."
|
|
name: "serviceName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the workspace."
|
|
name: "workspaceName"
|
|
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<Void> deleteWithResponse(String resourceGroupName, String serviceName, String workspaceName, Context context)"
|
|
desc: "Deletes specified workspace."
|
|
returns:
|
|
description: "the <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\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.resourcemanager.apicenter.models.Workspaces.get(java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.Workspaces.get(String resourceGroupName, String serviceName, String workspaceName)"
|
|
name: "get(String resourceGroupName, String serviceName, String workspaceName)"
|
|
nameWithType: "Workspaces.get(String resourceGroupName, String serviceName, String workspaceName)"
|
|
summary: "Returns details of the workspace."
|
|
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: "The name of Azure API Center service."
|
|
name: "serviceName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the workspace."
|
|
name: "workspaceName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract Workspace get(String resourceGroupName, String serviceName, String workspaceName)"
|
|
desc: "Returns details of the workspace."
|
|
returns:
|
|
description: "workspace entity."
|
|
type: "<xref href=\"com.azure.resourcemanager.apicenter.models.Workspace?alt=com.azure.resourcemanager.apicenter.models.Workspace&text=Workspace\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.apicenter.models.Workspaces.getById(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.Workspaces.getById(String id)"
|
|
name: "getById(String id)"
|
|
nameWithType: "Workspaces.getById(String id)"
|
|
summary: "Returns details of the workspace."
|
|
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 Workspace getById(String id)"
|
|
desc: "Returns details of the workspace."
|
|
returns:
|
|
description: "workspace entity."
|
|
type: "<xref href=\"com.azure.resourcemanager.apicenter.models.Workspace?alt=com.azure.resourcemanager.apicenter.models.Workspace&text=Workspace\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.apicenter.models.Workspaces.getByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.Workspaces.getByIdWithResponse(String id, Context context)"
|
|
name: "getByIdWithResponse(String id, Context context)"
|
|
nameWithType: "Workspaces.getByIdWithResponse(String id, Context context)"
|
|
summary: "Returns details of the workspace."
|
|
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<Workspace> getByIdWithResponse(String id, Context context)"
|
|
desc: "Returns details of the workspace."
|
|
returns:
|
|
description: "workspace entity."
|
|
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.apicenter.models.Workspace?alt=com.azure.resourcemanager.apicenter.models.Workspace&text=Workspace\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.apicenter.models.Workspaces.getWithResponse(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.Workspaces.getWithResponse(String resourceGroupName, String serviceName, String workspaceName, Context context)"
|
|
name: "getWithResponse(String resourceGroupName, String serviceName, String workspaceName, Context context)"
|
|
nameWithType: "Workspaces.getWithResponse(String resourceGroupName, String serviceName, String workspaceName, Context context)"
|
|
summary: "Returns details of the workspace."
|
|
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: "The name of Azure API Center service."
|
|
name: "serviceName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the workspace."
|
|
name: "workspaceName"
|
|
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<Workspace> getWithResponse(String resourceGroupName, String serviceName, String workspaceName, Context context)"
|
|
desc: "Returns details of the workspace."
|
|
returns:
|
|
description: "workspace entity."
|
|
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.apicenter.models.Workspace?alt=com.azure.resourcemanager.apicenter.models.Workspace&text=Workspace\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.apicenter.models.Workspaces.head(java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.Workspaces.head(String resourceGroupName, String serviceName, String workspaceName)"
|
|
name: "head(String resourceGroupName, String serviceName, String workspaceName)"
|
|
nameWithType: "Workspaces.head(String resourceGroupName, String serviceName, String workspaceName)"
|
|
summary: "Checks if specified workspace exists."
|
|
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: "The name of Azure API Center service."
|
|
name: "serviceName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the workspace."
|
|
name: "workspaceName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract void head(String resourceGroupName, String serviceName, String workspaceName)"
|
|
desc: "Checks if specified workspace exists."
|
|
- uid: "com.azure.resourcemanager.apicenter.models.Workspaces.headWithResponse(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.Workspaces.headWithResponse(String resourceGroupName, String serviceName, String workspaceName, Context context)"
|
|
name: "headWithResponse(String resourceGroupName, String serviceName, String workspaceName, Context context)"
|
|
nameWithType: "Workspaces.headWithResponse(String resourceGroupName, String serviceName, String workspaceName, Context context)"
|
|
summary: "Checks if specified workspace exists."
|
|
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: "The name of Azure API Center service."
|
|
name: "serviceName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the workspace."
|
|
name: "workspaceName"
|
|
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<Void> headWithResponse(String resourceGroupName, String serviceName, String workspaceName, Context context)"
|
|
desc: "Checks if specified workspace exists."
|
|
returns:
|
|
description: "the <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\" /><<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>>"
|
|
- uid: "com.azure.resourcemanager.apicenter.models.Workspaces.list(java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.Workspaces.list(String resourceGroupName, String serviceName)"
|
|
name: "list(String resourceGroupName, String serviceName)"
|
|
nameWithType: "Workspaces.list(String resourceGroupName, String serviceName)"
|
|
summary: "Returns a collection of workspaces."
|
|
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: "The name of Azure API Center service."
|
|
name: "serviceName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract PagedIterable<Workspace> list(String resourceGroupName, String serviceName)"
|
|
desc: "Returns a collection of workspaces."
|
|
returns:
|
|
description: "the response of a Workspace 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.apicenter.models.Workspace?alt=com.azure.resourcemanager.apicenter.models.Workspace&text=Workspace\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.apicenter.models.Workspaces.list(java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.Workspaces.list(String resourceGroupName, String serviceName, String filter, Context context)"
|
|
name: "list(String resourceGroupName, String serviceName, String filter, Context context)"
|
|
nameWithType: "Workspaces.list(String resourceGroupName, String serviceName, String filter, Context context)"
|
|
summary: "Returns a collection of workspaces."
|
|
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: "The name of Azure API Center service."
|
|
name: "serviceName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "OData filter parameter."
|
|
name: "filter"
|
|
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<Workspace> list(String resourceGroupName, String serviceName, String filter, Context context)"
|
|
desc: "Returns a collection of workspaces."
|
|
returns:
|
|
description: "the response of a Workspace 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.apicenter.models.Workspace?alt=com.azure.resourcemanager.apicenter.models.Workspace&text=Workspace\" data-throw-if-not-resolved=\"False\" />>"
|
|
type: "interface"
|
|
desc: "Resource collection API of Workspaces."
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.apicenter.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-apicenter:1.0.0
|