ApiReleaseImpl | @azure/arm-apimanagement

Class containing ApiRelease operations.

Hierarchy

ApiReleaseImpl

Implements

ApiRelease

Index

Constructors

constructor

Methods

Constructors

constructor

new ApiReleaseImpl(client: ApiManagementClientContext): ApiReleaseImpl

- Defined in operations/apiRelease.ts:35
Initialize a new instance of the class ApiRelease class.

Parameters
- client: ApiManagementClientContext
  
  Reference to the service client
Returns ApiReleaseImpl

Methods

createOrUpdate

createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, parameters: ApiReleaseContract, options?: ApiReleaseCreateOrUpdateOptionalParams): Promise<ApiReleaseCreateOrUpdateResponse>

Implementation of ApiRelease.createOrUpdate
- Defined in operations/apiRelease.ts:202
Creates a new Release for the API.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- apiId: string
  
  API identifier. Must be unique in the current API Management service instance.
- releaseId: string
  
  Release identifier within an API. Must be unique in the current API Management service instance.
- parameters: ApiReleaseContract
  
  Create parameters.
- Optional options: ApiReleaseCreateOrUpdateOptionalParams
  
  The options parameters.
Returns Promise<ApiReleaseCreateOrUpdateResponse>

delete

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

Implementation of ApiRelease.delete
- Defined in operations/apiRelease.ts:262
Deletes the specified release in the API.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- apiId: string
  
  API identifier. Must be unique in the current API Management service instance.
- releaseId: string
  
  Release identifier within an API. Must be unique in the current API Management service instance.
- 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: ApiReleaseDeleteOptionalParams
  
  The options parameters.
Returns Promise<void>

get

get(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetOptionalParams): Promise<ApiReleaseGetResponse>

Implementation of ApiRelease.get
- Defined in operations/apiRelease.ts:179
Returns the details of an API release.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- apiId: string
  
  API identifier. Must be unique in the current API Management service instance.
- releaseId: string
  
  Release identifier within an API. Must be unique in the current API Management service instance.
- Optional options: ApiReleaseGetOptionalParams
  
  The options parameters.
Returns Promise<ApiReleaseGetResponse>

getEntityTag

getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetEntityTagOptionalParams): Promise<ApiReleaseGetEntityTagResponse>

Implementation of ApiRelease.getEntityTag
- Defined in operations/apiRelease.ts:157
Returns the etag of an API release.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- apiId: string
  
  API identifier. Must be unique in the current API Management service instance.
- releaseId: string
  
  Release identifier within an API. Must be unique in the current API Management service instance.
- Optional options: ApiReleaseGetEntityTagOptionalParams
  
  The options parameters.
Returns Promise<ApiReleaseGetEntityTagResponse>

listByService

listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiReleaseListByServiceOptionalParams): PagedAsyncIterableIterator<ApiReleaseContract>

Implementation of ApiRelease.listByService
- Defined in operations/apiRelease.ts:54
Lists all releases of an API. An API release is created when making an API Revision current. Releases are also used to rollback to previous revisions. Results will be paged and can be constrained by the $top and $skip parameters.

Parameters
- resourceGroupName: string
  
  The name of the resource group.
- serviceName: string
  
  The name of the API Management service.
- apiId: string
  
  API identifier. Must be unique in the current API Management service instance.
- Optional options: ApiReleaseListByServiceOptionalParams
  
  The options parameters.
Returns PagedAsyncIterableIterator<ApiReleaseContract>

update

update(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, ifMatch: string, parameters: ApiReleaseContract, options?: ApiReleaseUpdateOptionalParams): Promise<ApiReleaseUpdateResponse>

Implementation of ApiRelease.update
- Defined in operations/apiRelease.ts:228
Updates the details of the release 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 identifier. Must be unique in the current API Management service instance.
- releaseId: string
  
  Release identifier within an API. Must be unique in the current API Management service instance.
- 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: ApiReleaseContract
  
  API Release Update parameters.
- Optional options: ApiReleaseUpdateOptionalParams
  
  The options parameters.
Returns Promise<ApiReleaseUpdateResponse>

Hierarchy

Implements

Index

Constructors

Methods

Constructors

constructor

Parameters

client: ApiManagementClientContext

Returns ApiReleaseImpl

Methods

createOrUpdate

Parameters

resourceGroupName: string

serviceName: string

apiId: string

releaseId: string

parameters: ApiReleaseContract

Optional options: ApiReleaseCreateOrUpdateOptionalParams

Returns Promise<ApiReleaseCreateOrUpdateResponse>

delete

Parameters

resourceGroupName: string

serviceName: string

apiId: string

releaseId: string

ifMatch: string

Optional options: ApiReleaseDeleteOptionalParams

Returns Promise<void>

get

Parameters

resourceGroupName: string

serviceName: string

apiId: string

releaseId: string

Optional options: ApiReleaseGetOptionalParams

Returns Promise<ApiReleaseGetResponse>

getEntityTag

Parameters

resourceGroupName: string

serviceName: string

apiId: string

releaseId: string

Optional options: ApiReleaseGetEntityTagOptionalParams

Returns Promise<ApiReleaseGetEntityTagResponse>

listByService

Parameters

resourceGroupName: string

serviceName: string

apiId: string

Optional options: ApiReleaseListByServiceOptionalParams

Returns PagedAsyncIterableIterator<ApiReleaseContract>

update

Parameters

resourceGroupName: string

serviceName: string

apiId: string

releaseId: string

ifMatch: string

parameters: ApiReleaseContract

Optional options: ApiReleaseUpdateOptionalParams

Returns Promise<ApiReleaseUpdateResponse>