276 строки
20 KiB
YAML
276 строки
20 KiB
YAML
### YamlMime:JavaType
|
|
uid: "com.azure.resourcemanager.apicenter.fluent.ApisClient"
|
|
fullName: "com.azure.resourcemanager.apicenter.fluent.ApisClient"
|
|
name: "ApisClient"
|
|
nameWithType: "ApisClient"
|
|
summary: "An instance of this class provides access to all the operations defined in Apis<wbr>Client."
|
|
syntax: "public interface **ApisClient**"
|
|
methods:
|
|
- uid: "com.azure.resourcemanager.apicenter.fluent.ApisClient.createOrUpdate(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.apicenter.fluent.models.ApiInner)"
|
|
fullName: "com.azure.resourcemanager.apicenter.fluent.ApisClient.createOrUpdate(String resourceGroupName, String serviceName, String workspaceName, String apiName, ApiInner resource)"
|
|
name: "createOrUpdate(String resourceGroupName, String serviceName, String workspaceName, String apiName, ApiInner resource)"
|
|
nameWithType: "ApisClient.createOrUpdate(String resourceGroupName, String serviceName, String workspaceName, String apiName, ApiInner resource)"
|
|
summary: "Creates new or updates existing API."
|
|
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: "Resource create parameters."
|
|
name: "resource"
|
|
type: "<xref href=\"com.azure.resourcemanager.apicenter.fluent.models.ApiInner?alt=com.azure.resourcemanager.apicenter.fluent.models.ApiInner&text=ApiInner\" data-throw-if-not-resolved=\"False\" />"
|
|
syntax: "public abstract ApiInner createOrUpdate(String resourceGroupName, String serviceName, String workspaceName, String apiName, ApiInner resource)"
|
|
desc: "Creates new or updates existing API."
|
|
returns:
|
|
description: "aPI entity."
|
|
type: "<xref href=\"com.azure.resourcemanager.apicenter.fluent.models.ApiInner?alt=com.azure.resourcemanager.apicenter.fluent.models.ApiInner&text=ApiInner\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.apicenter.fluent.ApisClient.createOrUpdateWithResponse(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.resourcemanager.apicenter.fluent.models.ApiInner,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.apicenter.fluent.ApisClient.createOrUpdateWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, ApiInner resource, Context context)"
|
|
name: "createOrUpdateWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, ApiInner resource, Context context)"
|
|
nameWithType: "ApisClient.createOrUpdateWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, ApiInner resource, Context context)"
|
|
summary: "Creates new or updates existing API."
|
|
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: "Resource create parameters."
|
|
name: "resource"
|
|
type: "<xref href=\"com.azure.resourcemanager.apicenter.fluent.models.ApiInner?alt=com.azure.resourcemanager.apicenter.fluent.models.ApiInner&text=ApiInner\" 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 ApisCreateOrUpdateResponse createOrUpdateWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, ApiInner resource, Context context)"
|
|
desc: "Creates new or updates existing API."
|
|
returns:
|
|
description: "aPI entity."
|
|
type: "<xref href=\"com.azure.resourcemanager.apicenter.models.ApisCreateOrUpdateResponse?alt=com.azure.resourcemanager.apicenter.models.ApisCreateOrUpdateResponse&text=ApisCreateOrUpdateResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.apicenter.fluent.ApisClient.delete(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.apicenter.fluent.ApisClient.delete(String resourceGroupName, String serviceName, String workspaceName, String apiName)"
|
|
name: "delete(String resourceGroupName, String serviceName, String workspaceName, String apiName)"
|
|
nameWithType: "ApisClient.delete(String resourceGroupName, String serviceName, String workspaceName, String apiName)"
|
|
summary: "Deletes specified API."
|
|
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 void delete(String resourceGroupName, String serviceName, String workspaceName, String apiName)"
|
|
desc: "Deletes specified API."
|
|
- uid: "com.azure.resourcemanager.apicenter.fluent.ApisClient.deleteWithResponse(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.apicenter.fluent.ApisClient.deleteWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, Context context)"
|
|
name: "deleteWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, Context context)"
|
|
nameWithType: "ApisClient.deleteWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, Context context)"
|
|
summary: "Deletes specified API."
|
|
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 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, Context context)"
|
|
desc: "Deletes specified API."
|
|
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.fluent.ApisClient.get(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.apicenter.fluent.ApisClient.get(String resourceGroupName, String serviceName, String workspaceName, String apiName)"
|
|
name: "get(String resourceGroupName, String serviceName, String workspaceName, String apiName)"
|
|
nameWithType: "ApisClient.get(String resourceGroupName, String serviceName, String workspaceName, String apiName)"
|
|
summary: "Returns details of the API."
|
|
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 ApiInner get(String resourceGroupName, String serviceName, String workspaceName, String apiName)"
|
|
desc: "Returns details of the API."
|
|
returns:
|
|
description: "aPI entity."
|
|
type: "<xref href=\"com.azure.resourcemanager.apicenter.fluent.models.ApiInner?alt=com.azure.resourcemanager.apicenter.fluent.models.ApiInner&text=ApiInner\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.apicenter.fluent.ApisClient.getWithResponse(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.apicenter.fluent.ApisClient.getWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, Context context)"
|
|
name: "getWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, Context context)"
|
|
nameWithType: "ApisClient.getWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, Context context)"
|
|
summary: "Returns details of the API."
|
|
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 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 ApisGetResponse getWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, Context context)"
|
|
desc: "Returns details of the API."
|
|
returns:
|
|
description: "aPI entity."
|
|
type: "<xref href=\"com.azure.resourcemanager.apicenter.models.ApisGetResponse?alt=com.azure.resourcemanager.apicenter.models.ApisGetResponse&text=ApisGetResponse\" data-throw-if-not-resolved=\"False\" />"
|
|
- uid: "com.azure.resourcemanager.apicenter.fluent.ApisClient.head(java.lang.String,java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.apicenter.fluent.ApisClient.head(String resourceGroupName, String serviceName, String workspaceName, String apiName)"
|
|
name: "head(String resourceGroupName, String serviceName, String workspaceName, String apiName)"
|
|
nameWithType: "ApisClient.head(String resourceGroupName, String serviceName, String workspaceName, String apiName)"
|
|
summary: "Checks if specified API 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>"
|
|
syntax: "public abstract void head(String resourceGroupName, String serviceName, String workspaceName, String apiName)"
|
|
desc: "Checks if specified API exists."
|
|
- uid: "com.azure.resourcemanager.apicenter.fluent.ApisClient.headWithResponse(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.apicenter.fluent.ApisClient.headWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, Context context)"
|
|
name: "headWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, Context context)"
|
|
nameWithType: "ApisClient.headWithResponse(String resourceGroupName, String serviceName, String workspaceName, String apiName, Context context)"
|
|
summary: "Checks if specified API 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 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, Context context)"
|
|
desc: "Checks if specified API 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.fluent.ApisClient.list(java.lang.String,java.lang.String,java.lang.String)"
|
|
fullName: "com.azure.resourcemanager.apicenter.fluent.ApisClient.list(String resourceGroupName, String serviceName, String workspaceName)"
|
|
name: "list(String resourceGroupName, String serviceName, String workspaceName)"
|
|
nameWithType: "ApisClient.list(String resourceGroupName, String serviceName, String workspaceName)"
|
|
summary: "Returns a collection of APIs."
|
|
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 PagedIterable<ApiInner> list(String resourceGroupName, String serviceName, String workspaceName)"
|
|
desc: "Returns a collection of APIs."
|
|
returns:
|
|
description: "the response of a Api 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.fluent.models.ApiInner?alt=com.azure.resourcemanager.apicenter.fluent.models.ApiInner&text=ApiInner\" data-throw-if-not-resolved=\"False\" />>"
|
|
- uid: "com.azure.resourcemanager.apicenter.fluent.ApisClient.list(java.lang.String,java.lang.String,java.lang.String,java.lang.String,com.azure.core.util.Context)"
|
|
fullName: "com.azure.resourcemanager.apicenter.fluent.ApisClient.list(String resourceGroupName, String serviceName, String workspaceName, String filter, Context context)"
|
|
name: "list(String resourceGroupName, String serviceName, String workspaceName, String filter, Context context)"
|
|
nameWithType: "ApisClient.list(String resourceGroupName, String serviceName, String workspaceName, String filter, Context context)"
|
|
summary: "Returns a collection of APIs."
|
|
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: "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<ApiInner> list(String resourceGroupName, String serviceName, String workspaceName, String filter, Context context)"
|
|
desc: "Returns a collection of APIs."
|
|
returns:
|
|
description: "the response of a Api 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.fluent.models.ApiInner?alt=com.azure.resourcemanager.apicenter.fluent.models.ApiInner&text=ApiInner\" data-throw-if-not-resolved=\"False\" />>"
|
|
type: "interface"
|
|
desc: "An instance of this class provides access to all the operations defined in ApisClient."
|
|
metadata: {}
|
|
package: "com.azure.resourcemanager.apicenter.fluent"
|
|
artifact: com.azure.resourcemanager:azure-resourcemanager-apicenter:1.0.0
|