ApiVersions interface
Interface representing a ApiVersions.
Methods
| create |
Creates new or updates existing API version. |
| delete(string, string, string, string, string, Api |
Deletes specified API version |
| get(string, string, string, string, string, Api |
Returns details of the API version. |
| head(string, string, string, string, string, Api |
Checks if specified API version exists. |
| list(string, string, string, string, Api |
Returns a collection of API versions. |
Method Details
createOrUpdate(string, string, string, string, string, ApiVersion, ApiVersionsCreateOrUpdateOptionalParams)
Creates new or updates existing API version.
function createOrUpdate(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, resource: ApiVersion, options?: ApiVersionsCreateOrUpdateOptionalParams): Promise<ApiVersionsCreateOrUpdateResponse>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.
- versionName
-
string
The name of the API version.
- resource
- ApiVersion
Resource create parameters.
The options parameters.
Returns
Promise<ApiVersionsCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiVersionsDeleteOptionalParams)
Deletes specified API version
function delete(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, options?: ApiVersionsDeleteOptionalParams): 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.
- versionName
-
string
The name of the API version.
- options
- ApiVersionsDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, string, string, ApiVersionsGetOptionalParams)
Returns details of the API version.
function get(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, options?: ApiVersionsGetOptionalParams): Promise<ApiVersionsGetResponse>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.
- versionName
-
string
The name of the API version.
- options
- ApiVersionsGetOptionalParams
The options parameters.
Returns
Promise<ApiVersionsGetResponse>
head(string, string, string, string, string, ApiVersionsHeadOptionalParams)
Checks if specified API version exists.
function head(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, versionName: string, options?: ApiVersionsHeadOptionalParams): Promise<ApiVersionsHeadResponse>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.
- versionName
-
string
The name of the API version.
- options
- ApiVersionsHeadOptionalParams
The options parameters.
Returns
Promise<ApiVersionsHeadResponse>
list(string, string, string, string, ApiVersionsListOptionalParams)
Returns a collection of API versions.
function list(resourceGroupName: string, serviceName: string, workspaceName: string, apiName: string, options?: ApiVersionsListOptionalParams): PagedAsyncIterableIterator<ApiVersion, ApiVersion[], 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.
- apiName
-
string
The name of the API.
- options
- ApiVersionsListOptionalParams
The options parameters.