Api | @azure/arm-apimanagement

Interface representing a Api.

Hierarchy

Implemented by

ApiImpl

Index

Methods

beginCreateOrUpdate

beginCreateOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, parameters: ApiCreateOrUpdateParameter, options?: ApiCreateOrUpdateOptionalParams): Promise<PollerLike<PollOperationState<ApiCreateOrUpdateResponse>, ApiCreateOrUpdateResponse>>

- Defined in operationsInterfaces/api.ts:91
Creates new or updates existing specified API of the API Management service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: ApiCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<PollerLike<PollOperationState<ApiCreateOrUpdateResponse>, ApiCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

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

- Defined in operationsInterfaces/api.ts:112
Creates new or updates existing specified API of the API Management service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: ApiCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ApiCreateOrUpdateResponse>

delete

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

- Defined in operationsInterfaces/api.ts:148
Deletes the specified API of the API Management service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: ApiDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

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

- Defined in operationsInterfaces/api.ts:76
Gets the details of the API specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: ApiGetOptionalParams
  
  The options parameters.
Returns Promise<ApiGetResponse>

getEntityTag

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

- Defined in operationsInterfaces/api.ts:62
Gets the entity state (Etag) version of the API specified by its identifier.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: ApiGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<ApiGetEntityTagResponse>

listByService

listByService(resourceGroupName: string, serviceName: string, options?: ApiListByServiceOptionalParams): PagedAsyncIterableIterator<ApiContract>

- Defined in operationsInterfaces/api.ts:38
Lists all APIs of the API Management service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: ApiListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ApiContract>

listByTags

listByTags(resourceGroupName: string, serviceName: string, options?: ApiListByTagsOptionalParams): PagedAsyncIterableIterator<TagResourceContract>

- Defined in operationsInterfaces/api.ts:49
Lists a collection of apis associated with tags.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- Optional options: ApiListByTagsOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<TagResourceContract>

update

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

- Defined in operationsInterfaces/api.ts:130
Updates the specified API of the API Management service instance.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- 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.
- Optional options: ApiUpdateOptionalParams
  
  The options parameters.
Returns Promise<ApiUpdateResponse>

Hierarchy

Implemented by

Index

Methods

Methods

beginCreateOrUpdate

Parameters

resourceGroupName: string

serviceName: string

apiId: string

parameters: ApiCreateOrUpdateParameter

Optional options: ApiCreateOrUpdateOptionalParams

Returns Promise<PollerLike<PollOperationState<ApiCreateOrUpdateResponse>, ApiCreateOrUpdateResponse>>

beginCreateOrUpdateAndWait

Parameters

resourceGroupName: string

serviceName: string

apiId: string

parameters: ApiCreateOrUpdateParameter

Optional options: ApiCreateOrUpdateOptionalParams

Returns Promise<ApiCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

apiId: string

ifMatch: string

Optional options: ApiDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

apiId: string

Optional options: ApiGetOptionalParams

Returns Promise<ApiGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

apiId: string

Optional options: ApiGetEntityTagOptionalParams

Returns Promise<ApiGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

Optional options: ApiListByServiceOptionalParams

Returns PagedAsyncIterableIterator<ApiContract>

listByTags

Parameters

resourceGroupName: string

serviceName: string

Optional options: ApiListByTagsOptionalParams

Returns PagedAsyncIterableIterator<TagResourceContract>

update

Parameters

resourceGroupName: string

serviceName: string

apiId: string

ifMatch: string

parameters: ApiUpdateContract

Optional options: ApiUpdateOptionalParams

Returns Promise<ApiUpdateResponse>