ApiRelease interface
Interface representing a ApiRelease.
Methods
| create |
Creates a new Release for the API. |
| delete(string, string, string, string, string, Api |
Deletes the specified release in the API. |
| get(string, string, string, string, Api |
Returns the details of an API release. |
| get |
Returns the etag of an API release. |
| list |
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. |
| update(string, string, string, string, string, Api |
Updates the details of the release of the API specified by its identifier. |
Method Details
createOrUpdate(string, string, string, string, ApiReleaseContract, ApiReleaseCreateOrUpdateOptionalParams)
Creates a new Release for the API.
function createOrUpdate(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, parameters: ApiReleaseContract, options?: ApiReleaseCreateOrUpdateOptionalParams): Promise<ApiReleaseCreateOrUpdateResponse>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 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.
The options parameters.
Returns
Promise<ApiReleaseCreateOrUpdateResponse>
delete(string, string, string, string, string, ApiReleaseDeleteOptionalParams)
Deletes the specified release in the API.
function delete(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, ifMatch: string, options?: ApiReleaseDeleteOptionalParams): 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 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.
- options
- ApiReleaseDeleteOptionalParams
The options parameters.
Returns
Promise<void>
get(string, string, string, string, ApiReleaseGetOptionalParams)
Returns the details of an API release.
function get(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetOptionalParams): Promise<ApiReleaseGetResponse>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 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.
- options
- ApiReleaseGetOptionalParams
The options parameters.
Returns
Promise<ApiReleaseGetResponse>
getEntityTag(string, string, string, string, ApiReleaseGetEntityTagOptionalParams)
Returns the etag of an API release.
function getEntityTag(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, options?: ApiReleaseGetEntityTagOptionalParams): Promise<ApiReleaseGetEntityTagHeaders>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 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.
The options parameters.
Returns
Promise<ApiReleaseGetEntityTagHeaders>
listByService(string, string, string, ApiReleaseListByServiceOptionalParams)
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.
function listByService(resourceGroupName: string, serviceName: string, apiId: string, options?: ApiReleaseListByServiceOptionalParams): PagedAsyncIterableIterator<ApiReleaseContract, ApiReleaseContract[], PageSettings>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 identifier. Must be unique in the current API Management service instance.
The options parameters.
Returns
update(string, string, string, string, string, ApiReleaseContract, ApiReleaseUpdateOptionalParams)
Updates the details of the release of the API specified by its identifier.
function update(resourceGroupName: string, serviceName: string, apiId: string, releaseId: string, ifMatch: string, parameters: ApiReleaseContract, options?: ApiReleaseUpdateOptionalParams): Promise<ApiReleaseUpdateResponse>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 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.
- options
- ApiReleaseUpdateOptionalParams
The options parameters.
Returns
Promise<ApiReleaseUpdateResponse>