478 строки
36 KiB
YAML
478 строки
36 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.apicenter.models.ApiDefinitions"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.ApiDefinitions"
|
|
name: "ApiDefinitions"
|
|
nameWithType: "ApiDefinitions"
|
|
summary: "Resource collection API of Api<wbr>Definitions."
|
|
syntax: "public interface **ApiDefinitions**"
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.define(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.define(String name)"
|
|
name: "define(String name)"
|
|
nameWithType: "ApiDefinitions.define(String name)"
|
|
summary: "Begins definition for a new Api<wbr>Definition 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 ApiDefinition.DefinitionStages.Blank define(String name)"
|
|
desc: "Begins definition for a new ApiDefinition resource."
|
|
returns:
|
|
description: "the first stage of the new ApiDefinition definition."
|
|
type: "<xref href=\"com.azure.resourcemanager.apicenter.models.ApiDefinition.DefinitionStages.Blank?alt=com.azure.resourcemanager.apicenter.models.ApiDefinition.DefinitionStages.Blank&text=Blank\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.delete(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.delete(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName)"
|
|
name: "delete(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName)"
|
|
nameWithType: "ApiDefinitions.delete(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName)"
|
|
summary: "Deletes specified API definition."
|
|
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 version."
|
|
name: "versionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the API definition."
|
|
name: "definitionName"
|
|
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 versionName, String definitionName)"
|
|
desc: "Deletes specified API definition."
|
|
- uid: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.deleteById(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.deleteById(String id)"
|
|
name: "deleteById(String id)"
|
|
nameWithType: "ApiDefinitions.deleteById(String id)"
|
|
summary: "Deletes specified API definition."
|
|
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 API definition."
|
|
- uid: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.deleteByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.deleteByIdWithResponse(String id, Context context)"
|
|
name: "deleteByIdWithResponse(String id, Context context)"
|
|
nameWithType: "ApiDefinitions.deleteByIdWithResponse(String id, Context context)"
|
|
summary: "Deletes specified API definition."
|
|
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 API definition."
|
|
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.ApiDefinitions.deleteWithResponse(java.lang.String,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.ApiDefinitions.deleteWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, Context context)"
|
|
name: "deleteWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, Context context)"
|
|
nameWithType: "ApiDefinitions.deleteWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, Context context)"
|
|
summary: "Deletes specified API definition."
|
|
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 version."
|
|
name: "versionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the API definition."
|
|
name: "definitionName"
|
|
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 versionName, String definitionName, Context context)"
|
|
desc: "Deletes specified API definition."
|
|
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.ApiDefinitions.exportSpecification(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.exportSpecification(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName)"
|
|
name: "exportSpecification(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName)"
|
|
nameWithType: "ApiDefinitions.exportSpecification(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName)"
|
|
summary: "Exports the API specification."
|
|
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 version."
|
|
name: "versionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the API definition."
|
|
name: "definitionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract ApiSpecExportResult exportSpecification(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName)"
|
|
desc: "Exports the API specification."
|
|
returns:
|
|
description: "the API specification export result."
|
|
type: "<xref href=\"com.azure.resourcemanager.apicenter.models.ApiSpecExportResult?alt=com.azure.resourcemanager.apicenter.models.ApiSpecExportResult&text=ApiSpecExportResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.exportSpecification(java.lang.String,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.ApiDefinitions.exportSpecification(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, Context context)"
|
|
name: "exportSpecification(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, Context context)"
|
|
nameWithType: "ApiDefinitions.exportSpecification(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, Context context)"
|
|
summary: "Exports the API specification."
|
|
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 version."
|
|
name: "versionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the API definition."
|
|
name: "definitionName"
|
|
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 ApiSpecExportResult exportSpecification(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, Context context)"
|
|
desc: "Exports the API specification."
|
|
returns:
|
|
description: "the API specification export result."
|
|
type: "<xref href=\"com.azure.resourcemanager.apicenter.models.ApiSpecExportResult?alt=com.azure.resourcemanager.apicenter.models.ApiSpecExportResult&text=ApiSpecExportResult\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.get(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.get(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName)"
|
|
name: "get(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName)"
|
|
nameWithType: "ApiDefinitions.get(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName)"
|
|
summary: "Returns details of the API definition."
|
|
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 version."
|
|
name: "versionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the API definition."
|
|
name: "definitionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract ApiDefinition get(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName)"
|
|
desc: "Returns details of the API definition."
|
|
returns:
|
|
description: "aPI definition entity."
|
|
type: "<xref href=\"com.azure.resourcemanager.apicenter.models.ApiDefinition?alt=com.azure.resourcemanager.apicenter.models.ApiDefinition&text=ApiDefinition\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.getById(java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.getById(String id)"
|
|
name: "getById(String id)"
|
|
nameWithType: "ApiDefinitions.getById(String id)"
|
|
summary: "Returns details of the API definition."
|
|
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 ApiDefinition getById(String id)"
|
|
desc: "Returns details of the API definition."
|
|
returns:
|
|
description: "aPI definition entity."
|
|
type: "<xref href=\"com.azure.resourcemanager.apicenter.models.ApiDefinition?alt=com.azure.resourcemanager.apicenter.models.ApiDefinition&text=ApiDefinition\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.getByIdWithResponse(java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.getByIdWithResponse(String id, Context context)"
|
|
name: "getByIdWithResponse(String id, Context context)"
|
|
nameWithType: "ApiDefinitions.getByIdWithResponse(String id, Context context)"
|
|
summary: "Returns details of the API definition."
|
|
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<ApiDefinition> getByIdWithResponse(String id, Context context)"
|
|
desc: "Returns details of the API definition."
|
|
returns:
|
|
description: "aPI definition 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.ApiDefinition?alt=com.azure.resourcemanager.apicenter.models.ApiDefinition&text=ApiDefinition\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.getWithResponse(java.lang.String,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.ApiDefinitions.getWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, Context context)"
|
|
name: "getWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, Context context)"
|
|
nameWithType: "ApiDefinitions.getWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, Context context)"
|
|
summary: "Returns details of the API definition."
|
|
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 version."
|
|
name: "versionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the API definition."
|
|
name: "definitionName"
|
|
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<ApiDefinition> getWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, Context context)"
|
|
desc: "Returns details of the API definition."
|
|
returns:
|
|
description: "aPI definition 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.ApiDefinition?alt=com.azure.resourcemanager.apicenter.models.ApiDefinition&text=ApiDefinition\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.head(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.head(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName)"
|
|
name: "head(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName)"
|
|
nameWithType: "ApiDefinitions.head(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName)"
|
|
summary: "Checks if specified API definition 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 version."
|
|
name: "versionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the API definition."
|
|
name: "definitionName"
|
|
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 versionName, String definitionName)"
|
|
desc: "Checks if specified API definition exists."
|
|
- uid: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.headWithResponse(java.lang.String,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.ApiDefinitions.headWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, Context context)"
|
|
name: "headWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, Context context)"
|
|
nameWithType: "ApiDefinitions.headWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, Context context)"
|
|
summary: "Checks if specified API definition 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 version."
|
|
name: "versionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the API definition."
|
|
name: "definitionName"
|
|
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 versionName, String definitionName, Context context)"
|
|
desc: "Checks if specified API definition 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.ApiDefinitions.importSpecification(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.apicenter.models.ApiSpecImportRequest)"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.importSpecification(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, ApiSpecImportRequest body)"
|
|
name: "importSpecification(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, ApiSpecImportRequest body)"
|
|
nameWithType: "ApiDefinitions.importSpecification(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, ApiSpecImportRequest body)"
|
|
summary: "Imports the API specification."
|
|
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 version."
|
|
name: "versionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the API definition."
|
|
name: "definitionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The content of the action request."
|
|
name: "body"
|
|
type: "<xref href=\"com.azure.resourcemanager.apicenter.models.ApiSpecImportRequest?alt=com.azure.resourcemanager.apicenter.models.ApiSpecImportRequest&text=ApiSpecImportRequest\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract void importSpecification(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, ApiSpecImportRequest body)"
|
|
desc: "Imports the API specification."
|
|
- uid: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.importSpecification(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.apicenter.models.ApiSpecImportRequest,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.importSpecification(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, ApiSpecImportRequest body, Context context)"
|
|
name: "importSpecification(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, ApiSpecImportRequest body, Context context)"
|
|
nameWithType: "ApiDefinitions.importSpecification(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, ApiSpecImportRequest body, Context context)"
|
|
summary: "Imports the API specification."
|
|
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 version."
|
|
name: "versionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The name of the API definition."
|
|
name: "definitionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
- description: "The content of the action request."
|
|
name: "body"
|
|
type: "<xref href=\"com.azure.resourcemanager.apicenter.models.ApiSpecImportRequest?alt=com.azure.resourcemanager.apicenter.models.ApiSpecImportRequest&text=ApiSpecImportRequest\" 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 void importSpecification(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String definitionName, ApiSpecImportRequest body, Context context)"
|
|
desc: "Imports the API specification."
|
|
- uid: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.list(java.lang.String,java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.list(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName)"
|
|
name: "list(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName)"
|
|
nameWithType: "ApiDefinitions.list(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName)"
|
|
summary: "Returns a collection of API definitions."
|
|
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 version."
|
|
name: "versionName"
|
|
type: "<a href=\"https://docs.oracle.com/javase/8/docs/api/java/lang/String.html\">String</a>"
|
|
syntax: "public abstract PagedIterable<ApiDefinition> list(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName)"
|
|
desc: "Returns a collection of API definitions."
|
|
returns:
|
|
description: "the response of a ApiDefinition 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.ApiDefinition?alt=com.azure.resourcemanager.apicenter.models.ApiDefinition&text=ApiDefinition\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.apicenter.models.ApiDefinitions.list(java.lang.String,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.ApiDefinitions.list(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String filter, Context context)"
|
|
name: "list(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String filter, Context context)"
|
|
nameWithType: "ApiDefinitions.list(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String filter, Context context)"
|
|
summary: "Returns a collection of API definitions."
|
|
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 version."
|
|
name: "versionName"
|
|
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<ApiDefinition> list(String resourceGroupName, String serviceName, String workspaceName, String apiName, String versionName, String filter, Context context)"
|
|
desc: "Returns a collection of API definitions."
|
|
returns:
|
|
description: "the response of a ApiDefinition 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.ApiDefinition?alt=com.azure.resourcemanager.apicenter.models.ApiDefinition&text=ApiDefinition\" data-throw-if-not-resolved=\"False\" />>"
|
|
type: "interface"
|
|
desc: "Resource collection API of ApiDefinitions."
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.apicenter.models"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-apicenter:1.0.0
|