Api Issue - Update

Updates an existing issue for an API.

PATCH https://management.azure.com/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}?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.

issueId
path True
  • string

Issue identifier. 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

A resource identifier for the API the issue was created for.

properties.createdDate
  • string

Date and time when the issue was created.

properties.description
  • string

Text describing the issue.

properties.state

Status of the issue.

properties.title
  • string

The issue title.

properties.userId
  • string

A resource identifier for the user created the issue.

Responses

Name Type Description
204 No Content

Api issue updated successfully

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

ApiManagementUpdateApiIssue

Sample Request

PATCH https://management.azure.com/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ApiManagement/service/apimService1/apis/57d1f7558aa04f15146d9d8a/issues/57d2ef278aa04f0ad01d6cdc?api-version=2019-01-01
If-Match: *
{
  "properties": {
    "state": "closed"
  }
}

Sample Response

Definitions

ErrorFieldContract

Error Field contract.

ErrorResponse

Error Response.

IssueUpdateContract

Issue update Parameters.

State

Status of the issue.

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.

IssueUpdateContract

Issue update Parameters.

Name Type Description
properties.apiId
  • string

A resource identifier for the API the issue was created for.

properties.createdDate
  • string

Date and time when the issue was created.

properties.description
  • string

Text describing the issue.

properties.state

Status of the issue.

properties.title
  • string

The issue title.

properties.userId
  • string

A resource identifier for the user created the issue.

State

Status of the issue.

Name Type Description
closed
  • string

The issue was closed.

open
  • string

The issue is opened.

proposed
  • string

The issue is proposed.

removed
  • string

The issue was removed.

resolved
  • string

The issue is now resolved.