Use these REST APIs for performing operations on API entity and their Operations associated with your Azure API Management deployment.
Deletes the specified Logger from Diagnostic for an API.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
loggerid
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Maximum: 80 |
Logger identifier. Must be unique in the API Management service instance. |
diagnosticId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
Diagnostic identifier. Must be unique in the current API Management service instance. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Checks that logger entity specified by identifier is associated with the diagnostics entity.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
loggerid
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Maximum: 80 |
Logger identifier. Must be unique in the API Management service instance. |
diagnosticId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
Diagnostic identifier. Must be unique in the current API Management service instance. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Attaches a logger to a dignostic for an API.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
loggerid
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Maximum: 80 |
Logger identifier. Must be unique in the API Management service instance. |
diagnosticId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
Diagnostic identifier. Must be unique in the current API Management service instance. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
body
|
The Resource definition. |
type
|
string Read-only |
Resource type for API Management resource. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
properties
|
Name | Data Type | Description |
---|---|---|
body
|
The Resource definition. |
type
|
string Read-only |
Resource type for API Management resource. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
properties
|
Lists all loggers assosiated with the specified Diagnostic of an API.
Name | Data Type | Description |
---|---|---|
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. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
$skip
|
integer Minimum: 0 |
Number of records to skip. |
|||||||||
$top
|
integer Minimum: 1 |
Number of records to return. |
|||||||||
$filter
|
string |
|
|||||||||
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
body
|
Paged Logger list representation. |
value
|
array [] |
Logger values. |
nextLink
|
string |
Next page link if any. |
count
|
long |
Total record count number across all pages. |
Deletes the specified Diagnostic from an API.
Name | Data Type | Description |
---|---|---|
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. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
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. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Gets the details of the Diagnostic for an API specified by its identifier.
Name | Data Type | Description |
---|---|---|
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. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. |
Name | Data Type | Description |
---|---|---|
body
|
The Resource definition. |
type
|
string Read-only |
Resource type for API Management resource. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
properties
|
Gets the entity state (Etag) version of the Diagnostic for an API specified by its identifier.
Name | Data Type | Description |
---|---|---|
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. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. |
Updates the details of the Diagnostic for an API specified by its identifier.
Name | Data Type | Description |
---|---|---|
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. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
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. |
Name | Data Type | Description |
---|---|---|
parameters
|
The Resource definition. |
type
|
string Read-only |
Resource type for API Management resource. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
properties
|
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Creates a new Diagnostic for an API or updates an existing one.
Name | Data Type | Description |
---|---|---|
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. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
If-Match
|
string |
ETag of the Entity. Not required when creating an entity, but required when updating an entity. |
Name | Data Type | Description |
---|---|---|
parameters
|
The Resource definition. |
type
|
string Read-only |
Resource type for API Management resource. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
properties
|
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
body
|
The Resource definition. |
type
|
string Read-only |
Resource type for API Management resource. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
properties
|
Name | Data Type | Description |
---|---|---|
body
|
The Resource definition. |
type
|
string Read-only |
Resource type for API Management resource. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
properties
|
Lists all diagnostics of an API.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
$skip
|
integer Minimum: 0 |
Number of records to skip. |
||||||
$top
|
integer Minimum: 1 |
Number of records to return. |
||||||
$filter
|
string |
|
||||||
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
body
|
Paged Diagnostic list representation. |
value
|
array [] |
Page values. |
nextLink
|
string |
Next page link if any. |
Deletes the specified comment from an Issue.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
attachmentId
|
string Pattern: ^[^*#&+:<>?]+$ Minimum: 1 Maximum: 256 |
Attachment identifier within an Issue. Must be unique in the current Issue. |
issueId
|
string Pattern: ^[^*#&+:<>?]+$ Minimum: 1 Maximum: 256 |
Issue identifier. Must be unique in the current API Management service instance. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
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. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Gets the details of the issue Attachment for an API specified by its identifier.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
attachmentId
|
string Pattern: ^[^*#&+:<>?]+$ Minimum: 1 Maximum: 256 |
Attachment identifier within an Issue. Must be unique in the current Issue. |
issueId
|
string Pattern: ^[^*#&+:<>?]+$ Minimum: 1 Maximum: 256 |
Issue identifier. Must be unique in the current API Management service instance. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. |
Name | Data Type | Description |
---|---|---|
IssueAttachmentContract
|
The Resource definition. |
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. |
|||||||||||||
Properties
|
Gets the entity state (Etag) version of the issue Attachment for an API specified by its identifier.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
attachmentId
|
string Pattern: ^[^*#&+:<>?]+$ Minimum: 1 Maximum: 256 |
Attachment identifier within an Issue. Must be unique in the current Issue. |
issueId
|
string Pattern: ^[^*#&+:<>?]+$ Minimum: 1 Maximum: 256 |
Issue identifier. Must be unique in the current API Management service instance. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. |
Creates a new Attachment for the Issue in an API or updates an existing one.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
attachmentId
|
string Pattern: ^[^*#&+:<>?]+$ Minimum: 1 Maximum: 256 |
Attachment identifier within an Issue. Must be unique in the current Issue. |
issueId
|
string Pattern: ^[^*#&+:<>?]+$ Minimum: 1 Maximum: 256 |
Issue identifier. Must be unique in the current API Management service instance. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
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. |
Name | Data Type | Description |
---|---|---|
IssueAttachmentContract
|
The Resource definition. |
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. |
|||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
IssueAttachmentContract
|
The Resource definition. |
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. |
|||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
IssueAttachmentContract
|
The Resource definition. |
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. |
|||||||||||||
Properties
|
Lists all comments for the Issue assosiated with the specified API.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
issueId
|
string Pattern: ^[^*#&+:<>?]+$ Minimum: 1 Maximum: 256 |
Issue identifier. Must be unique in the current API Management service instance. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
$skip
|
integer Minimum: 0 |
Number of records to skip. |
|||||||||
$top
|
integer Minimum: 1 |
Number of records to return. |
|||||||||
$filter
|
string |
|
|||||||||
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
IssueAttachmentCollection
|
Paged Issue Attachment list representation. |
value
|
array [IssueAttachmentContract] |
Issue Attachment values. |
||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
Next page link if any. |
Deletes the specified comment from an Issue.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
commentId
|
string Pattern: ^[^*#&+:<>?]+$ Minimum: 1 Maximum: 256 |
Comment identifier within an Issue. Must be unique in the current Issue. |
issueId
|
string Pattern: ^[^*#&+:<>?]+$ Minimum: 1 Maximum: 256 |
Issue identifier. Must be unique in the current API Management service instance. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
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. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Gets the details of the issue Comment for an API specified by its identifier.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
commentId
|
string Pattern: ^[^*#&+:<>?]+$ Minimum: 1 Maximum: 256 |
Comment identifier within an Issue. Must be unique in the current Issue. |
issueId
|
string Pattern: ^[^*#&+:<>?]+$ Minimum: 1 Maximum: 256 |
Issue identifier. Must be unique in the current API Management service instance. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. |
Name | Data Type | Description |
---|---|---|
IssueCommentContract
|
The Resource definition. |
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. |
|||||||||||||
Properties
|
Gets the entity state (Etag) version of the issue Comment for an API specified by its identifier.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
commentId
|
string Pattern: ^[^*#&+:<>?]+$ Minimum: 1 Maximum: 256 |
Comment identifier within an Issue. Must be unique in the current Issue. |
issueId
|
string Pattern: ^[^*#&+:<>?]+$ Minimum: 1 Maximum: 256 |
Issue identifier. Must be unique in the current API Management service instance. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. |
Creates a new Comment for the Issue in an API or updates an existing one.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
commentId
|
string Pattern: ^[^*#&+:<>?]+$ Minimum: 1 Maximum: 256 |
Comment identifier within an Issue. Must be unique in the current Issue. |
issueId
|
string Pattern: ^[^*#&+:<>?]+$ Minimum: 1 Maximum: 256 |
Issue identifier. Must be unique in the current API Management service instance. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
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. |
Name | Data Type | Description |
---|---|---|
IssueCommentContract
|
The Resource definition. |
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. |
|||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
IssueCommentContract
|
The Resource definition. |
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. |
|||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
IssueCommentContract
|
The Resource definition. |
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. |
|||||||||||||
Properties
|
Lists all comments for the Issue assosiated with the specified API.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
issueId
|
string Pattern: ^[^*#&+:<>?]+$ Minimum: 1 Maximum: 256 |
Issue identifier. Must be unique in the current API Management service instance. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description | |||||||||
---|---|---|---|---|---|---|---|---|---|---|---|
$skip
|
integer Minimum: 0 |
Number of records to skip. |
|||||||||
$top
|
integer Minimum: 1 |
Number of records to return. |
|||||||||
$filter
|
string |
|
|||||||||
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
IssueCommentCollection
|
Paged Issue Comment list representation. |
value
|
array [IssueCommentContract] |
Issue Comment values. |
||||||||||||||||||||||||||||||||
Properties
|
||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
Next page link if any. |
Deletes the specified Issue from an API.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
issueId
|
string Pattern: ^[^*#&+:<>?]+$ Minimum: 1 Maximum: 256 |
Issue identifier. Must be unique in the current API Management service instance. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
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. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Gets the details of the Issue for an API specified by its identifier.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
issueId
|
string Pattern: ^[^*#&+:<>?]+$ Minimum: 1 Maximum: 256 |
Issue identifier. Must be unique in the current API Management service instance. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. |
Name | Data Type | Description |
---|---|---|
IssueContract
|
The Resource definition. |
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. |
||||||||||||||||||||||||||||||||||
Properties
Extends
IssueContractBaseProperties
Issue contract Base Properties. Properties
|
Gets the entity state (Etag) version of the Issue for an API specified by its identifier.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
issueId
|
string Pattern: ^[^*#&+:<>?]+$ Minimum: 1 Maximum: 256 |
Issue identifier. Must be unique in the current API Management service instance. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. |
Updates an existing issue for an API.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
issueId
|
string Pattern: ^[^*#&+:<>?]+$ Minimum: 1 Maximum: 256 |
Issue identifier. Must be unique in the current API Management service instance. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
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. |
Name | Data Type | Description |
---|---|---|
IssueUpdateContract
|
Issue update Parameters. |
properties
|
IssueUpdateContractProperties |
Issue entity Update contract properties. |
||||||||||||||||||||||||||||||||||
Properties
Extends
IssueContractBaseProperties
Issue contract Base Properties. Properties
|
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Creates a new Issue for an API or updates an existing one.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
issueId
|
string Pattern: ^[^*#&+:<>?]+$ Minimum: 1 Maximum: 256 |
Issue identifier. Must be unique in the current API Management service instance. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
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. |
Name | Data Type | Description |
---|---|---|
IssueContract
|
The Resource definition. |
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. |
||||||||||||||||||||||||||||||||||
Properties
Extends
IssueContractBaseProperties
Issue contract Base Properties. Properties
|
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
IssueContract
|
The Resource definition. |
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. |
||||||||||||||||||||||||||||||||||
Properties
Extends
IssueContractBaseProperties
Issue contract Base Properties. Properties
|
Name | Data Type | Description |
---|---|---|
IssueContract
|
The Resource definition. |
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. |
||||||||||||||||||||||||||||||||||
Properties
Extends
IssueContractBaseProperties
Issue contract Base Properties. Properties
|
Lists all issues assosiated with the specified API.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description | ||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
$skip
|
integer Minimum: 0 |
Number of records to skip. |
||||||||||||
$top
|
integer Minimum: 1 |
Number of records to return. |
||||||||||||
$filter
|
string |
|
||||||||||||
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
IssueCollection
|
Paged Issue list representation. |
value
|
array [IssueContract] |
Issue values. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
Next page link if any. |
Deletes the policy configuration at the Api Operation.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
policyId
|
string Allowed values: - policy |
The identifier of the Policy. |
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. |
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. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
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. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Get the policy configuration at the API Operation level.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
policyId
|
string Allowed values: - policy |
The identifier of the Policy. |
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. |
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. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. |
Name | Data Type | Description |
---|---|---|
body
|
The Resource definition. |
type
|
string Read-only |
Resource type for API Management resource. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
properties
|
Gets the entity state (Etag) version of the API operation policy specified by its identifier.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
policyId
|
string Allowed values: - policy |
The identifier of the Policy. |
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. |
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. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. |
Creates or updates policy configuration for the API Operation level.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
policyId
|
string Allowed values: - policy |
The identifier of the Policy. |
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. |
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. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
If-Match
|
string |
ETag of the Entity. Not required when creating an entity, but required when updating an entity. |
Name | Data Type | Description |
---|---|---|
parameters
|
The Resource definition. |
type
|
string Read-only |
Resource type for API Management resource. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
properties
|
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
body
|
The Resource definition. |
type
|
string Read-only |
Resource type for API Management resource. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
properties
|
Name | Data Type | Description |
---|---|---|
body
|
The Resource definition. |
type
|
string Read-only |
Resource type for API Management resource. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
properties
|
Get the list of policy configuration at the API Operation level.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
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. |
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. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
body
|
The response of the list policy operation. |
value
|
array [] |
Policy Contract value. |
nextLink
|
string |
Next page link if any. |
Deletes the policy configuration at the Api.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
policyId
|
string Allowed values: - policy |
The identifier of the Policy. |
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. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
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. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Get the policy configuration at the API level.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
policyId
|
string Allowed values: - policy |
The identifier of the Policy. |
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. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. |
Name | Data Type | Description |
---|---|---|
body
|
The Resource definition. |
type
|
string Read-only |
Resource type for API Management resource. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
properties
|
Gets the entity state (Etag) version of the API policy specified by its identifier.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
policyId
|
string Allowed values: - policy |
The identifier of the Policy. |
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. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. |
Creates or updates policy configuration for the API.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
policyId
|
string Allowed values: - policy |
The identifier of the Policy. |
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. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
If-Match
|
string |
ETag of the Entity. Not required when creating an entity, but required when updating an entity. |
Name | Data Type | Description |
---|---|---|
parameters
|
The Resource definition. |
type
|
string Read-only |
Resource type for API Management resource. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
properties
|
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
body
|
The Resource definition. |
type
|
string Read-only |
Resource type for API Management resource. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
properties
|
Name | Data Type | Description |
---|---|---|
body
|
The Resource definition. |
type
|
string Read-only |
Resource type for API Management resource. |
name
|
string Read-only |
Resource name. |
id
|
string Read-only |
Resource ID. |
properties
|
Get the policy configuration at the API level.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
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. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. |
Name | Data Type | Description |
---|---|---|
body
|
The response of the list policy operation. |
value
|
array [] |
Policy Contract value. |
nextLink
|
string |
Next page link if any. |
Lists all Products, which the API is part of.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
apiId
|
string Pattern: (^[\w]+$)|(^[\w][\w\-]+[\w]$) Minimum: 1 Maximum: 80 |
API identifier. Must be unique in the current API Management service instance. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description | ||||||
---|---|---|---|---|---|---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
||||||
$skip
|
integer Minimum: 0 |
Number of records to skip. |
||||||
$top
|
integer Minimum: 1 |
Number of records to return. |
||||||
$filter
|
string |
|
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
body
|
Paged Products list representation. |
value
|
array [] |
Page values. |
nextLink
|
string |
Next page link if any. |
Deletes the schema configuration at the Api.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
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. |
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. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
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. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Get the schema configuration at the API level.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
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. |
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. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. |
Name | Data Type | Description |
---|---|---|
SchemaContract
|
The Resource definition. |
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. |
||||||||||||||||||||
Properties
|
Gets the entity state (Etag) version of the schema specified by its identifier.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
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. |
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. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. |
Creates or updates schema configuration for the API.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
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. |
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. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
If-Match
|
string |
ETag of the Entity. Not required when creating an entity, but required when updating an entity. |
Name | Data Type | Description |
---|---|---|
SchemaContract
|
The Resource definition. |
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. |
||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
SchemaContract
|
The Resource definition. |
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. |
||||||||||||||||||||
Properties
|
Name | Data Type | Description |
---|---|---|
SchemaContract
|
The Resource definition. |
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. |
||||||||||||||||||||
Properties
|
Get the schema configuration at the API level.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
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. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. |
Name | Data Type | Description |
---|---|---|
SchemaCollection
|
The response of the list schema operation. |
value
|
array [SchemaContract] |
Api Schema Contract value. |
|||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
Next page link if any. |
Deletes the specified API of the API Management service instance.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
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. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
deleteRevisions
|
boolean |
Delete all revisions of the Api. |
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. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Gets the details of the API specified by its identifier.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
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. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. |
Name | Data Type | Description |
---|---|---|
ApiContract
|
The Resource definition. |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
ApiEntityBaseContract
API base contract details. Properties
|
Gets the entity state (Etag) version of the API specified by its identifier.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
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. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. |
Updates the specified API of the API Management service instance.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
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. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
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. |
Name | Data Type | Description |
---|---|---|
ApiUpdateContract
|
API update contract details. |
properties
|
ApiContractUpdateProperties |
Properties of the API entity that can be updated. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
ApiEntityBaseContract
API base contract details. Properties
|
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Creates new or updates existing specified API of the API Management service instance.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
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. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
If-Match
|
string |
ETag of the Entity. Not required when creating an entity, but required when updating an entity. |
Name | Data Type | Description |
---|---|---|
ApiCreateOrUpdateParameter
|
API Create or Update Parameters. |
properties
|
ApiCreateOrUpdateProperties |
Api entity create of update properties. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
ApiContractProperties
Api Entity Properties Properties
Extends |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. |
Name | Data Type | Description |
---|---|---|
ApiContract
|
The Resource definition. |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
ApiEntityBaseContract
API base contract details. Properties
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. |
Name | Data Type | Description |
---|---|---|
ApiContract
|
The Resource definition. |
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. |
||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
ApiEntityBaseContract
API base contract details. Properties
|
Lists all APIs of the API Management service instance.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description | ||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
expandApiVersionSet
|
boolean Default value: false
|
Include full ApiVersionSet resource in response |
||||||||||||||||||
api-version
|
string |
Version of the API to be used with the client request. |
||||||||||||||||||
$skip
|
integer Minimum: 0 |
Number of records to skip. |
||||||||||||||||||
$top
|
integer Minimum: 1 |
Number of records to return. |
||||||||||||||||||
$filter
|
string |
|
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
ApiCollection
|
Paged Api list representation. |
value
|
array [ApiContract] |
Page values. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
|
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
nextLink
|
string Read-only |
Next page link if any. |
Lists a collection of apis associated with tags.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description | |||||||||||||||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
|||||||||||||||||||||||||||
$skip
|
integer Minimum: 0 |
Number of records to skip. |
|||||||||||||||||||||||||||
$top
|
integer Minimum: 1 |
Number of records to return. |
|||||||||||||||||||||||||||
$filter
|
string |
|
Name | Data Type | Description |
---|---|---|
body
|
Paged Tag list representation. |
value
|
array [] |
Page values. |
nextLink
|
string |
Next page link if any. |
count
|
long |
Total record count number across all pages. |
Deletes the specified operation in the API.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
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. |
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. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
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. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Gets the details of the API Operation specified by its identifier.
Name | Data Type | Description |
---|---|---|
subscriptionId
|
string |
Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. |
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. |
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. |
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. |
resourceGroupName
|
string |
The name of the resource group. |
Name | Data Type | Description |
---|---|---|
api-version
|
string |
Version of the API to be used with the client request. |
Name | Data Type | Description |
---|---|---|
body
|
Error Response. |
error
|
Name | Data Type | Description |
---|---|---|
ETag
|
string |
Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. |
Name | Data Type | Description |
---|---|---|
OperationContract
|
The Resource definition. |
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. |
|||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||||
Properties
Extends
OperationEntityBaseContract
Api Operation Entity Base Contract details. Properties
|