Api Release - Update

Updates the details of the release of the API specified by its identifier.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/releases/{releaseId}?api-version=2019-01-01

URI Parameters

Name In Required Type Description
subscriptionId
path True
  • string

Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

resourceGroupName
path True
  • string

The name of the resource group.

serviceName
path True
  • string

The name of the API Management service.

Regex pattern: ^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$

apiId
path True
  • string

API identifier. Must be unique in the current API Management service instance.

releaseId
path True
  • string

Release identifier within an API. Must be unique in the current API Management service instance.

Regex pattern: ^[^*#&+:<>?]+$

api-version
query True
  • string

Version of the API to be used with the client request.

Request Header

Name Required Type Description
If-Match True
  • 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.

Request Body

Name Type Description
properties.apiId
  • string

Identifier of the API the release belongs to.

properties.notes
  • string

Release Notes

Responses

Name Type Description
204 No Content

Release successfully updated

Other Status Codes

Error response describing why the operation failed.

Security

azure_auth

Azure Active Directory OAuth2 Flow.

Type: oauth2
Flow: implicit
Authorization URL: https://login.microsoftonline.com/common/oauth2/authorize

Scopes

Name Description
user_impersonation impersonate your user account

Examples

ApiManagementUpdateApiRelease

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1/releases/testrev?api-version=2019-01-01
If-Match: *
{
  "properties": {
    "apiId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/a1",
    "notes": "yahooagain"
  }
}

Sample Response

Definitions

ApiReleaseContract

ApiRelease details.

ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

ApiReleaseContract

ApiRelease details.

Name Type Description
id
  • string

Resource ID.

name
  • string

Resource name.

properties.apiId
  • string

Identifier of the API the release belongs to.

properties.createdDateTime
  • string

The time the API was released. The date conforms to the following format: yyyy-MM-ddTHH:mm:ssZ as specified by the ISO 8601 standard.

properties.notes
  • string

Release Notes

properties.updatedDateTime
  • string

The time the API release was updated.

type
  • string

Resource type for API Management resource.

ErrorFieldContract

Error Field contract.

Name Type Description
code
  • string

Property level error code.

message
  • string

Human-readable representation of property-level error.

target
  • string

Property name.

ErrorResponse

Error Response.

Name Type Description
error.code
  • string

Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response.

error.details

The list of invalid fields send in request, in case of validation error.

error.message
  • string

Human-readable representation of the error.