Share via

Api interface

  • Reference
Package:
@azure/arm-apimanagement

Interface representing a Api.

Methods

beginCreateOrUpdate(string, string, string, ApiCreateOrUpdateParameter, ApiCreateOrUpdateOptionalParams)

Creates new or updates existing specified API of the API Management service instance.
beginCreateOrUpdateAndWait(string, string, string, ApiCreateOrUpdateParameter, ApiCreateOrUpdateOptionalParams)

Creates new or updates existing specified API of the API Management service instance.
delete(string, string, string, string, ApiDeleteOptionalParams)

Deletes the specified API of the API Management service instance.
get(string, string, string, ApiGetOptionalParams)

Gets the details of the API specified by its identifier.
getEntityTag(string, string, string, ApiGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the API specified by its identifier.
listByService(string, string, ApiListByServiceOptionalParams)

Lists all APIs of the API Management service instance.
listByTags(string, string, ApiListByTagsOptionalParams)

Lists a collection of apis associated with tags.
update(string, string, string, string, ApiUpdateContract, ApiUpdateOptionalParams)

Updates the specified API of the API Management service instance.

Method Details

beginCreateOrUpdate(string, string, string, ApiCreateOrUpdateParameter, ApiCreateOrUpdateOptionalParams)

Creates new or updates existing specified API of the API Management service instance.

function beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: ApiCreateOrUpdateOptionalParams): Promise<SimplePollerLike<OperationState<ApiCreateOrUpdateResponse>, ApiCreateOrUpdateResponse>>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

parameters
ApiCreateOrUpdateParameter

Create or update parameters.

options
ApiCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<@azure/core-lro.SimplePollerLike<OperationState<ApiCreateOrUpdateResponse>, ApiCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait(string, string, string, ApiCreateOrUpdateParameter, ApiCreateOrUpdateOptionalParams)

Creates new or updates existing specified API of the API Management service instance.

function beginCreateOrUpdateAndWait(resourceGroupName: string, serviceName: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: ApiCreateOrUpdateOptionalParams): Promise<ApiCreateOrUpdateResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

parameters
ApiCreateOrUpdateParameter

Create or update parameters.

options
ApiCreateOrUpdateOptionalParams

The options parameters.

Returns

Promise<ApiCreateOrUpdateResponse>

delete(string, string, string, string, ApiDeleteOptionalParams)

Deletes the specified API of the API Management service instance.

function delete(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, options?: ApiDeleteOptionalParams): Promise<void>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

ifMatch

string

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

options
ApiDeleteOptionalParams

The options parameters.

Returns

Promise<void>

get(string, string, string, ApiGetOptionalParams)

Gets the details of the API specified by its identifier.

function get(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiGetOptionalParams): Promise<ApiGetResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

options
ApiGetOptionalParams

The options parameters.

Returns

Promise<ApiGetResponse>

getEntityTag(string, string, string, ApiGetEntityTagOptionalParams)

Gets the entity state (Etag) version of the API specified by its identifier.

function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiGetEntityTagOptionalParams): Promise<ApiGetEntityTagHeaders>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

options
ApiGetEntityTagOptionalParams

The options parameters.

Returns

Promise<ApiGetEntityTagHeaders>

listByService(string, string, ApiListByServiceOptionalParams)

Lists all APIs of the API Management service instance.

function listByService(resourceGroupName: string, serviceName: string, options?: ApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

options
ApiListByServiceOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<ApiContract, ApiContract[], PageSettings>

listByTags(string, string, ApiListByTagsOptionalParams)

Lists a collection of apis associated with tags.

function listByTags(resourceGroupName: string, serviceName: string, options?: ApiListByTagsOptionalParams): PagedAsyncIterableIterator<TagResourceContract, TagResourceContract[], PageSettings>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

options
ApiListByTagsOptionalParams

The options parameters.

Returns

PagedAsyncIterableIterator<TagResourceContract, TagResourceContract[], PageSettings>

update(string, string, string, string, ApiUpdateContract, ApiUpdateOptionalParams)

Updates the specified API of the API Management service instance.

function update(resourceGroupName: string, serviceName: string, apiId: string, ifMatch: string, parameters: ApiUpdateContract, options?: ApiUpdateOptionalParams): Promise<ApiUpdateResponse>

Parameters

resourceGroupName

string

The name of the resource group. The name is case insensitive.

serviceName

string

The name of the API Management service.

apiId

string

API revision identifier. Must be unique in the current API Management service instance. Non-current revision has ;rev=n as a suffix where n is the revision number.

ifMatch

string

ETag of the Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

parameters
ApiUpdateContract

API Update Contract parameters.

options
ApiUpdateOptionalParams

The options parameters.

Returns

Promise<ApiUpdateResponse>