Microsoft Azure - API ApiManagementClient

DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}/loggers/{loggerid}

Deletes the specified Logger from Diagnostic for an API.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`diagnosticId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	Diagnostic identifier. Must be unique in the current API Management service instance.
`loggerid`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Maximum: 80	Logger identifier. Must be unique in the API Management service instance.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200The Logger was successfully detached from Diagnostic.

204The Logger was successfully detached from Diagnostic.

HEAD

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}/loggers/{loggerid}

Checks that logger entity specified by identifier is associated with the diagnostics entity.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`diagnosticId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	Diagnostic identifier. Must be unique in the current API Management service instance.
`loggerid`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Maximum: 80	Logger identifier. Must be unique in the API Management service instance.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

204Entity exists

404Entity does not exists.

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}/loggers/{loggerid}

Attaches a logger to a dignostic for an API.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`diagnosticId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	Diagnostic identifier. Must be unique in the current API Management service instance.
`loggerid`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Maximum: 80	Logger identifier. Must be unique in the API Management service instance.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Logger to Diagnostic link was successfully updated.

Body

Name	Data Type	Description
`body`		The Resource definition.

Properties

`type`	string Read-only	Resource type for API Management resource.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.
`properties`

201Logger was successfully attached to Diagnostic.

Body

Name	Data Type	Description
`body`		The Resource definition.

Properties

`type`	string Read-only	Resource type for API Management resource.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.
`properties`

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}/loggers

Lists all loggers assosiated with the specified Diagnostic of an API.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.
`diagnosticId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	Diagnostic identifier. Must be unique in the current API Management service instance.

Query

Name Data Type Description


                                                        api-version

string

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


                                                        $filter

string

Field	Supported operators	Supported functions
id	ge, le, eq, ne, gt, lt	substringof, startswith, endswith
type	eq


                                                        $top

integer
Minimum: 1

Number of records to return.


                                                        $skip

integer
Minimum: 0

Number of records to skip.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Paged Result reponse of loggers assigned to the specified Diagnostic.

Body

Name	Data Type	Description
`body`		Paged Logger list representation.

Properties

`value`	array []	Logger values.
`nextLink`	string	Next page link if any.
`count`	long	Total record count number across all pages.

DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}

Deletes the specified Diagnostic from an API.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`diagnosticId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	Diagnostic identifier. Must be unique in the current API Management service instance.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Header

Name	Data Type	Description
`If-Match`	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.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200The Diagnostic was successfully deleted.

204The Diagnostic was successfully deleted.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}

Gets the details of the Diagnostic for an API specified by its identifier.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`diagnosticId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	Diagnostic identifier. Must be unique in the current API Management service instance.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200The response body contains the specified Diagnostic entity.

Header

Name	Data Type	Description
`ETag`	string	Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

Body

Name	Data Type	Description
`body`		The Resource definition.

Properties

`type`	string Read-only	Resource type for API Management resource.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.
`properties`

HEAD

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}

Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`diagnosticId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	Diagnostic identifier. Must be unique in the current API Management service instance.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Operation completed successfully.

Header

Name	Data Type	Description
`ETag`	string	Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

PATCH

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}

Updates the details of the Diagnostic for an API specified by its identifier.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`diagnosticId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	Diagnostic identifier. Must be unique in the current API Management service instance.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Header

Name	Data Type	Description
`If-Match`	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.

Body

Name	Data Type	Description
`parameters`		The Resource definition.

Properties

`type`	string Read-only	Resource type for API Management resource.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.
`properties`

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

204The Diagnostic was successfully updated.

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics/{diagnosticId}

Creates a new Diagnostic for an API or updates an existing one.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`diagnosticId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	Diagnostic identifier. Must be unique in the current API Management service instance.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Header

Name	Data Type	Description
`If-Match`	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Body

Name	Data Type	Description
`parameters`		The Resource definition.

Properties

`type`	string Read-only	Resource type for API Management resource.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.
`properties`

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Diagnostic was successfully updated.

Body

Name	Data Type	Description
`body`		The Resource definition.

Properties

`type`	string Read-only	Resource type for API Management resource.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.
`properties`

201Diagnostic was successfully created.

Body

Name	Data Type	Description
`body`		The Resource definition.

Properties

`type`	string Read-only	Resource type for API Management resource.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.
`properties`

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/diagnostics

Lists all diagnostics of an API.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name Data Type Description


                                                        api-version

string

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


                                                        $filter

string

Field	Supported operators	Supported functions
id	ge, le, eq, ne, gt, lt	substringof, startswith, endswith


                                                        $top

integer
Minimum: 1

Number of records to return.


                                                        $skip

integer
Minimum: 0

Number of records to skip.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Paged Result reponse of diagnostics for an API.

Body

Name	Data Type	Description
`body`		Paged Diagnostic list representation.

Properties

`value`	array []	Page values.
`nextLink`	string	Next page link if any.

DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/attachments/{attachmentId}

Deletes the specified comment from an Issue.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`issueId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	Issue identifier. Must be unique in the current API Management service instance.
`attachmentId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	Attachment identifier within an Issue. Must be unique in the current Issue.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Header

Name	Data Type	Description
`If-Match`	string	ETag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200The issue Attachment was successfully deleted.

204The issue Attachment was successfully deleted.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/attachments/{attachmentId}

Gets the details of the issue Attachment for an API specified by its identifier.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`issueId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	Issue identifier. Must be unique in the current API Management service instance.
`attachmentId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	Attachment identifier within an Issue. Must be unique in the current Issue.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200The response body contains the specified issue Attachment entity.

Header

Name	Data Type	Description
`ETag`	string	Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

Body

Name	Data Type	Description
`IssueAttachmentContract`		The Resource definition.

Properties


                        type

string
Read-only

Resource type for API Management resource.


                        name

string
Read-only

Resource name.

id

string
Read-only

Resource ID.


                        properties

IssueAttachmentContractProperties

Properties of the Issue Attachment.


                        IssueAttachmentContractProperties

Issue Attachment contract Properties.

Properties

`title`	string	Filename by which the binary data will be saved.
`contentFormat`	string	Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property.
`content`	string	An HTTP link or Base64-encoded binary data.

HEAD

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/attachments/{attachmentId}

Gets the entity state (Etag) version of the issue Attachment for an API specified by its identifier.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`issueId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	Issue identifier. Must be unique in the current API Management service instance.
`attachmentId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	Attachment identifier within an Issue. Must be unique in the current Issue.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Operation completed successfully.

Header

Name	Data Type	Description
`ETag`	string	Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/attachments/{attachmentId}

Creates a new Attachment for the Issue in an API or updates an existing one.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`issueId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	Issue identifier. Must be unique in the current API Management service instance.
`attachmentId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	Attachment identifier within an Issue. Must be unique in the current Issue.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Header

Name	Data Type	Description
`If-Match`	string	ETag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Body

Name	Data Type	Description
`IssueAttachmentContract`		The Resource definition.

Properties


                        type

string
Read-only

Resource type for API Management resource.


                        name

string
Read-only

Resource name.

id

string
Read-only

Resource ID.


                        properties

IssueAttachmentContractProperties

Properties of the Issue Attachment.


                        IssueAttachmentContractProperties

Issue Attachment contract Properties.

Properties

`title`	string	Filename by which the binary data will be saved.
`contentFormat`	string	Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property.
`content`	string	An HTTP link or Base64-encoded binary data.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Issue Attachment was successfully updated.

Body

Name	Data Type	Description
`IssueAttachmentContract`		The Resource definition.

Properties


                        type

string
Read-only

Resource type for API Management resource.


                        name

string
Read-only

Resource name.

id

string
Read-only

Resource ID.


                        properties

IssueAttachmentContractProperties

Properties of the Issue Attachment.


                        IssueAttachmentContractProperties

Issue Attachment contract Properties.

Properties

`title`	string	Filename by which the binary data will be saved.
`contentFormat`	string	Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property.
`content`	string	An HTTP link or Base64-encoded binary data.

201Issue Attachment was successfully created.

Body

Name	Data Type	Description
`IssueAttachmentContract`		The Resource definition.

Properties


                        type

string
Read-only

Resource type for API Management resource.


                        name

string
Read-only

Resource name.

id

string
Read-only

Resource ID.


                        properties

IssueAttachmentContractProperties

Properties of the Issue Attachment.


                        IssueAttachmentContractProperties

Issue Attachment contract Properties.

Properties

`title`	string	Filename by which the binary data will be saved.
`contentFormat`	string	Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property.
`content`	string	An HTTP link or Base64-encoded binary data.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/attachments

Lists all comments for the Issue assosiated with the specified API.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`issueId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	Issue identifier. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name Data Type Description


                                                        api-version

string

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


                                                        $filter

string

Field	Supported operators	Supported functions
id	ge, le, eq, ne, gt, lt	substringof, startswith, endswith
userId	ge, le, eq, ne, gt, lt	substringof, startswith, endswith


                                                        $top

integer
Minimum: 1

Number of records to return.


                                                        $skip

integer
Minimum: 0

Number of records to skip.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Paged Result reponse of issue comments for the API.

Body

Name	Data Type	Description
`IssueAttachmentCollection`		Paged Issue Attachment list representation.

Properties


                        value

array [IssueAttachmentContract]

Issue Attachment values.


                        IssueAttachmentContract

The Resource definition.

Properties


                        type

string
Read-only

Resource type for API Management resource.


                        name

string
Read-only

Resource name.

id

string
Read-only

Resource ID.


                        properties

IssueAttachmentContractProperties

Properties of the Issue Attachment.


                        IssueAttachmentContractProperties

Issue Attachment contract Properties.

Properties

`title`	string	Filename by which the binary data will be saved.
`contentFormat`	string	Either 'link' if content is provided via an HTTP link or the MIME type of the Base64-encoded binary data provided in the 'content' property.
`content`	string	An HTTP link or Base64-encoded binary data.


                        nextLink

string
Read-only

Next page link if any.

DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments/{commentId}

Deletes the specified comment from an Issue.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`issueId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	Issue identifier. Must be unique in the current API Management service instance.
`commentId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	Comment identifier within an Issue. Must be unique in the current Issue.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Header

Name	Data Type	Description
`If-Match`	string	ETag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200The issue Comment was successfully deleted.

204The issue Comment was successfully deleted.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments/{commentId}

Gets the details of the issue Comment for an API specified by its identifier.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`issueId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	Issue identifier. Must be unique in the current API Management service instance.
`commentId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	Comment identifier within an Issue. Must be unique in the current Issue.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200The response body contains the specified issue Comment entity.

Header

Name	Data Type	Description
`ETag`	string	Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

Body

Name	Data Type	Description
`IssueCommentContract`		The Resource definition.

Properties


                        type

string
Read-only

Resource type for API Management resource.


                        name

string
Read-only

Resource name.

id

string
Read-only

Resource ID.


                        properties

IssueCommentContractProperties

Properties of the Issue Comment.


                        IssueCommentContractProperties

Issue Comment contract Properties.

Properties

`userId`	string	A resource identifier for the user who left the comment.
`text`	string	Comment text.
`createdDate`	dateTime	Date and time when the comment was created.

HEAD

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments/{commentId}

Gets the entity state (Etag) version of the issue Comment for an API specified by its identifier.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`issueId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	Issue identifier. Must be unique in the current API Management service instance.
`commentId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	Comment identifier within an Issue. Must be unique in the current Issue.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Operation completed successfully.

Header

Name	Data Type	Description
`ETag`	string	Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments/{commentId}

Creates a new Comment for the Issue in an API or updates an existing one.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`issueId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	Issue identifier. Must be unique in the current API Management service instance.
`commentId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	Comment identifier within an Issue. Must be unique in the current Issue.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Header

Name	Data Type	Description
`If-Match`	string	ETag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Body

Name	Data Type	Description
`IssueCommentContract`		The Resource definition.

Properties


                        type

string
Read-only

Resource type for API Management resource.


                        name

string
Read-only

Resource name.

id

string
Read-only

Resource ID.


                        properties

IssueCommentContractProperties

Properties of the Issue Comment.


                        IssueCommentContractProperties

Issue Comment contract Properties.

Properties

`userId`	string	A resource identifier for the user who left the comment.
`text`	string	Comment text.
`createdDate`	dateTime	Date and time when the comment was created.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Issue Comment was successfully updated.

Body

Name	Data Type	Description
`IssueCommentContract`		The Resource definition.

Properties


                        type

string
Read-only

Resource type for API Management resource.


                        name

string
Read-only

Resource name.

id

string
Read-only

Resource ID.


                        properties

IssueCommentContractProperties

Properties of the Issue Comment.


                        IssueCommentContractProperties

Issue Comment contract Properties.

Properties

`userId`	string	A resource identifier for the user who left the comment.
`text`	string	Comment text.
`createdDate`	dateTime	Date and time when the comment was created.

201Issue Comment was successfully created.

Body

Name	Data Type	Description
`IssueCommentContract`		The Resource definition.

Properties


                        type

string
Read-only

Resource type for API Management resource.


                        name

string
Read-only

Resource name.

id

string
Read-only

Resource ID.


                        properties

IssueCommentContractProperties

Properties of the Issue Comment.


                        IssueCommentContractProperties

Issue Comment contract Properties.

Properties

`userId`	string	A resource identifier for the user who left the comment.
`text`	string	Comment text.
`createdDate`	dateTime	Date and time when the comment was created.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}/comments

Lists all comments for the Issue assosiated with the specified API.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`issueId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	Issue identifier. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name Data Type Description


                                                        api-version

string

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


                                                        $filter

string

Field	Supported operators	Supported functions
id	ge, le, eq, ne, gt, lt	substringof, startswith, endswith
userId	ge, le, eq, ne, gt, lt	substringof, startswith, endswith


                                                        $top

integer
Minimum: 1

Number of records to return.


                                                        $skip

integer
Minimum: 0

Number of records to skip.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Paged Result reponse of issue comments for the API.

Body

Name	Data Type	Description
`IssueCommentCollection`		Paged Issue Comment list representation.

Properties


                        value

array [IssueCommentContract]

Issue Comment values.


                        IssueCommentContract

The Resource definition.

Properties


                        type

string
Read-only

Resource type for API Management resource.


                        name

string
Read-only

Resource name.

id

string
Read-only

Resource ID.


                        properties

IssueCommentContractProperties

Properties of the Issue Comment.


                        IssueCommentContractProperties

Issue Comment contract Properties.

Properties

`userId`	string	A resource identifier for the user who left the comment.
`text`	string	Comment text.
`createdDate`	dateTime	Date and time when the comment was created.


                        nextLink

string
Read-only

Next page link if any.

DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}

Deletes the specified Issue from an API.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`issueId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	Issue identifier. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Header

Name	Data Type	Description
`If-Match`	string	ETag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200The Issue was successfully deleted.

204The Issue was successfully deleted.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}

Gets the details of the Issue for an API specified by its identifier.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`issueId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	Issue identifier. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200The response body contains the specified Issue entity.

Header

Name	Data Type	Description
`ETag`	string	Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

Body

Name	Data Type	Description
`IssueContract`		The Resource definition.

Properties


                        type

string
Read-only

Resource type for API Management resource.


                        name

string
Read-only

Resource name.

id

string
Read-only

Resource ID.


                        properties

IssueContractProperties

Properties of the Issue.


                        IssueContractProperties

Issue contract Properties.

Properties

`state`	string Allowed values: - `proposed` - `open` - `removed` - `resolved` - `closed`	Status of the issue.
`createdDate`	dateTime	Date and time when the issue was created.
`apiId`	string	A resource identifier for the API the issue was created for.
`userId`	string	A resource identifier for the user created the issue.
`title`	string	The issue title.
`description`	string	Text describing the issue.

Extends

IssueContractBaseProperties

Issue contract Base Properties.

Properties

Name	Data Type	Description
`state`	string Allowed values: - `proposed` - `open` - `removed` - `resolved` - `closed`	Status of the issue.
`createdDate`	dateTime	Date and time when the issue was created.
`apiId`	string	A resource identifier for the API the issue was created for.

HEAD

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}

Gets the entity state (Etag) version of the Issue for an API specified by its identifier.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`issueId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	Issue identifier. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Operation completed successfully.

Header

Name	Data Type	Description
`ETag`	string	Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

PATCH

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}

Updates an existing issue for an API.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`issueId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	Issue identifier. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Header

Name	Data Type	Description
`If-Match`	string	ETag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Body

Name	Data Type	Description
`IssueUpdateContract`		Issue update Parameters.

Properties


                        properties

IssueUpdateContractProperties

Issue entity Update contract properties.


                        IssueUpdateContractProperties

Issue contract Update Properties.

Properties

`state`	string Allowed values: - `proposed` - `open` - `removed` - `resolved` - `closed`	Status of the issue.
`createdDate`	dateTime	Date and time when the issue was created.
`apiId`	string	A resource identifier for the API the issue was created for.
`userId`	string	A resource identifier for the user created the issue.
`title`	string	The issue title.
`description`	string	Text describing the issue.

Extends

IssueContractBaseProperties

Issue contract Base Properties.

Properties

Name	Data Type	Description
`state`	string Allowed values: - `proposed` - `open` - `removed` - `resolved` - `closed`	Status of the issue.
`createdDate`	dateTime	Date and time when the issue was created.
`apiId`	string	A resource identifier for the API the issue was created for.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

204The Issue was successfully updated.

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues/{issueId}

Creates a new Issue for an API or updates an existing one.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`issueId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	Issue identifier. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Header

Name	Data Type	Description
`If-Match`	string	ETag of the Issue Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update.

Body

Name	Data Type	Description
`IssueContract`		The Resource definition.

Properties


                        type

string
Read-only

Resource type for API Management resource.


                        name

string
Read-only

Resource name.

id

string
Read-only

Resource ID.


                        properties

IssueContractProperties

Properties of the Issue.


                        IssueContractProperties

Issue contract Properties.

Properties

`state`	string Allowed values: - `proposed` - `open` - `removed` - `resolved` - `closed`	Status of the issue.
`createdDate`	dateTime	Date and time when the issue was created.
`apiId`	string	A resource identifier for the API the issue was created for.
`userId`	string	A resource identifier for the user created the issue.
`title`	string	The issue title.
`description`	string	Text describing the issue.

Extends

IssueContractBaseProperties

Issue contract Base Properties.

Properties

Name	Data Type	Description
`state`	string Allowed values: - `proposed` - `open` - `removed` - `resolved` - `closed`	Status of the issue.
`createdDate`	dateTime	Date and time when the issue was created.
`apiId`	string	A resource identifier for the API the issue was created for.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Issue was successfully updated.

Body

Name	Data Type	Description
`IssueContract`		The Resource definition.

Properties


                        type

string
Read-only

Resource type for API Management resource.


                        name

string
Read-only

Resource name.

id

string
Read-only

Resource ID.


                        properties

IssueContractProperties

Properties of the Issue.


                        IssueContractProperties

Issue contract Properties.

Properties

`state`	string Allowed values: - `proposed` - `open` - `removed` - `resolved` - `closed`	Status of the issue.
`createdDate`	dateTime	Date and time when the issue was created.
`apiId`	string	A resource identifier for the API the issue was created for.
`userId`	string	A resource identifier for the user created the issue.
`title`	string	The issue title.
`description`	string	Text describing the issue.

Extends

IssueContractBaseProperties

Issue contract Base Properties.

Properties

Name	Data Type	Description
`state`	string Allowed values: - `proposed` - `open` - `removed` - `resolved` - `closed`	Status of the issue.
`createdDate`	dateTime	Date and time when the issue was created.
`apiId`	string	A resource identifier for the API the issue was created for.

201Issue was successfully created.

Body

Name	Data Type	Description
`IssueContract`		The Resource definition.

Properties


                        type

string
Read-only

Resource type for API Management resource.


                        name

string
Read-only

Resource name.

id

string
Read-only

Resource ID.


                        properties

IssueContractProperties

Properties of the Issue.


                        IssueContractProperties

Issue contract Properties.

Properties

`state`	string Allowed values: - `proposed` - `open` - `removed` - `resolved` - `closed`	Status of the issue.
`createdDate`	dateTime	Date and time when the issue was created.
`apiId`	string	A resource identifier for the API the issue was created for.
`userId`	string	A resource identifier for the user created the issue.
`title`	string	The issue title.
`description`	string	Text describing the issue.

Extends

IssueContractBaseProperties

Issue contract Base Properties.

Properties

Name	Data Type	Description
`state`	string Allowed values: - `proposed` - `open` - `removed` - `resolved` - `closed`	Status of the issue.
`createdDate`	dateTime	Date and time when the issue was created.
`apiId`	string	A resource identifier for the API the issue was created for.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/issues

Lists all issues assosiated with the specified API.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name Data Type Description


                                                        api-version

string

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


                                                        $filter

string

Field	Supported operators	Supported functions
id	ge, le, eq, ne, gt, lt	substringof, startswith, endswith
state	eq
userId	ge, le, eq, ne, gt, lt	substringof, startswith, endswith


                                                        $top

integer
Minimum: 1

Number of records to return.


                                                        $skip

integer
Minimum: 0

Number of records to skip.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Paged Result reponse of issues for the API.

Body

Name	Data Type	Description
`IssueCollection`		Paged Issue list representation.

Properties


                        value

array [IssueContract]

Issue values.


                        IssueContract

The Resource definition.

Properties


                        type

string
Read-only

Resource type for API Management resource.


                        name

string
Read-only

Resource name.

id

string
Read-only

Resource ID.


                        properties

IssueContractProperties

Properties of the Issue.


                        IssueContractProperties

Issue contract Properties.

Properties

`state`	string Allowed values: - `proposed` - `open` - `removed` - `resolved` - `closed`	Status of the issue.
`createdDate`	dateTime	Date and time when the issue was created.
`apiId`	string	A resource identifier for the API the issue was created for.
`userId`	string	A resource identifier for the user created the issue.
`title`	string	The issue title.
`description`	string	Text describing the issue.

Extends

IssueContractBaseProperties

Issue contract Base Properties.

Properties

Name	Data Type	Description
`state`	string Allowed values: - `proposed` - `open` - `removed` - `resolved` - `closed`	Status of the issue.
`createdDate`	dateTime	Date and time when the issue was created.
`apiId`	string	A resource identifier for the API the issue was created for.


                        nextLink

string
Read-only

Next page link if any.

DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policies/{policyId}

Deletes the policy configuration at the Api Operation.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	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.
`operationId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	Operation identifier within an API. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`policyId`	string Allowed values: - `policy`	The identifier of the Policy.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Header

Name	Data Type	Description
`If-Match`	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.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Successfully deleted the policy configuration at the API Operation level.

204Successfully deleted the policy configuration at the API Operation level.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policies/{policyId}

Get the policy configuration at the API Operation level.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	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.
`operationId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	Operation identifier within an API. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`policyId`	string Allowed values: - `policy`	The identifier of the Policy.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Api Operation Policy information.

Header

Name	Data Type	Description
`ETag`	string	Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

Body

Name	Data Type	Description
`body`		The Resource definition.

Properties

`type`	string Read-only	Resource type for API Management resource.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.
`properties`

HEAD

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policies/{policyId}

Gets the entity state (Etag) version of the API operation policy specified by its identifier.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	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.
`operationId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	Operation identifier within an API. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`policyId`	string Allowed values: - `policy`	The identifier of the Policy.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Specified API operation policy entity exists and current entity state version is present in the ETag header.

Header

Name	Data Type	Description
`ETag`	string	Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policies/{policyId}

Creates or updates policy configuration for the API Operation level.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	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.
`operationId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	Operation identifier within an API. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`policyId`	string Allowed values: - `policy`	The identifier of the Policy.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Header

Name	Data Type	Description
`If-Match`	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Body

Name	Data Type	Description
`parameters`		The Resource definition.

Properties

`type`	string Read-only	Resource type for API Management resource.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.
`properties`

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Api Operation policy configuration of the tenant was successfully updated.

Body

Name	Data Type	Description
`body`		The Resource definition.

Properties

`type`	string Read-only	Resource type for API Management resource.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.
`properties`

201Api Operation policy configuration was successfully created.

Body

Name	Data Type	Description
`body`		The Resource definition.

Properties

`type`	string Read-only	Resource type for API Management resource.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.
`properties`

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}/policies

Get the list of policy configuration at the API Operation level.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	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.
`operationId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	Operation identifier within an API. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Api Operations Policy Collection.

Body

Name	Data Type	Description
`body`		The response of the list policy operation.

Properties

`value`	array []	Policy Contract value.
`nextLink`	string	Next page link if any.

DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}

Deletes the policy configuration at the Api.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	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.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`policyId`	string Allowed values: - `policy`	The identifier of the Policy.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Header

Name	Data Type	Description
`If-Match`	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.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Successfully deleted the policy configuration at the API level.

204Successfully deleted the policy configuration at the API level.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}

Get the policy configuration at the API level.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	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.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`policyId`	string Allowed values: - `policy`	The identifier of the Policy.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Api Policy information.

Header

Name	Data Type	Description
`ETag`	string	Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

Body

Name	Data Type	Description
`body`		The Resource definition.

Properties

`type`	string Read-only	Resource type for API Management resource.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.
`properties`

HEAD

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}

Gets the entity state (Etag) version of the API policy specified by its identifier.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	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.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`policyId`	string Allowed values: - `policy`	The identifier of the Policy.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Specified API Policy entity exists and current entity state version is present in the ETag header.

Header

Name	Data Type	Description
`ETag`	string	Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies/{policyId}

Creates or updates policy configuration for the API.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	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.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`policyId`	string Allowed values: - `policy`	The identifier of the Policy.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Header

Name	Data Type	Description
`If-Match`	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Body

Name	Data Type	Description
`parameters`		The Resource definition.

Properties

`type`	string Read-only	Resource type for API Management resource.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.
`properties`

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Api policy configuration of the tenant was successfully updated.

Body

Name	Data Type	Description
`body`		The Resource definition.

Properties

`type`	string Read-only	Resource type for API Management resource.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.
`properties`

201Api policy configuration was successfully created.

Body

Name	Data Type	Description
`body`		The Resource definition.

Properties

`type`	string Read-only	Resource type for API Management resource.
`name`	string Read-only	Resource name.
`id`	string Read-only	Resource ID.
`properties`

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/policies

Get the policy configuration at the API level.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	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.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Apis Policy Collection.

Header

Name	Data Type	Description
`ETag`	string	Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

Body

Name	Data Type	Description
`body`		The response of the list policy operation.

Properties

`value`	array []	Policy Contract value.
`nextLink`	string	Next page link if any.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/products

Lists all Products, which the API is part of.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	API identifier. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name Data Type Description


                                                        $filter

string

Field	Supported operators	Supported functions
name	ge, le, eq, ne, gt, lt	substringof, contains, startswith, endswith


                                                        $top

integer
Minimum: 1

Number of records to return.


                                                        $skip

integer
Minimum: 0

Number of records to skip.


                                                        api-version

string

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

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200The operation returns a collection of products which have the Api entity.

Body

Name	Data Type	Description
`body`		Paged Products list representation.

Properties

`value`	array []	Page values.
`nextLink`	string	Next page link if any.

DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}

Deletes the schema configuration at the Api.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	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.
`schemaId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	Schema identifier within an API. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Header

Name	Data Type	Description
`If-Match`	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.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Successfully deleted the schema configuration at the API level.

204Successfully deleted the schema configuration at the API level.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}

Get the schema configuration at the API level.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	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.
`schemaId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	Schema identifier within an API. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Api Schema information.

Header

Name	Data Type	Description
`ETag`	string	Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

Body

Name	Data Type	Description
`SchemaContract`		The Resource definition.

Properties


                        type

string
Read-only

Resource type for API Management resource.


                        name

string
Read-only

Resource name.

id

string
Read-only

Resource ID.


                        properties

SchemaContractProperties

Properties of the Schema.


                        SchemaContractProperties

Schema contract Properties.

Properties


                        document

SchemaDocumentProperties

Properties of the Schema Document.


                        SchemaDocumentProperties

Schema Document Properties.

Properties


                        value

string

Json escaped string defining the document representing the Schema.


                        contentType

string

Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).

HEAD

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}

Gets the entity state (Etag) version of the schema specified by its identifier.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	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.
`schemaId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	Schema identifier within an API. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Specified schema entity exists and current entity state version is present in the ETag header.

Header

Name	Data Type	Description
`ETag`	string	Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas/{schemaId}

Creates or updates schema configuration for the API.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	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.
`schemaId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	Schema identifier within an API. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Header

Name	Data Type	Description
`If-Match`	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Body

Name	Data Type	Description
`SchemaContract`		The Resource definition.

Properties


                        type

string
Read-only

Resource type for API Management resource.


                        name

string
Read-only

Resource name.

id

string
Read-only

Resource ID.


                        properties

SchemaContractProperties

Properties of the Schema.


                        SchemaContractProperties

Schema contract Properties.

Properties


                        document

SchemaDocumentProperties

Properties of the Schema Document.


                        SchemaDocumentProperties

Schema Document Properties.

Properties


                        value

string

Json escaped string defining the document representing the Schema.


                        contentType

string

Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Api schema configuration of the tenant was successfully updated.

Body

Name	Data Type	Description
`SchemaContract`		The Resource definition.

Properties


                        type

string
Read-only

Resource type for API Management resource.


                        name

string
Read-only

Resource name.

id

string
Read-only

Resource ID.


                        properties

SchemaContractProperties

Properties of the Schema.


                        SchemaContractProperties

Schema contract Properties.

Properties


                        document

SchemaDocumentProperties

Properties of the Schema Document.


                        SchemaDocumentProperties

Schema Document Properties.

Properties


                        value

string

Json escaped string defining the document representing the Schema.


                        contentType

string

Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).

201Api schema configuration was successfully created.

Body

Name	Data Type	Description
`SchemaContract`		The Resource definition.

Properties


                        type

string
Read-only

Resource type for API Management resource.


                        name

string
Read-only

Resource name.

id

string
Read-only

Resource ID.


                        properties

SchemaContractProperties

Properties of the Schema.


                        SchemaContractProperties

Schema contract Properties.

Properties


                        document

SchemaDocumentProperties

Properties of the Schema Document.


                        SchemaDocumentProperties

Schema Document Properties.

Properties


                        value

string

Json escaped string defining the document representing the Schema.


                        contentType

string

Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/schemas

Get the schema configuration at the API level.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	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.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Apis Schema Collection.

Header

Name	Data Type	Description
`ETag`	string	Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

Body

Name	Data Type	Description
`SchemaCollection`		The response of the list schema operation.

Properties


                        value

array [SchemaContract]

Api Schema Contract value.


                        SchemaContract

The Resource definition.

Properties


                        type

string
Read-only

Resource type for API Management resource.


                        name

string
Read-only

Resource name.

id

string
Read-only

Resource ID.


                        properties

SchemaContractProperties

Properties of the Schema.


                        SchemaContractProperties

Schema contract Properties.

Properties

`document`	SchemaDocumentProperties	Properties of the Schema Document.
`contentType`	string	Must be a valid a media type used in a Content-Type header as defined in the RFC 2616. Media type of the schema document (e.g. application/json, application/xml).


                        nextLink

string
Read-only

Next page link if any.

DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}

Deletes the specified API of the API Management service instance.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	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.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`deleteRevisions`	boolean	Delete all revisions of the Api.
`api-version`	string	Version of the API to be used with the client request.

Header

Name	Data Type	Description
`If-Match`	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.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200The API was successfully deleted.

204The API was successfully deleted.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}

Gets the details of the API specified by its identifier.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	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.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200The response body contains the specified API entity.

Header

Name	Data Type	Description
`ETag`	string	Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

Body

Name	Data Type	Description
`ApiContract`		The Resource definition.

Properties


                        type

string
Read-only

Resource type for API Management resource.


                        name

string
Read-only

Resource name.

id

string
Read-only

Resource ID.


                        properties

ApiContractProperties

Api entity contract properties.


                        ApiContractProperties

Api Entity Properties

Properties


                        type

string
Allowed values:
- http
- soap

Type of API.

subscriptionKeyParameterNames


                        isOnline

boolean
Read-only

Indicates if API revision is accessible via the gateway.


                        isCurrent

boolean
Read-only

Indicates if API revision is current api revision.


                        description

string

Description of the API. May include HTML formatting tags.

authenticationSettings


                        apiVersionSetId

string

A resource identifier for the related ApiVersionSet.


                        apiVersionDescription

string
Maximum: 256

Description of the Api Version.


                        apiVersion

string
Maximum: 100

Indicates the Version identifier of the API if the API is versioned


                        apiRevisionDescription

string
Maximum: 256

Description of the Api Revision.


                        apiRevision

string
Minimum: 1
Maximum: 100

Describes the Revision of the Api. If no value is provided, default revision 1 is created


                        serviceUrl

string
Minimum: 0
Maximum: 2000

Absolute URL of the backend service implementing this API.


                        protocols

array [string]
Allowed values:
- http
- https

Describes on which protocols the operations in this API can be invoked.


                        path

string
Minimum: 0
Maximum: 400

Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.


                        displayName

string
Minimum: 1
Maximum: 300

API name.

apiVersionSet ApiVersionSetContractDetails


                        ApiVersionSetContractDetails

An API Version Set contains the common configuration for a set of API Versions relating

Properties

`versioningScheme`	string Allowed values: - `Segment` - `Query` - `Header`	An value that determines where the API Version identifer will be located in a HTTP request.
`versionQueryName`	string	Name of query parameter that indicates the API Version if versioningScheme is set to `query`.
`versionHeaderName`	string	Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.
`id`	string	Identifier for existing API Version Set. Omit this value to create a new Version Set.
`description`	string	Description of API Version Set.

Extends

ApiEntityBaseContract

API base contract details.

Properties

Name	Data Type	Description
`type`	string Allowed values: - `http` - `soap`	Type of API.
`subscriptionKeyParameterNames`
`isOnline`	boolean Read-only	Indicates if API revision is accessible via the gateway.
`isCurrent`	boolean Read-only	Indicates if API revision is current api revision.
`description`	string	Description of the API. May include HTML formatting tags.
`authenticationSettings`
`apiVersionSetId`	string	A resource identifier for the related ApiVersionSet.
`apiVersionDescription`	string Maximum: 256	Description of the Api Version.
`apiVersion`	string Maximum: 100	Indicates the Version identifier of the API if the API is versioned
`apiRevisionDescription`	string Maximum: 256	Description of the Api Revision.
`apiRevision`	string Minimum: 1 Maximum: 100	Describes the Revision of the Api. If no value is provided, default revision 1 is created

HEAD

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}

Gets the entity state (Etag) version of the API specified by its identifier.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	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.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Specified API entity exists and current entity state version is present in the ETag header.

Header

Name	Data Type	Description
`ETag`	string	Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

PATCH

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}

Updates the specified API of the API Management service instance.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	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.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Header

Name	Data Type	Description
`If-Match`	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.

Body

Name	Data Type	Description
`ApiUpdateContract`		API update contract details.

Properties


                        properties

ApiContractUpdateProperties

Properties of the API entity that can be updated.


                        ApiContractUpdateProperties

API update contract properties.

Properties

`type`	string Allowed values: - `http` - `soap`	Type of API.
`subscriptionKeyParameterNames`
`isOnline`	boolean Read-only	Indicates if API revision is accessible via the gateway.
`isCurrent`	boolean Read-only	Indicates if API revision is current api revision.
`description`	string	Description of the API. May include HTML formatting tags.
`authenticationSettings`
`apiVersionSetId`	string	A resource identifier for the related ApiVersionSet.
`apiVersionDescription`	string Maximum: 256	Description of the Api Version.
`apiVersion`	string Maximum: 100	Indicates the Version identifier of the API if the API is versioned
`apiRevisionDescription`	string Maximum: 256	Description of the Api Revision.
`apiRevision`	string Minimum: 1 Maximum: 100	Describes the Revision of the Api. If no value is provided, default revision 1 is created
`serviceUrl`	string Minimum: 1 Maximum: 2000	Absolute URL of the backend service implementing this API.
`protocols`	array [string] Allowed values: - `http` - `https`	Describes on which protocols the operations in this API can be invoked.
`path`	string Minimum: 0 Maximum: 400	Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
`displayName`	string Minimum: 1 Maximum: 300	API name.

Extends

ApiEntityBaseContract

API base contract details.

Properties

Name	Data Type	Description
`type`	string Allowed values: - `http` - `soap`	Type of API.
`subscriptionKeyParameterNames`
`isOnline`	boolean Read-only	Indicates if API revision is accessible via the gateway.
`isCurrent`	boolean Read-only	Indicates if API revision is current api revision.
`description`	string	Description of the API. May include HTML formatting tags.
`authenticationSettings`
`apiVersionSetId`	string	A resource identifier for the related ApiVersionSet.
`apiVersionDescription`	string Maximum: 256	Description of the Api Version.
`apiVersion`	string Maximum: 100	Indicates the Version identifier of the API if the API is versioned
`apiRevisionDescription`	string Maximum: 256	Description of the Api Revision.
`apiRevision`	string Minimum: 1 Maximum: 100	Describes the Revision of the Api. If no value is provided, default revision 1 is created

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

204The API was successfully updated.

PUT

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}

Creates new or updates existing specified API of the API Management service instance.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	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.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Header

Name	Data Type	Description
`If-Match`	string	ETag of the Entity. Not required when creating an entity, but required when updating an entity.

Body

Name	Data Type	Description
`ApiCreateOrUpdateParameter`		API Create or Update Parameters.

Properties


                        properties

ApiCreateOrUpdateProperties

Api entity create of update properties.


                        ApiCreateOrUpdateProperties

Api Create or Update Properties.

Properties


                        serviceUrl

string
Minimum: 0
Maximum: 2000

Absolute URL of the backend service implementing this API.


                        protocols

array [string]
Allowed values:
- http
- https

Describes on which protocols the operations in this API can be invoked.


                        path

string
Minimum: 0
Maximum: 400

Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.


                        displayName

string
Minimum: 1
Maximum: 300

API name.

apiVersionSet ApiVersionSetContractDetails


                        ApiVersionSetContractDetails

An API Version Set contains the common configuration for a set of API Versions relating

Properties

`versioningScheme`	string Allowed values: - `Segment` - `Query` - `Header`	An value that determines where the API Version identifer will be located in a HTTP request.
`versionQueryName`	string	Name of query parameter that indicates the API Version if versioningScheme is set to `query`.
`versionHeaderName`	string	Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.
`id`	string	Identifier for existing API Version Set. Omit this value to create a new Version Set.
`description`	string	Description of API Version Set.

wsdlSelector


                        contentValue

string

Content value when Importing an API.


                        contentFormat

string
Allowed values:
- wadl-xml
- wadl-link-json
- swagger-json
- swagger-link-json
- wsdl
- wsdl-link

Format of the Content in which the API is getting imported.


                        apiType

string
Allowed values:
- http
- soap

Type of Api to create.

http creates a SOAP to REST API
soap creates a SOAP pass-through API .

Extends

ApiContractProperties

Api Entity Properties

Properties

Name Data Type Description


                        type

string
Allowed values:
- http
- soap

Type of API.

subscriptionKeyParameterNames


                        isOnline

boolean
Read-only

Indicates if API revision is accessible via the gateway.


                        isCurrent

boolean
Read-only

Indicates if API revision is current api revision.


                        description

string

Description of the API. May include HTML formatting tags.

authenticationSettings


                        apiVersionSetId

string

A resource identifier for the related ApiVersionSet.


                        apiVersionDescription

string
Maximum: 256

Description of the Api Version.


                        apiVersion

string
Maximum: 100

Indicates the Version identifier of the API if the API is versioned


                        apiRevisionDescription

string
Maximum: 256

Description of the Api Revision.


                        apiRevision

string
Minimum: 1
Maximum: 100

Describes the Revision of the Api. If no value is provided, default revision 1 is created


                        serviceUrl

string
Minimum: 0
Maximum: 2000

Absolute URL of the backend service implementing this API.


                        protocols

array [string]
Allowed values:
- http
- https

Describes on which protocols the operations in this API can be invoked.


                        path

string
Minimum: 0
Maximum: 400

Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.


                        displayName

string
Minimum: 1
Maximum: 300

API name.

apiVersionSet ApiVersionSetContractDetails


                        ApiVersionSetContractDetails

An API Version Set contains the common configuration for a set of API Versions relating

Properties

`versioningScheme`	string Allowed values: - `Segment` - `Query` - `Header`	An value that determines where the API Version identifer will be located in a HTTP request.
`versionQueryName`	string	Name of query parameter that indicates the API Version if versioningScheme is set to `query`.
`versionHeaderName`	string	Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.
`id`	string	Identifier for existing API Version Set. Omit this value to create a new Version Set.
`description`	string	Description of API Version Set.

Extends

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200API was successfully updated.

Header

Name	Data Type	Description
`ETag`	string	Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

Body

Name	Data Type	Description
`ApiContract`		The Resource definition.

Properties


                        type

string
Read-only

Resource type for API Management resource.


                        name

string
Read-only

Resource name.

id

string
Read-only

Resource ID.


                        properties

ApiContractProperties

Api entity contract properties.


                        ApiContractProperties

Api Entity Properties

Properties


                        type

string
Allowed values:
- http
- soap

Type of API.

subscriptionKeyParameterNames


                        isOnline

boolean
Read-only

Indicates if API revision is accessible via the gateway.


                        isCurrent

boolean
Read-only

Indicates if API revision is current api revision.


                        description

string

Description of the API. May include HTML formatting tags.

authenticationSettings


                        apiVersionSetId

string

A resource identifier for the related ApiVersionSet.


                        apiVersionDescription

string
Maximum: 256

Description of the Api Version.


                        apiVersion

string
Maximum: 100

Indicates the Version identifier of the API if the API is versioned


                        apiRevisionDescription

string
Maximum: 256

Description of the Api Revision.


                        apiRevision

string
Minimum: 1
Maximum: 100

Describes the Revision of the Api. If no value is provided, default revision 1 is created


                        serviceUrl

string
Minimum: 0
Maximum: 2000

Absolute URL of the backend service implementing this API.


                        protocols

array [string]
Allowed values:
- http
- https

Describes on which protocols the operations in this API can be invoked.


                        path

string
Minimum: 0
Maximum: 400

Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.


                        displayName

string
Minimum: 1
Maximum: 300

API name.

apiVersionSet ApiVersionSetContractDetails


                        ApiVersionSetContractDetails

An API Version Set contains the common configuration for a set of API Versions relating

Properties

`versioningScheme`	string Allowed values: - `Segment` - `Query` - `Header`	An value that determines where the API Version identifer will be located in a HTTP request.
`versionQueryName`	string	Name of query parameter that indicates the API Version if versioningScheme is set to `query`.
`versionHeaderName`	string	Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.
`id`	string	Identifier for existing API Version Set. Omit this value to create a new Version Set.
`description`	string	Description of API Version Set.

Extends

ApiEntityBaseContract

API base contract details.

Properties

Name	Data Type	Description
`type`	string Allowed values: - `http` - `soap`	Type of API.
`subscriptionKeyParameterNames`
`isOnline`	boolean Read-only	Indicates if API revision is accessible via the gateway.
`isCurrent`	boolean Read-only	Indicates if API revision is current api revision.
`description`	string	Description of the API. May include HTML formatting tags.
`authenticationSettings`
`apiVersionSetId`	string	A resource identifier for the related ApiVersionSet.
`apiVersionDescription`	string Maximum: 256	Description of the Api Version.
`apiVersion`	string Maximum: 100	Indicates the Version identifier of the API if the API is versioned
`apiRevisionDescription`	string Maximum: 256	Description of the Api Revision.
`apiRevision`	string Minimum: 1 Maximum: 100	Describes the Revision of the Api. If no value is provided, default revision 1 is created

201API was successfully created.

Header

Name	Data Type	Description
`ETag`	string	Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

Body

Name	Data Type	Description
`ApiContract`		The Resource definition.

Properties


                        type

string
Read-only

Resource type for API Management resource.


                        name

string
Read-only

Resource name.

id

string
Read-only

Resource ID.


                        properties

ApiContractProperties

Api entity contract properties.


                        ApiContractProperties

Api Entity Properties

Properties


                        type

string
Allowed values:
- http
- soap

Type of API.

subscriptionKeyParameterNames


                        isOnline

boolean
Read-only

Indicates if API revision is accessible via the gateway.


                        isCurrent

boolean
Read-only

Indicates if API revision is current api revision.


                        description

string

Description of the API. May include HTML formatting tags.

authenticationSettings


                        apiVersionSetId

string

A resource identifier for the related ApiVersionSet.


                        apiVersionDescription

string
Maximum: 256

Description of the Api Version.


                        apiVersion

string
Maximum: 100

Indicates the Version identifier of the API if the API is versioned


                        apiRevisionDescription

string
Maximum: 256

Description of the Api Revision.


                        apiRevision

string
Minimum: 1
Maximum: 100

Describes the Revision of the Api. If no value is provided, default revision 1 is created


                        serviceUrl

string
Minimum: 0
Maximum: 2000

Absolute URL of the backend service implementing this API.


                        protocols

array [string]
Allowed values:
- http
- https

Describes on which protocols the operations in this API can be invoked.


                        path

string
Minimum: 0
Maximum: 400

Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.


                        displayName

string
Minimum: 1
Maximum: 300

API name.

apiVersionSet ApiVersionSetContractDetails


                        ApiVersionSetContractDetails

An API Version Set contains the common configuration for a set of API Versions relating

Properties

`versioningScheme`	string Allowed values: - `Segment` - `Query` - `Header`	An value that determines where the API Version identifer will be located in a HTTP request.
`versionQueryName`	string	Name of query parameter that indicates the API Version if versioningScheme is set to `query`.
`versionHeaderName`	string	Name of HTTP header parameter that indicates the API Version if versioningScheme is set to `header`.
`id`	string	Identifier for existing API Version Set. Omit this value to create a new Version Set.
`description`	string	Description of API Version Set.

Extends

ApiEntityBaseContract

API base contract details.

Properties

Name	Data Type	Description
`type`	string Allowed values: - `http` - `soap`	Type of API.
`subscriptionKeyParameterNames`
`isOnline`	boolean Read-only	Indicates if API revision is accessible via the gateway.
`isCurrent`	boolean Read-only	Indicates if API revision is current api revision.
`description`	string	Description of the API. May include HTML formatting tags.
`authenticationSettings`
`apiVersionSetId`	string	A resource identifier for the related ApiVersionSet.
`apiVersionDescription`	string Maximum: 256	Description of the Api Version.
`apiVersion`	string Maximum: 100	Indicates the Version identifier of the API if the API is versioned
`apiRevisionDescription`	string Maximum: 256	Description of the Api Revision.
`apiRevision`	string Minimum: 1 Maximum: 100	Describes the Revision of the Api. If no value is provided, default revision 1 is created

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis

Lists all APIs of the API Management service instance.

Request

Path

Name	Data Type	Description
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name Data Type Description


                                                        $filter

string

Field	Supported operators	Supported functions
id	ge, le, eq, ne, gt, lt	substringof, startswith, endswith
name	ge, le, eq, ne, gt, lt	substringof, startswith, endswith
description	ge, le, eq, ne, gt, lt	substringof, startswith, endswith
serviceUrl	ge, le, eq, ne, gt, lt	substringof, startswith, endswith
path	ge, le, eq, ne, gt, lt	substringof, startswith, endswith


                                                        $top

integer
Minimum: 1

Number of records to return.


                                                        $skip

integer
Minimum: 0

Number of records to skip.


                                                        api-version

string

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


                                                        expandApiVersionSet

boolean
Default value: false

Include full ApiVersionSet resource in response

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200Paged Result response of Apis.

Body

Name	Data Type	Description
`ApiCollection`		Paged Api list representation.

Properties


                        value

array [ApiContract]

Page values.


                        ApiContract

The Resource definition.

Properties


                        type

string
Read-only

Resource type for API Management resource.


                        name

string
Read-only

Resource name.

id

string
Read-only

Resource ID.


                        properties

ApiContractProperties

Api entity contract properties.


                        ApiContractProperties

Api Entity Properties

Properties

`type`	string Allowed values: - `http` - `soap`	Type of API.
`subscriptionKeyParameterNames`
`isOnline`	boolean Read-only	Indicates if API revision is accessible via the gateway.
`isCurrent`	boolean Read-only	Indicates if API revision is current api revision.
`description`	string	Description of the API. May include HTML formatting tags.
`authenticationSettings`
`apiVersionSetId`	string	A resource identifier for the related ApiVersionSet.
`apiVersionDescription`	string Maximum: 256	Description of the Api Version.
`apiVersion`	string Maximum: 100	Indicates the Version identifier of the API if the API is versioned
`apiRevisionDescription`	string Maximum: 256	Description of the Api Revision.
`apiRevision`	string Minimum: 1 Maximum: 100	Describes the Revision of the Api. If no value is provided, default revision 1 is created
`serviceUrl`	string Minimum: 0 Maximum: 2000	Absolute URL of the backend service implementing this API.
`protocols`	array [string] Allowed values: - `http` - `https`	Describes on which protocols the operations in this API can be invoked.
`path`	string Minimum: 0 Maximum: 400	Relative URL uniquely identifying this API and all of its resource paths within the API Management service instance. It is appended to the API endpoint base URL specified during the service instance creation to form a public URL for this API.
`displayName`	string Minimum: 1 Maximum: 300	API name.
`apiVersionSet`	ApiVersionSetContractDetails

Extends

ApiEntityBaseContract

API base contract details.

Properties

Name	Data Type	Description
`type`	string Allowed values: - `http` - `soap`	Type of API.
`subscriptionKeyParameterNames`
`isOnline`	boolean Read-only	Indicates if API revision is accessible via the gateway.
`isCurrent`	boolean Read-only	Indicates if API revision is current api revision.
`description`	string	Description of the API. May include HTML formatting tags.
`authenticationSettings`
`apiVersionSetId`	string	A resource identifier for the related ApiVersionSet.
`apiVersionDescription`	string Maximum: 256	Description of the Api Version.
`apiVersion`	string Maximum: 100	Indicates the Version identifier of the API if the API is versioned
`apiRevisionDescription`	string Maximum: 256	Description of the Api Revision.
`apiRevision`	string Minimum: 1 Maximum: 100	Describes the Revision of the Api. If no value is provided, default revision 1 is created


                        nextLink

string
Read-only

Next page link if any.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apisByTags

Lists a collection of apis associated with tags.

Request

Path

Name	Data Type	Description
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name Data Type Description


                                                        $filter

string

Field	Supported operators	Supported functions
id	ge, le, eq, ne, gt, lt	substringof, contains, startswith, endswith
name	ge, le, eq, ne, gt, lt	substringof, contains, startswith, endswith
aid	ge, le, eq, ne, gt, lt	substringof, contains, startswith, endswith
apiRevision	ge, le, eq, ne, gt, lt	substringof, contains, startswith, endswith
path	ge, le, eq, ne, gt, lt	substringof, contains, startswith, endswith
description	ge, le, eq, ne, gt, lt	substringof, contains, startswith, endswith
serviceUrl	ge, le, eq, ne, gt, lt	substringof, contains, startswith, endswith
isCurrent	eq	substringof, contains, startswith, endswith


                                                        $top

integer
Minimum: 1

Number of records to return.


                                                        $skip

integer
Minimum: 0

Number of records to skip.


                                                        api-version

string

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

Responses

200Lists a collection of TagResource entities.

Body

Name	Data Type	Description
`body`		Paged Tag list representation.

Properties

`value`	array []	Page values.
`nextLink`	string	Next page link if any.
`count`	long	Total record count number across all pages.

DELETE

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}

Deletes the specified operation in the API.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	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.
`operationId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	Operation identifier within an API. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Header

Name	Data Type	Description
`If-Match`	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.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200The operation was successfully deleted.

204The operation was successfully deleted.

GET

/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}

Gets the details of the API Operation specified by its identifier.

Request

Path

Name	Data Type	Description
`apiId`	string Pattern: `^[^*#&+:<>?]+$` Minimum: 1 Maximum: 256	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.
`operationId`	string Pattern: `(^[\w]+$)\|(^[\w][\w\-]+[\w]$)` Minimum: 1 Maximum: 80	Operation identifier within an API. Must be unique in the current API Management service instance.
`resourceGroupName`	string	The name of the resource group.
`serviceName`	string Pattern: `^[a-zA-Z](?:[a-zA-Z0-9-]*[a-zA-Z0-9])?$` Minimum: 1 Maximum: 50	The name of the API Management service.
`subscriptionId`	string	Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.

Query

Name	Data Type	Description
`api-version`	string	Version of the API to be used with the client request.

Responses

200Error response describing why the operation failed.

Body

Name	Data Type	Description
`body`		Error Response.

Properties

error

200The response body contains the specified Operation entity.

Header

Name	Data Type	Description
`ETag`	string	Current entity state version. Should be treated as opaque and used to make conditional HTTP requests.

Body

Name	Data Type	Description
`OperationContract`		The Resource definition.

Properties


                        type

string
Read-only

Resource type for API Management resource.


                        name

string
Read-only

Resource name.

id

string
Read-only

Resource ID.


                        properties

OperationContractProperties

Properties of the Operation Contract.


                        OperationContractProperties

Operation Contract Properties

Properties


                        templateParameters

array [ParameterContract]

Collection of URL template parameters.


                        ParameterContract

Operation parameters details.

Properties

`values`	array [string]	Parameter values.
`type`	string	Parameter type.
`required`	boolean	whether parameter is required or not.
`name`	string	Parameter name.
`description`	string	Parameter description.
`defaultValue`	string	Default parameter value.


                        responses

array [ResponseContract]

Array of Operation responses.


                        ResponseContract

Operation response details.

Properties

`statusCode`	integer	Operation response HTTP status code.
`representations`	array [RepresentationContract]	Collection of operation response representations.
`headers`	array [ParameterContract]	Collection of operation response headers.
`description`	string	Operation response description.


                        request

RequestContract

An entity containing request details.


                        RequestContract

Operation request details.

Properties

`representations`	array [RepresentationContract]	Collection of operation request representations.
`queryParameters`	array [ParameterContract]	Collection of operation request query parameters.
`headers`	array [ParameterContract]	Collection of operation request headers.
`description`	string	Operation request description.


                        policies

string

Operation Policies


                        description

string
Maximum: 1000

Description of the operation. May include HTML formatting tags.


                        urlTemplate

string
Minimum: 1
Maximum: 1000

Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date}


                        method

string

A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them.


                        displayName

string
Minimum: 1
Maximum: 300

Operation Name.

Extends

OperationEntityBaseContract

Api Operation Entity Base Contract details.

Properties

Name Data Type Description


                        templateParameters

array [ParameterContract]

Collection of URL template parameters.


                        ParameterContract

Operation parameters details.

Properties

`values`	array [string]	Parameter values.
`type`	string	Parameter type.
`required`	boolean	whether parameter is required or not.
`name`	string	Parameter name.
`description`	string	Parameter description.
`defaultValue`	string	Default parameter value.


                        responses

array [ResponseContract]

Array of Operation responses.


                        ResponseContract

Operation response details.

Properties


                        statusCode

integer

Operation response HTTP status code.


                        representations

array [RepresentationContract]

Collection of operation response representations.


                        RepresentationContract

Operation request/response representation details.

Properties


                        typeName

string

Type name defined by the schema. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.


                        schemaId

string

Schema identifier. Applicable only if 'contentType' value is neither 'application/x-www-form-urlencoded' nor 'multipart/form-data'.


                        sample

string

An example of the representation.


                        formParameters

array [ParameterContract]

Collection of form parameters. Required if 'contentType' value is either 'application/x-www-form-urlencoded' or 'multipart/form-data'..


                        ParameterContract

Operation parameters details.

Properties


                        values

ApiManagementClient

Resources

ApiDiagnosticLoggers

Request

Path

Query

Responses

Body

Properties

Request

Path

Query

Responses

Body

Properties

Request

Path

Query

Responses

Body

Properties

Body

Properties

Body

Properties

Request

Path

Query

Responses

Body

Properties

Body

Properties

ApiDiagnostics

Request

Path

Query

Header

Responses

Body

Properties

Request

Path

Query

Responses

Body

Properties

Header

Body

Properties

Request

Path

Query

Responses

Body

Properties

Header

Request

Path

Query

Header

Body

Properties

Responses

Body

Properties

Request

Path

Query

Header

Body

Properties

Responses

Body

Properties

Body

Properties

Body

Properties

Request