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

324 строки
23 KiB
YAML

### YamlMime:JavaType
uid: "com.azure.resourcemanager.apicenter.models.Deployments"
fullName: "com.azure.resourcemanager.apicenter.models.Deployments"
name: "Deployments"
nameWithType: "Deployments"
summary: "Resource collection API of Deployments."
syntax: "public interface **Deployments**"
methods:
- uid: "com.azure.resourcemanager.apicenter.models.Deployments.define(java.lang.String)"
fullName: "com.azure.resourcemanager.apicenter.models.Deployments.define(String name)"
name: "define(String name)"
nameWithType: "Deployments.define(String name)"
summary: "Begins definition for a new Deployment 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 Deployment.DefinitionStages.Blank define(String name)"
desc: "Begins definition for a new Deployment resource."
returns:
description: "the first stage of the new Deployment definition."
type: "<xref href=\"com.azure.resourcemanager.apicenter.models.Deployment.DefinitionStages.Blank?alt=com.azure.resourcemanager.apicenter.models.Deployment.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apicenter.models.Deployments.delete(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.apicenter.models.Deployments.delete(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName)"
name: "delete(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName)"
nameWithType: "Deployments.delete(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName)"
summary: "Deletes API deployment."
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 name of the API."
name: "apiName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the API deployment."
name: "deploymentName"
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, String apiName, String deploymentName)"
desc: "Deletes API deployment."
- uid: "com.azure.resourcemanager.apicenter.models.Deployments.deleteById(java.lang.String)"
fullName: "com.azure.resourcemanager.apicenter.models.Deployments.deleteById(String id)"
name: "deleteById(String id)"
nameWithType: "Deployments.deleteById(String id)"
summary: "Deletes API deployment."
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 API deployment."
- uid: "com.azure.resourcemanager.apicenter.models.Deployments.deleteByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.apicenter.models.Deployments.deleteByIdWithResponse(String id, Context context)"
name: "deleteByIdWithResponse(String id, Context context)"
nameWithType: "Deployments.deleteByIdWithResponse(String id, Context context)"
summary: "Deletes API deployment."
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 API deployment."
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\" />&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;"
- uid: "com.azure.resourcemanager.apicenter.models.Deployments.deleteWithResponse(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.apicenter.models.Deployments.deleteWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName, Context context)"
name: "deleteWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName, Context context)"
nameWithType: "Deployments.deleteWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName, Context context)"
summary: "Deletes API deployment."
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 name of the API."
name: "apiName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the API deployment."
name: "deploymentName"
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, String apiName, String deploymentName, Context context)"
desc: "Deletes API deployment."
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\" />&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;"
- uid: "com.azure.resourcemanager.apicenter.models.Deployments.get(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.apicenter.models.Deployments.get(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName)"
name: "get(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName)"
nameWithType: "Deployments.get(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName)"
summary: "Returns details of the API deployment."
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 name of the API."
name: "apiName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the API deployment."
name: "deploymentName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract Deployment get(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName)"
desc: "Returns details of the API deployment."
returns:
description: "aPI deployment entity."
type: "<xref href=\"com.azure.resourcemanager.apicenter.models.Deployment?alt=com.azure.resourcemanager.apicenter.models.Deployment&text=Deployment\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apicenter.models.Deployments.getById(java.lang.String)"
fullName: "com.azure.resourcemanager.apicenter.models.Deployments.getById(String id)"
name: "getById(String id)"
nameWithType: "Deployments.getById(String id)"
summary: "Returns details of the API deployment."
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 Deployment getById(String id)"
desc: "Returns details of the API deployment."
returns:
description: "aPI deployment entity."
type: "<xref href=\"com.azure.resourcemanager.apicenter.models.Deployment?alt=com.azure.resourcemanager.apicenter.models.Deployment&text=Deployment\" data-throw-if-not-resolved=\"False\" />"
- uid: "com.azure.resourcemanager.apicenter.models.Deployments.getByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.apicenter.models.Deployments.getByIdWithResponse(String id, Context context)"
name: "getByIdWithResponse(String id, Context context)"
nameWithType: "Deployments.getByIdWithResponse(String id, Context context)"
summary: "Returns details of the API deployment."
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<Deployment> getByIdWithResponse(String id, Context context)"
desc: "Returns details of the API deployment."
returns:
description: "aPI deployment 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\" />&lt;<xref href=\"com.azure.resourcemanager.apicenter.models.Deployment?alt=com.azure.resourcemanager.apicenter.models.Deployment&text=Deployment\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.apicenter.models.Deployments.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.apicenter.models.Deployments.getWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName, Context context)"
name: "getWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName, Context context)"
nameWithType: "Deployments.getWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName, Context context)"
summary: "Returns details of the API deployment."
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 name of the API."
name: "apiName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the API deployment."
name: "deploymentName"
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<Deployment> getWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName, Context context)"
desc: "Returns details of the API deployment."
returns:
description: "aPI deployment 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\" />&lt;<xref href=\"com.azure.resourcemanager.apicenter.models.Deployment?alt=com.azure.resourcemanager.apicenter.models.Deployment&text=Deployment\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.apicenter.models.Deployments.head(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.apicenter.models.Deployments.head(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName)"
name: "head(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName)"
nameWithType: "Deployments.head(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName)"
summary: "Checks if specified API deployment 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 name of the API."
name: "apiName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the API deployment."
name: "deploymentName"
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, String apiName, String deploymentName)"
desc: "Checks if specified API deployment exists."
- uid: "com.azure.resourcemanager.apicenter.models.Deployments.headWithResponse(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.apicenter.models.Deployments.headWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName, Context context)"
name: "headWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName, Context context)"
nameWithType: "Deployments.headWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, String deploymentName, Context context)"
summary: "Checks if specified API deployment 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 name of the API."
name: "apiName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
- description: "The name of the API deployment."
name: "deploymentName"
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, String apiName, String deploymentName, Context context)"
desc: "Checks if specified API deployment 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\" />&lt;<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/Void.html\">Void</a>&gt;"
- uid: "com.azure.resourcemanager.apicenter.models.Deployments.list(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
fullName: "com.azure.resourcemanager.apicenter.models.Deployments.list(String resourceGroupName, String serviceName, String workspaceName, String apiName)"
name: "list(String resourceGroupName, String serviceName, String workspaceName, String apiName)"
nameWithType: "Deployments.list(String resourceGroupName, String serviceName, String workspaceName, String apiName)"
summary: "Returns a collection of API deployments."
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 name of the API."
name: "apiName"
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
syntax: "public abstract PagedIterable<Deployment> list(String resourceGroupName, String serviceName, String workspaceName, String apiName)"
desc: "Returns a collection of API deployments."
returns:
description: "the response of a Deployment 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.apicenter.models.Deployment?alt=com.azure.resourcemanager.apicenter.models.Deployment&text=Deployment\" data-throw-if-not-resolved=\"False\" />&gt;"
- uid: "com.azure.resourcemanager.apicenter.models.Deployments.list(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
fullName: "com.azure.resourcemanager.apicenter.models.Deployments.list(String resourceGroupName, String serviceName, String workspaceName, String apiName, String filter, Context context)"
name: "list(String resourceGroupName, String serviceName, String workspaceName, String apiName, String filter, Context context)"
nameWithType: "Deployments.list(String resourceGroupName, String serviceName, String workspaceName, String apiName, String filter, Context context)"
summary: "Returns a collection of API deployments."
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 name of the API."
name: "apiName"
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<Deployment> list(String resourceGroupName, String serviceName, String workspaceName, String apiName, String filter, Context context)"
desc: "Returns a collection of API deployments."
returns:
description: "the response of a Deployment 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.apicenter.models.Deployment?alt=com.azure.resourcemanager.apicenter.models.Deployment&text=Deployment\" data-throw-if-not-resolved=\"False\" />&gt;"
type: "interface"
desc: "Resource collection API of Deployments."
metadata: {}
package: "com.azure.resourcemanager.apicenter.models"
artifact: com.azure.resourcemanager:azure-resourcemanager-apicenter:1.0.0