Apis interface
Interface representing a Apis.
Methods
| create |
Creates new or updates existing API. |
| delete(string, string, string, string, Apis |
Deletes specified API. |
| get(string, string, string, string, Apis |
Returns details of the API. |
| head(string, string, string, string, Apis |
Checks if specified API exists. |
| list(string, string, string, Apis |
Returns a collection of APIs. |
Method Details
createOrUpdate(string, string, string, string, Api, ApisCreateOrUpdateOptionalParams)
Creates new or updates existing API.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, resource: Api, options?: ApisCreateOrUpdateOptionalParams): Promise<ApisCreateOrUpdateResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of Azure API Center service.
- workspaceName
-
string
The name of the workspace.
- apiName
-
string
The name of the API.
- resource
- Api
Resource create parameters.
- options
- ApisCreateOrUpdateOptionalParams
The options parameters.
Returns
Promise<ApisCreateOrUpdateResponse>
delete(string, string, string, string, ApisDeleteOptionalParams)
Deletes specified API.
function delete(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, options?: ApisDeleteOptionalParams): Promise<void>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of Azure API Center service.
- workspaceName
-
string
The name of the workspace.
- apiName
-
string
The name of the API.
- options
- ApisDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, string, ApisGetOptionalParams)
Returns details of the API.
function get(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, options?: ApisGetOptionalParams): Promise<ApisGetResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of Azure API Center service.
- workspaceName
-
string
The name of the workspace.
- apiName
-
string
The name of the API.
- options
- ApisGetOptionalParams
The options parameters.
Returns
Promise<ApisGetResponse>
head(string, string, string, string, ApisHeadOptionalParams)
Checks if specified API exists.
function head(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, options?: ApisHeadOptionalParams): Promise<ApisHeadResponse>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of Azure API Center service.
- workspaceName
-
string
The name of the workspace.
- apiName
-
string
The name of the API.
- options
- ApisHeadOptionalParams
The options parameters.
Returns
Promise<ApisHeadResponse>
list(string, string, string, ApisListOptionalParams)
Returns a collection of APIs.
function list(resourceGroupName: string, serviceName: string, workspaceName: string, options?: ApisListOptionalParams): PagedAsyncIterableIterator<Api, Api[], PageSettings>Parameters
- resourceGroupName
-
string
The name of the resource group. The name is case insensitive.
- serviceName
-
string
The name of Azure API Center service.
- workspaceName
-
string
The name of the workspace.
- options
- ApisListOptionalParams
The options parameters.