ApiManagementClient (preview:2017-03-01)

2025/10/30 • 141 new methods

Policy_List (new)
Description :  Lists all the Global Policy definitions of the Api Management service.
Reference :  Link ¶

⚼ Request

GET:  /policies
{
scope:
{
Description: Policy scope. ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Policy Contract value. ,
Required: False ,
}
[
{
id:
{
Description: Policy identifier. ,
Required: False ,
}
string ,
policyContent:
{
Description: Json escaped Xml Encoded contents of the Policy. ,
Required: True ,
}
string ,
}
,
]
,
count:
{
Description: Total number of records ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
Policy_Get (new)
Description :  Get the Global policy definition of the Api Management service.
Reference :  Link ¶

⚼ Request

GET:  /policies/{policyId}
{
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy contract Properties. ,
}
{
id:
{
Description: Policy identifier. ,
Required: False ,
}
string ,
policyContent:
{
Description: Json escaped Xml Encoded contents of the Policy. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Policy_CreateOrUpdate (new)
Description :  Creates or updates the global policy configuration of the Api Management service.
Reference :  Link ¶

⚼ Request

PUT:  /policies/{policyId}
{
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
parameters:
{
Description: The policy contents to apply. ,
Required: True ,
}
{
id:
{
Description: Policy identifier. ,
Required: False ,
}
string ,
policyContent:
{
Description: Json escaped Xml Encoded contents of the Policy. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Policy identifier. ,
Required: False ,
}
string ,
policyContent:
{
Description: Json escaped Xml Encoded contents of the Policy. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Policy identifier. ,
Required: False ,
}
string ,
policyContent:
{
Description: Json escaped Xml Encoded contents of the Policy. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Policy_Delete (new)
Description :  Deletes the global policy configuration of the Api Management Service.
Reference :  Link ¶

⚼ Request

DELETE:  /policies/{policyId}
{
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
If-Match:
{
Description: The entity state (Etag) version of the policy to be deleted. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
PolicySnippets_List (new)
Description :  Lists all policy snippets.
Reference :  Link ¶

⚼ Request

GET:  /policySnippets
{
scope:
{
Description: Policy scope. ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Policy snippet value. ,
Required: False ,
}
[
{
name:
{
Description: Snippet name. ,
Required: False ,
}
string ,
content:
{
Description: Snippet content. ,
Required: False ,
}
string ,
toolTip:
{
Description: Snippet toolTip. ,
Required: False ,
}
string ,
scope:
{
Description: Binary OR value of the Snippet scope. ,
Required: False ,
}
integer ,
}
,
]
,
}
Regions_List (new)
Description :  Lists all azure regions in which the service exists.
Reference :  Link ¶

⚼ Request

GET:  /regions
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Lists of Regions. ,
Required: False ,
}
[
{
name:
{
Description: Region name. ,
Required: False ,
}
string ,
isMasterRegion:
{
Description: whether Region is the master region. ,
Required: False ,
}
boolean ,
isDeleted:
{
Description: whether Region is deleted. ,
Required: False ,
}
boolean ,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
Api_List (new)
Description :  Lists all APIs of the API Management service instance.
Reference :  Link ¶

⚼ Request

GET:  /apis
{
$filter:
{
Description: | 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 | ,
Required: False ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Description: Identifier of the Entity ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total number of entities ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Api_Get (new)
Description :  Gets the details of the API specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /apis/{apiId}
{
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Api Contract Details ,
}
{
id:
{
Description: Identifier of the Entity ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Api_CreateOrUpdate (new)
Description :  Creates new or updates existing specified API of the API Management service instance.
Reference :  Link ¶

⚼ Request

PUT:  /apis/{apiId}
{
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create or update parameters. ,
Required: True ,
}
{
id:
{
Description: Identifier of the entity ,
Required: False ,
}
string ,
contentValue:
{
Description: Content value when Importing an API. ,
Required: False ,
}
string ,
contentFormat:
{
Description: Format of the Content in which the API is getting imported. ,
Enum:
{
wadl-xml: The contents are inline and Content type is a WADL document. ,
wadl-link-json: The WADL document is hosted on a publicly accessible internet address. ,
swagger-json: The contents are inline and Content Type if a OpenApi 2.0 Document. ,
swagger-link-json: The Open Api 2.0 document is hosted on a publicly accessible internet address. ,
wsdl: The contents are inline and the document is a WSDL/Soap document. ,
wsdl-link: The WSDL document is hosted on a publicly accessible internet address. ,
}
,
Required: False ,
}
enum ,
wsdlSelector:
{
Description: Criteria to limit import of WSDL to a subset of the document. ,
Required: False ,
}
{
wsdlServiceName:
{
Description: Name of service to import from WSDL ,
Required: False ,
}
string ,
wsdlEndpointName:
{
Description: Name of endpoint(port) to import from WSDL ,
Required: False ,
}
string ,
}
,
}
,
If-Match:
{
Description: ETag of the Api Entity. For Create Api Etag should not be specified. For Update Etag should match the existing Entity or it can be * for unconditional update. ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Api Contract Details ,
}
{
id:
{
Description: Identifier of the Entity ,
Required: False ,
}
string ,
}
,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Api Contract Details ,
}
{
id:
{
Description: Identifier of the Entity ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Api_Update (new)
Description :  Updates the specified API of the API Management service instance.
Reference :  Link ¶

⚼ Request

PATCH:  /apis/{apiId}
{
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: API Update Contract parameters. ,
Required: True ,
}
{
name:
{
Description: API name. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. ,
Required: False ,
}
string ,
path:
{
Description: 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. ,
Required: False ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: False ,
}
[
string ,
]
,
}
,
If-Match:
{
Description: ETag of the API entity. ETag should match the current entity state in the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Api_Delete (new)
Description :  Deletes the specified API of the API Management service instance.
Reference :  Link ¶

⚼ Request

DELETE:  /apis/{apiId}
{
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the API Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ApiOperation_ListByApi (new)
Description :  Lists a collection of the operations for the specified API.
Reference :  Link ¶

⚼ Request

GET:  /apis/{apiId}/operations
{
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Supported operators | Supported functions | |-------------|------------------------|-----------------------------------| | name | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | method | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | description | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | | urlTemplate | ge, le, eq, ne, gt, lt | substringof, startswith, endswith | ,
Required: False ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Identifier of the Operation. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total number of entities ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ApiOperation_Get (new)
Description :  Gets the details of the API Operation specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /apis/{apiId}/operations/{operationId}
{
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Api Operation details. ,
}
{
id:
{
Description: Identifier of the Operation. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ApiOperation_CreateOrUpdate (new)
Description :  Creates a new operation in the API or updates an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /apis/{apiId}/operations/{operationId}
{
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
id:
{
Description: Identifier of the Operation. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Identifier of the Operation. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Identifier of the Operation. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ApiOperation_Update (new)
Description :  Updates the details of the operation in the API specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /apis/{apiId}/operations/{operationId}
{
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: API Operation Update parameters. ,
Required: True ,
}
{
name:
{
Description: Operation Name. ,
Required: False ,
}
string ,
method:
{
Description: A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. ,
Required: False ,
}
string ,
urlTemplate:
{
Description: Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} ,
Required: False ,
}
string ,
}
,
If-Match:
{
Description: ETag of the API Operation Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ApiOperation_Delete (new)
Description :  Deletes the specified operation in the API.
Reference :  Link ¶

⚼ Request

DELETE:  /apis/{apiId}/operations/{operationId}
{
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the API Operation Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ApiOperationPolicy_ListByOperation (new)
Description :  Get the list of policy configuration at the API Operation level.
Reference :  Link ¶

⚼ Request

GET:  /apis/{apiId}/operations/{operationId}/policies
{
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Policy Contract value. ,
Required: False ,
}
[
{
id:
{
Description: Policy identifier. ,
Required: False ,
}
string ,
policyContent:
{
Description: Json escaped Xml Encoded contents of the Policy. ,
Required: True ,
}
string ,
}
,
]
,
count:
{
Description: Total number of records ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ApiOperationPolicy_Get (new)
Description :  Get the policy configuration at the API Operation level.
Reference :  Link ¶

⚼ Request

GET:  /apis/{apiId}/operations/{operationId}/policies/{policyId}
{
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy contract Properties. ,
}
{
id:
{
Description: Policy identifier. ,
Required: False ,
}
string ,
policyContent:
{
Description: Json escaped Xml Encoded contents of the Policy. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ApiOperationPolicy_CreateOrUpdate (new)
Description :  Creates or updates policy configuration for the API Operation level.
Reference :  Link ¶

⚼ Request

PUT:  /apis/{apiId}/operations/{operationId}/policies/{policyId}
{
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
parameters:
{
Description: The policy contents to apply. ,
Required: True ,
}
{
id:
{
Description: Policy identifier. ,
Required: False ,
}
string ,
policyContent:
{
Description: Json escaped Xml Encoded contents of the Policy. ,
Required: True ,
}
string ,
}
,
If-Match:
{
Description: The entity state (Etag) version of the Api Operation policy to update. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Policy identifier. ,
Required: False ,
}
string ,
policyContent:
{
Description: Json escaped Xml Encoded contents of the Policy. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Policy identifier. ,
Required: False ,
}
string ,
policyContent:
{
Description: Json escaped Xml Encoded contents of the Policy. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ApiOperationPolicy_Delete (new)
Description :  Deletes the policy configuration at the Api Operation.
Reference :  Link ¶

⚼ Request

DELETE:  /apis/{apiId}/operations/{operationId}/policies/{policyId}
{
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
operationId:
{
Description: Operation identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: The entity state (Etag) version of the Api Operation Policy to delete. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ApiProduct_ListByApis (new)
Description :  Lists all Products, which the API is part of.
Reference :  Link ¶

⚼ Request

GET:  /apis/{apiId}/products
{
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Supported operators | Supported functions | |-------|------------------------|---------------------------------------------| | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | ,
Required: False ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Identifier of the Product entity. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total number of entities ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ApiPolicy_ListByApi (new)
Description :  Get the policy configuration at the API level.
Reference :  Link ¶

⚼ Request

GET:  /apis/{apiId}/policies
{
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: The response of the list policy operation. ,
}
{
value:
{
Description: Policy Contract value. ,
Required: False ,
}
[
{
id:
{
Description: Policy identifier. ,
Required: False ,
}
string ,
policyContent:
{
Description: Json escaped Xml Encoded contents of the Policy. ,
Required: True ,
}
string ,
}
,
]
,
count:
{
Description: Total number of records ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ApiPolicy_Get (new)
Description :  Get the policy configuration at the API level.
Reference :  Link ¶

⚼ Request

GET:  /apis/{apiId}/policies/{policyId}
{
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy contract Properties. ,
}
{
id:
{
Description: Policy identifier. ,
Required: False ,
}
string ,
policyContent:
{
Description: Json escaped Xml Encoded contents of the Policy. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ApiPolicy_CreateOrUpdate (new)
Description :  Creates or updates policy configuration for the API.
Reference :  Link ¶

⚼ Request

PUT:  /apis/{apiId}/policies/{policyId}
{
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
parameters:
{
Description: The policy contents to apply. ,
Required: True ,
}
{
id:
{
Description: Policy identifier. ,
Required: False ,
}
string ,
policyContent:
{
Description: Json escaped Xml Encoded contents of the Policy. ,
Required: True ,
}
string ,
}
,
If-Match:
{
Description: The entity state (Etag) version of the Api Policy to update. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Policy identifier. ,
Required: False ,
}
string ,
policyContent:
{
Description: Json escaped Xml Encoded contents of the Policy. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Policy identifier. ,
Required: False ,
}
string ,
policyContent:
{
Description: Json escaped Xml Encoded contents of the Policy. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ApiPolicy_Delete (new)
Description :  Deletes the policy configuration at the Api.
Reference :  Link ¶

⚼ Request

DELETE:  /apis/{apiId}/policies/{policyId}
{
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
If-Match:
{
Description: The entity state (Etag) version of the Api policy to update. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ApiSchema_ListByApi (new)
Description :  Get the schema configuration at the API level.
Reference :  Link ¶

⚼ Request

GET:  /apis/{apiId}/schemas
{
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: The response of the list schema operation. ,
}
{
value:
{
Description: Api Schema Contract value. ,
Required: False ,
}
[
{
id:
{
Description: Identifier of the Schema. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total number of entities ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ApiSchema_Get (new)
Description :  Get the schema configuration at the API level.
Reference :  Link ¶

⚼ Request

GET:  /apis/{apiId}/schemas/{schemaId}
{
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
schemaId:
{
Description: Schema identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Schema Contract details. ,
}
{
id:
{
Description: Identifier of the Schema. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ApiSchema_CreateOrUpdate (new)
Description :  Creates or updates schema configuration for the API.
Reference :  Link ¶

⚼ Request

PUT:  /apis/{apiId}/schemas/{schemaId}
{
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
schemaId:
{
Description: Schema identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: The schema contents to apply. ,
Required: True ,
}
{
id:
{
Description: Identifier of the Schema. ,
Required: False ,
}
string ,
}
,
If-Match:
{
Description: The entity state (Etag) version of the Api Schema to update. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Identifier of the Schema. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Identifier of the Schema. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ApiSchema_Delete (new)
Description :  Deletes the schema configuration at the Api.
Reference :  Link ¶

⚼ Request

DELETE:  /apis/{apiId}/schemas/{schemaId}
{
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
schemaId:
{
Description: Schema identifier within an API. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: The entity state (Etag) version of the Api schema to update. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
AuthorizationServer_List (new)
Description :  Lists a collection of authorization servers defined within a service instance.
Reference :  Link ¶

⚼ Request

GET:  /authorizationServers
{
$filter:
{
Description: | 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 | ,
Required: False ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Identifier of the Authorization Server entity. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
AuthorizationServer_Get (new)
Description :  Gets the details of the authorization server specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /authorizationServers/{authsid}
{
authsid:
{
Description: Identifier of the authorization server. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: External OAuth authorization server settings. ,
}
{
id:
{
Description: Identifier of the Authorization Server entity. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
AuthorizationServer_CreateOrUpdate (new)
Description :  Creates new authorization server or updates an existing authorization server.
Reference :  Link ¶

⚼ Request

PUT:  /authorizationServers/{authsid}
{
authsid:
{
Description: Identifier of the authorization server. ,
Required: True ,
}
string ,
parameters:
{
Description: Create or update parameters. ,
Required: True ,
}
{
id:
{
Description: Identifier of the Authorization Server entity. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Identifier of the Authorization Server entity. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Identifier of the Authorization Server entity. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
AuthorizationServer_Update (new)
Description :  Updates the details of the authorization server specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /authorizationServers/{authsid}
{
authsid:
{
Description: Identifier of the authorization server. ,
Required: True ,
}
string ,
parameters:
{
Description: OAuth2 Server settings Update parameters. ,
Required: True ,
}
{
name:
{
Description: User-friendly authorization server name. ,
Required: False ,
}
string ,
clientRegistrationEndpoint:
{
Description: Optional reference to a page where client or app registration for this authorization server is performed. Contains absolute URL to entity being referenced. ,
Required: False ,
}
string ,
authorizationEndpoint:
{
Description: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. ,
Required: False ,
}
string ,
grantTypes:
{
Description: Form of an authorization grant, which the client uses to request the access token. ,
Required: False ,
}
[
string ,
]
,
clientId:
{
Description: Client or app id registered with this authorization server. ,
Required: False ,
}
string ,
}
,
If-Match:
{
Description: The entity state (Etag) version of the authorization server to update. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
AuthorizationServer_Delete (new)
Description :  Deletes specific authorization server instance.
Reference :  Link ¶

⚼ Request

DELETE:  /authorizationServers/{authsid}
{
authsid:
{
Description: Identifier of the authorization server. ,
Required: True ,
}
string ,
If-Match:
{
Description: The entity state (Etag) version of the authentication server to delete. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Backend_List (new)
Description :  Lists a collection of backends in the specified service instance.
Reference :  Link ¶

⚼ Request

GET:  /backends
{
$filter:
{
Description: | Field | Supported operators | Supported functions | |-------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | host | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | ,
Required: False ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Backend values. ,
Required: False ,
}
[
{
id:
{
Description: Identifier of the Backend entity. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total number of entities ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Backend_Get (new)
Description :  Gets the details of the backend specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /backends/{backendid}
{
backendid:
{
Description: Identifier of the Backend entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Backend details. ,
}
{
id:
{
Description: Identifier of the Backend entity. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Backend_CreateOrUpdate (new)
Description :  Creates or Updates a backend.
Reference :  Link ¶

⚼ Request

PUT:  /backends/{backendid}
{
backendid:
{
Description: Identifier of the Backend entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
id:
{
Description: Identifier of the Backend entity. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Identifier of the Backend entity. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Identifier of the Backend entity. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Backend_Update (new)
Description :  Updates an existing backend.
Reference :  Link ¶

⚼ Request

PATCH:  /backends/{backendid}
{
backendid:
{
Description: Identifier of the Backend entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
url:
{
Description: Runtime Url of the Backend. ,
Required: False ,
}
string ,
protocol:
{
Description: Backend communication protocol. ,
Enum:
{
http: The Backend is a RESTful service. ,
soap: The Backend is a SOAP service. ,
}
,
Required: False ,
}
enum ,
}
,
If-Match:
{
Description: The entity state (Etag) version of the backend to update. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Backend_Delete (new)
Description :  Deletes the specified backend.
Reference :  Link ¶

⚼ Request

DELETE:  /backends/{backendid}
{
backendid:
{
Description: Identifier of the Backend entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: The entity state (Etag) version of the backend to delete. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Certificate_List (new)
Description :  Lists a collection of all certificates in the specified service instance.
Reference :  Link ¶

⚼ Request

GET:  /certificates
{
$filter:
{
Description: | Field | Supported operators | Supported functions | |----------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | subject | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | thumbprint | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | expirationDate | ge, le, eq, ne, gt, lt | N/A | ,
Required: False ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Identifier of the Certificate entity. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total number of entities ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Certificate_Get (new)
Description :  Gets the details of the certificate specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /certificates/{certificateId}
{
certificateId:
{
Description: Identifier of the certificate entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Certificate details. ,
}
{
id:
{
Description: Identifier of the Certificate entity. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Certificate_CreateOrUpdate (new)
Description :  Creates or updates the certificate being used for authentication with the backend.
Reference :  Link ¶

⚼ Request

PUT:  /certificates/{certificateId}
{
certificateId:
{
Description: Identifier of the certificate entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create or Update parameters. ,
Required: True ,
}
{
data:
{
Description: Base 64 encoded certificate using the application/x-pkcs12 representation. ,
Required: True ,
}
string ,
password:
{
Description: Password for the Certificate ,
Required: True ,
}
string ,
}
,
If-Match:
{
Description: The entity state (Etag) version of the certificate to update. A value of "*" can be used for If-Match to unconditionally apply the operation.. ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Identifier of the Certificate entity. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Identifier of the Certificate entity. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Certificate_Delete (new)
Description :  Deletes specific certificate.
Reference :  Link ¶

⚼ Request

DELETE:  /certificates/{certificateId}
{
certificateId:
{
Description: Identifier of the certificate entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: The entity state (Etag) version of the certificate to delete. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
EmailTemplate_List (new)
Description :  Lists a collection of properties defined within a service instance.
Reference :  Link ¶

⚼ Request

GET:  /templates
{
$filter:
{
Description: | Field | Supported operators | Supported functions | |----------------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | ,
Required: False ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Identifier of the Template Contract. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total number of entities ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
EmailTemplate_Get (new)
Description :  Gets the details of the email template specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /templates/{templateName}
{
templateName:
{
Description: Email Template Name Identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Email Template details. ,
}
{
id:
{
Description: Identifier of the Template Contract. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
EmailTemplate_CreateOrUpdate (new)
Description :  Updates an Email Template.
Reference :  Link ¶

⚼ Request

PUT:  /templates/{templateName}
{
templateName:
{
Description: Email Template Name Identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: Email Template update parameters. ,
Required: True ,
}
{
subject:
{
Description: Subject of the Template. ,
Required: False ,
}
string ,
title:
{
Description: Title of the Template. ,
Required: False ,
}
string ,
description:
{
Description: Description of the Email Template. ,
Required: False ,
}
string ,
body:
{
Description: Email Template Body. This should be a valid XDocument ,
Required: False ,
}
string ,
parameters:
{
Description: Email Template Parameter values. ,
Required: False ,
}
[
{
name:
{
Description: Template parameter name. ,
Required: False ,
}
string ,
title:
{
Description: Template parameter title. ,
Required: False ,
}
string ,
description:
{
Description: Template parameter description. ,
Required: False ,
}
string ,
}
,
]
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Identifier of the Template Contract. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Identifier of the Template Contract. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
EmailTemplate_Update (new)
Description :  Updates the specific Email Template.
Reference :  Link ¶

⚼ Request

PATCH:  /templates/{templateName}
{
templateName:
{
Description: Email Template Name Identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
subject:
{
Description: Subject of the Template. ,
Required: False ,
}
string ,
title:
{
Description: Title of the Template. ,
Required: False ,
}
string ,
description:
{
Description: Description of the Email Template. ,
Required: False ,
}
string ,
body:
{
Description: Email Template Body. This should be a valid XDocument ,
Required: False ,
}
string ,
parameters:
{
Description: Email Template Parameter values. ,
Required: False ,
}
[
{
name:
{
Description: Template parameter name. ,
Required: False ,
}
string ,
title:
{
Description: Template parameter title. ,
Required: False ,
}
string ,
description:
{
Description: Template parameter description. ,
Required: False ,
}
string ,
}
,
]
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
EmailTemplate_Delete (new)
Description :  Reset the Email Template to default template provided by the API Management service instance.
Reference :  Link ¶

⚼ Request

DELETE:  /templates/{templateName}
{
templateName:
{
Description: Email Template Name Identifier. ,
Required: True ,
}
string ,
If-Match:
{
Description: The entity state (Etag) version of the Email Template to delete. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Group_List (new)
Description :  Lists a collection of groups defined within a service instance.
Reference :  Link ¶

⚼ Request

GET:  /groups
{
$filter:
{
Description: | 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 | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | type | eq, ne | N/A | ,
Required: False ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Identifier of the Group entity. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total number of entities ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
Group_Get (new)
Description :  Gets the details of the group specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /groups/{groupId}
{
groupId:
{
Description: Group identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Contract details. ,
}
{
id:
{
Description: Identifier of the Group entity. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Group_CreateOrUpdate (new)
Description :  Creates or Updates a group.
Reference :  Link ¶

⚼ Request

PUT:  /groups/{groupId}
{
groupId:
{
Description: Group identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
name:
{
Description: Group name. ,
Required: True ,
}
string ,
description:
{
Description: Group description. ,
Required: False ,
}
string ,
type:
{
Description: Group type. ,
Enum:
{
custom: No description available. ,
system: No description available. ,
external: No description available. ,
}
,
Required: False ,
}
enum ,
externalId:
{
Description: Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://.onmicrosoft.com/groups/; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Identifier of the Group entity. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Identifier of the Group entity. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Group_Update (new)
Description :  Updates the details of the group specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /groups/{groupId}
{
groupId:
{
Description: Group identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
name:
{
Description: Group name. ,
Required: False ,
}
string ,
description:
{
Description: Group description. ,
Required: False ,
}
string ,
type:
{
Description: Group type. ,
Enum:
{
custom: No description available. ,
system: No description available. ,
external: No description available. ,
}
,
Required: False ,
}
enum ,
externalId:
{
Description: Identifier of the external groups, this property contains the id of the group from the external identity provider, e.g. for Azure Active Directory aad://.onmicrosoft.com/groups/; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
If-Match:
{
Description: ETag of the Group Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Group_Delete (new)
Description :  Deletes specific group of the API Management service instance.
Reference :  Link ¶

⚼ Request

DELETE:  /groups/{groupId}
{
groupId:
{
Description: Group identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Group Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
GroupUser_List (new)
Description :  Lists a collection of the members of the group, specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /groups/{groupId}/users
{
groupId:
{
Description: Group identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$filter:
{
Description: | Field | Supported operators | Supported functions | |------------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | firstName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | lastName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | email | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | eq | N/A | | registrationDate | ge, le, eq, ne, gt, lt | N/A | | note | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | ,
Required: False ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Identifier of the entity. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total number of entities ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
GroupUser_Create (new)
Description :  Adds a user to the specified group.
Reference :  Link ¶

⚼ Request

PUT:  /groups/{groupId}/users/{uid}
{
groupId:
{
Description: Group identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
uid:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Identifier of the entity. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Identifier of the entity. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
GroupUser_Delete (new)
Description :  Remove existing user from existing group.
Reference :  Link ¶

⚼ Request

DELETE:  /groups/{groupId}/users/{uid}
{
groupId:
{
Description: Group identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
uid:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
IdentityProvider_List (new)
Description :  Lists a collection of Identity Provider configured in the specified service instance.
Reference :  Link ¶

⚼ Request

GET:  /identityProviders
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Identity Provider configuration values. ,
Required: False ,
}
[
{
id:
{
Description: Identifier of the identity provider. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total number of identity providers ,
Required: False ,
}
integer ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
IdentityProvider_Get (new)
Description :  Gets the configuration details of the identity Provider configured in specified service instance.
Reference :  Link ¶

⚼ Request

GET:  /identityProviders/{identityProviderName}
{
identityProviderName:
{
Description: Identity Provider Type identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Identity Provider details. ,
}
{
id:
{
Description: Identifier of the identity provider. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
IdentityProvider_CreateOrUpdate (new)
Description :  Creates or Updates the IdentityProvider configuration.
Reference :  Link ¶

⚼ Request

PUT:  /identityProviders/{identityProviderName}
{
identityProviderName:
{
Description: Identity Provider Type identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
id:
{
Description: Identifier of the identity provider. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Identifier of the identity provider. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Identifier of the identity provider. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
IdentityProvider_Update (new)
Description :  Updates an existing IdentityProvider configuration.
Reference :  Link ¶

⚼ Request

PATCH:  /identityProviders/{identityProviderName}
{
identityProviderName:
{
Description: Identity Provider Type identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
clientId:
{
Description: Client Id of the Application in the external Identity Provider. It is App ID for Facebook login, Client ID for Google login, App ID for Microsoft. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client secret of the Application in external Identity Provider, used to authenticate login request. For example, it is App Secret for Facebook login, API Key for Google login, Public Key for Microsoft. ,
Required: False ,
}
string ,
}
,
If-Match:
{
Description: The entity state (Etag) version of the identity provider configuration to update. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
IdentityProvider_Delete (new)
Description :  Deletes the specified identity provider configuration.
Reference :  Link ¶

⚼ Request

DELETE:  /identityProviders/{identityProviderName}
{
identityProviderName:
{
Description: Identity Provider Type identifier. ,
Required: True ,
}
string ,
If-Match:
{
Description: The entity state (Etag) version of the backend to delete. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Logger_List (new)
Description :  Lists a collection of loggers in the specified service instance.
Reference :  Link ¶

⚼ Request

GET:  /loggers
{
$filter:
{
Description: | Field | Supported operators | Supported functions | |-------|------------------------|---------------------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | type | eq | | ,
Required: False ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Logger values. ,
Required: False ,
}
[
{
id:
{
Description: Identifier of the Logger Entity. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Logger_Get (new)
Description :  Gets the details of the logger specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /loggers/{loggerid}
{
loggerid:
{
Description: Logger identifier. Must be unique in the API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Logger details. ,
}
{
id:
{
Description: Identifier of the Logger Entity. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Logger_CreateOrUpdate (new)
Description :  Creates or Updates a logger.
Reference :  Link ¶

⚼ Request

PUT:  /loggers/{loggerid}
{
loggerid:
{
Description: Logger identifier. Must be unique in the API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
id:
{
Description: Identifier of the Logger Entity. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Identifier of the Logger Entity. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Identifier of the Logger Entity. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Logger_Update (new)
Description :  Updates an existing logger.
Reference :  Link ¶

⚼ Request

PATCH:  /loggers/{loggerid}
{
loggerid:
{
Description: Logger identifier. Must be unique in the API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
loggerType:
{
Description: Logger type. ,
Enum:
{
azureEventHub: Azure Event Hub as log destination. ,
}
,
Required: False ,
}
enum ,
description:
{
Description: Logger description. ,
Required: False ,
}
string ,
credentials:
{
Description: Logger credentials. ,
Required: False ,
}
object ,
isBuffered:
{
Description: Whether records are buffered in the logger before publishing. Default is assumed to be true. ,
Required: False ,
}
boolean ,
}
,
If-Match:
{
Description: The entity state (Etag) version of the logger to update. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Logger_Delete (new)
Description :  Deletes the specified logger.
Reference :  Link ¶

⚼ Request

DELETE:  /loggers/{loggerid}
{
loggerid:
{
Description: Logger identifier. Must be unique in the API Management service instance. ,
Required: True ,
}
string ,
If-Match:
{
Description: The entity state (Etag) version of the logger to delete. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
OpenIdConnectProvider_List (new)
Description :  Lists all OpenID Connect Providers.
Reference :  Link ¶

⚼ Request

GET:  /openidConnectProviders
{
$filter:
{
Description: | 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 | ,
Required: False ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Identifier of the OpenId Connect Provider. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total number of entities ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
OpenIdConnectProvider_Get (new)
Description :  Gets specific OpenID Connect Provider.
Reference :  Link ¶

⚼ Request

GET:  /openidConnectProviders/{opid}
{
opid:
{
Description: Identifier of the OpenID Connect Provider. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: OpenId Connect Provider details. ,
}
{
id:
{
Description: Identifier of the OpenId Connect Provider. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
OpenIdConnectProvider_CreateOrUpdate (new)
Description :  Creates or updates the OpenID Connect Provider.
Reference :  Link ¶

⚼ Request

PUT:  /openidConnectProviders/{opid}
{
opid:
{
Description: Identifier of the OpenID Connect Provider. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
id:
{
Description: Identifier of the OpenId Connect Provider. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Identifier of the OpenId Connect Provider. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Identifier of the OpenId Connect Provider. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
OpenIdConnectProvider_Update (new)
Description :  Updates the specific OpenID Connect Provider.
Reference :  Link ¶

⚼ Request

PATCH:  /openidConnectProviders/{opid}
{
opid:
{
Description: Identifier of the OpenID Connect Provider. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
name:
{
Description: User-friendly OpenID Connect Provider name. ,
Required: False ,
}
string ,
description:
{
Description: User-friendly description of OpenID Connect Provider. ,
Required: False ,
}
string ,
metadataEndpoint:
{
Description: Metadata endpoint URI. ,
Required: False ,
}
string ,
clientId:
{
Description: Client ID of developer console which is the client application. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client Secret of developer console which is the client application. ,
Required: False ,
}
string ,
}
,
If-Match:
{
Description: The entity state (Etag) version of the OpenID Connect Provider to update. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
OpenIdConnectProvider_Delete (new)
Description :  Deletes specific OpenID Connect Provider of the API Management service instance.
Reference :  Link ¶

⚼ Request

DELETE:  /openidConnectProviders/{opid}
{
opid:
{
Description: Identifier of the OpenID Connect Provider. ,
Required: True ,
}
string ,
If-Match:
{
Description: The entity state (Etag) version of the OpenID Connect Provider to delete. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
SignInSettings_Get (new)
Description :  Get Sign-In settings.
Reference :  Link ¶

⚼ Request

GET:  /portalsettings/signin
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Sign-In settings for the Developer Portal. ,
}
{
enabled:
{
Description: Redirect Anonymous users to the Sign-In page. ,
Required: False ,
}
boolean ,
}
,
}
SignInSettings_Update (new)
Description :  Update Sign-In settings.
Reference :  Link ¶

⚼ Request

PATCH:  /portalsettings/signin
{
parameters:
{
Description: Update Sign-In settings. ,
Required: True ,
}
{
enabled:
{
Description: Redirect Anonymous users to the Sign-In page. ,
Required: False ,
}
boolean ,
}
,
If-Match:
{
Description: The entity state (Etag) version of the property to update. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
SignInSettings_CreateOrUpdate (new)
Description :  Create or Update Sign-In settings.
Reference :  Link ¶

⚼ Request

PUT:  /portalsettings/signin
{
parameters:
{
Description: Create or update parameters. ,
Required: True ,
}
{
enabled:
{
Description: Redirect Anonymous users to the Sign-In page. ,
Required: False ,
}
boolean ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{
enabled:
{
Description: Redirect Anonymous users to the Sign-In page. ,
Required: False ,
}
boolean ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
SignUpSettings_Get (new)
Description :  Get Sign-Up settings.
Reference :  Link ¶

⚼ Request

GET:  /portalsettings/signup
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Sign-up settings contract properties. ,
}
{
enabled:
{
Description: Allow users to sign up on a developer portal. ,
Required: False ,
}
boolean ,
termsOfService:
{
Description: Terms of service contract properties. ,
Required: False ,
}
{
text:
{
Description: A terms of service text. ,
Required: False ,
}
string ,
enabled:
{
Description: Display terms of service during a sign-up process. ,
Required: False ,
}
boolean ,
consentRequired:
{
Description: Ask user for consent to the terms of service. ,
Required: False ,
}
boolean ,
}
,
}
,
}
SignUpSettings_Update (new)
Description :  Update Sign-Up settings.
Reference :  Link ¶

⚼ Request

PATCH:  /portalsettings/signup
{
parameters:
{
Description: Update Sign-Up settings. ,
Required: True ,
}
{
enabled:
{
Description: Allow users to sign up on a developer portal. ,
Required: False ,
}
boolean ,
termsOfService:
{
Description: Terms of service contract properties. ,
Required: False ,
}
{
text:
{
Description: A terms of service text. ,
Required: False ,
}
string ,
enabled:
{
Description: Display terms of service during a sign-up process. ,
Required: False ,
}
boolean ,
consentRequired:
{
Description: Ask user for consent to the terms of service. ,
Required: False ,
}
boolean ,
}
,
}
,
If-Match:
{
Description: The entity state (Etag) version of the property to update. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
SignUpSettings_CreateOrUpdate (new)
Description :  Create or Update Sign-Up settings.
Reference :  Link ¶

⚼ Request

PUT:  /portalsettings/signup
{
parameters:
{
Description: Create or update parameters. ,
Required: True ,
}
{
enabled:
{
Description: Allow users to sign up on a developer portal. ,
Required: False ,
}
boolean ,
termsOfService:
{
Description: Terms of service contract properties. ,
Required: False ,
}
{
text:
{
Description: A terms of service text. ,
Required: False ,
}
string ,
enabled:
{
Description: Display terms of service during a sign-up process. ,
Required: False ,
}
boolean ,
consentRequired:
{
Description: Ask user for consent to the terms of service. ,
Required: False ,
}
boolean ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{
enabled:
{
Description: Allow users to sign up on a developer portal. ,
Required: False ,
}
boolean ,
termsOfService:
{
Description: Terms of service contract properties. ,
Required: False ,
}
{
text:
{
Description: A terms of service text. ,
Required: False ,
}
string ,
enabled:
{
Description: Display terms of service during a sign-up process. ,
Required: False ,
}
boolean ,
consentRequired:
{
Description: Ask user for consent to the terms of service. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
DelegationSettings_Get (new)
Description :  Get Delegation settings.
Reference :  Link ¶

⚼ Request

GET:  /portalsettings/delegation
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Delegation settings for a developer portal. ,
}
{
url:
{
Description: A delegation Url. ,
Required: False ,
}
string ,
validationKey:
{
Description: A base64-encoded validation key to validate, that a request is coming from Azure API Management. ,
Required: False ,
}
string ,
subscriptions:
{
Description: Subscriptions delegation settings. ,
Required: False ,
}
{
enabled:
{
Description: Enable or disable delegation for subscriptions. ,
Required: False ,
}
boolean ,
}
,
userRegistration:
{
Description: User registration delegation settings. ,
Required: False ,
}
{
enabled:
{
Description: Enable or disable delegation for user registration. ,
Required: False ,
}
boolean ,
}
,
}
,
}
DelegationSettings_Update (new)
Description :  Update Delegation settings.
Reference :  Link ¶

⚼ Request

PATCH:  /portalsettings/delegation
{
parameters:
{
Description: Update Delegation settings. ,
Required: True ,
}
{
url:
{
Description: A delegation Url. ,
Required: False ,
}
string ,
validationKey:
{
Description: A base64-encoded validation key to validate, that a request is coming from Azure API Management. ,
Required: False ,
}
string ,
subscriptions:
{
Description: Subscriptions delegation settings. ,
Required: False ,
}
{
enabled:
{
Description: Enable or disable delegation for subscriptions. ,
Required: False ,
}
boolean ,
}
,
userRegistration:
{
Description: User registration delegation settings. ,
Required: False ,
}
{
enabled:
{
Description: Enable or disable delegation for user registration. ,
Required: False ,
}
boolean ,
}
,
}
,
If-Match:
{
Description: The entity state (Etag) version of the property to update. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
DelegationSettings_CreateOrUpdate (new)
Description :  Create or Update Delegation settings.
Reference :  Link ¶

⚼ Request

PUT:  /portalsettings/delegation
{
parameters:
{
Description: Create or update parameters. ,
Required: True ,
}
{
url:
{
Description: A delegation Url. ,
Required: False ,
}
string ,
validationKey:
{
Description: A base64-encoded validation key to validate, that a request is coming from Azure API Management. ,
Required: False ,
}
string ,
subscriptions:
{
Description: Subscriptions delegation settings. ,
Required: False ,
}
{
enabled:
{
Description: Enable or disable delegation for subscriptions. ,
Required: False ,
}
boolean ,
}
,
userRegistration:
{
Description: User registration delegation settings. ,
Required: False ,
}
{
enabled:
{
Description: Enable or disable delegation for user registration. ,
Required: False ,
}
boolean ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{
url:
{
Description: A delegation Url. ,
Required: False ,
}
string ,
validationKey:
{
Description: A base64-encoded validation key to validate, that a request is coming from Azure API Management. ,
Required: False ,
}
string ,
subscriptions:
{
Description: Subscriptions delegation settings. ,
Required: False ,
}
{
enabled:
{
Description: Enable or disable delegation for subscriptions. ,
Required: False ,
}
boolean ,
}
,
userRegistration:
{
Description: User registration delegation settings. ,
Required: False ,
}
{
enabled:
{
Description: Enable or disable delegation for user registration. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Product_List (new)
Description :  Lists a collection of products in the specified service instance.
Reference :  Link ¶

⚼ Request

GET:  /products
{
$filter:
{
Description: | 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 | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | terms | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | eq | | ,
Required: False ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
expandGroups:
{
Description: When set to true, the response contains an array of groups that have visibility to the product. The default is false. ,
Required: False ,
}
boolean ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Identifier of the Product entity. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total number of entities ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Product_Get (new)
Description :  Gets the details of the product specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /products/{productId}
{
productId:
{
Description: Product identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Product details. ,
}
{
id:
{
Description: Identifier of the Product entity. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Product_CreateOrUpdate (new)
Description :  Creates or Updates a product.
Reference :  Link ¶

⚼ Request

PUT:  /products/{productId}
{
productId:
{
Description: Product identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create or update parameters. ,
Required: True ,
}
{
id:
{
Description: Identifier of the Product entity. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Identifier of the Product entity. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Identifier of the Product entity. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Product_Update (new)
Description :  Update product.
Reference :  Link ¶

⚼ Request

PATCH:  /products/{productId}
{
productId:
{
Description: Product identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
name:
{
Description: Product name. ,
Required: False ,
}
string ,
}
,
If-Match:
{
Description: ETag of the Product Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Product_Delete (new)
Description :  Delete product.
Reference :  Link ¶

⚼ Request

DELETE:  /products/{productId}
{
productId:
{
Description: Product identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
deleteSubscriptions:
{
Description: Delete existing subscriptions to the product or not. ,
Required: False ,
}
boolean ,
If-Match:
{
Description: ETag of the Product Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ProductApi_ListByProduct (new)
Description :  Lists a collection of the APIs associated with a product.
Reference :  Link ¶

⚼ Request

GET:  /products/{productId}/apis
{
productId:
{
Description: Product identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$filter:
{
Description: | 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 | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | serviceUrl | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | path | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | ,
Required: False ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Required: False ,
}
[
{
id:
{
Description: Identifier of the Entity ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total number of entities ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ProductApi_CreateOrUpdate (new)
Description :  Adds an API to the specified product.
Reference :  Link ¶

⚼ Request

PUT:  /products/{productId}/apis/{apiId}
{
productId:
{
Description: Product identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Identifier of the Entity ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Identifier of the Entity ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ProductApi_Delete (new)
Description :  Deletes the specified API from the specified product.
Reference :  Link ¶

⚼ Request

DELETE:  /products/{productId}/apis/{apiId}
{
productId:
{
Description: Product identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ProductGroup_ListByProduct (new)
Description :  Lists the collection of developer groups associated with the specified product.
Reference :  Link ¶

⚼ Request

GET:  /products/{productId}/groups
{
productId:
{
Description: Product identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$filter:
{
Description: | 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 | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | type | eq, ne | N/A | ,
Required: False ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Identifier of the Group entity. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total number of entities ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ProductGroup_CreateOrUpdate (new)
Description :  Adds the association between the specified developer group with the specified product.
Reference :  Link ¶

⚼ Request

PUT:  /products/{productId}/groups/{groupId}
{
productId:
{
Description: Product identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
groupId:
{
Description: Group identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Identifier of the Group entity. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Identifier of the Group entity. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ProductGroup_Delete (new)
Description :  Deletes the association between the specified group and product.
Reference :  Link ¶

⚼ Request

DELETE:  /products/{productId}/groups/{groupId}
{
productId:
{
Description: Product identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
groupId:
{
Description: Group identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ProductSubscriptions_List (new)
Description :  Lists the collection of subscriptions to the specified product.
Reference :  Link ¶

⚼ Request

GET:  /products/{productId}/subscriptions
{
productId:
{
Description: Product identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$filter:
{
Description: | 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 | | stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | eq | | ,
Required: False ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Identifier of the Subscription. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total number of entities ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ProductPolicy_ListByProduct (new)
Description :  Get the policy configuration at the Product level.
Reference :  Link ¶

⚼ Request

GET:  /products/{productId}/policies
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
productId:
{
Description: Product identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: The response of the list policy operation. ,
}
{
value:
{
Description: Policy Contract value. ,
Required: False ,
}
[
{
id:
{
Description: Policy identifier. ,
Required: False ,
}
string ,
policyContent:
{
Description: Json escaped Xml Encoded contents of the Policy. ,
Required: True ,
}
string ,
}
,
]
,
count:
{
Description: Total number of records ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ProductPolicy_Get (new)
Description :  Get the policy configuration at the Product level.
Reference :  Link ¶

⚼ Request

GET:  /products/{productId}/policies/{policyId}
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
productId:
{
Description: Product identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Policy contract Properties. ,
}
{
id:
{
Description: Policy identifier. ,
Required: False ,
}
string ,
policyContent:
{
Description: Json escaped Xml Encoded contents of the Policy. ,
Required: True ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ProductPolicy_CreateOrUpdate (new)
Description :  Creates or updates policy configuration for the Product.
Reference :  Link ¶

⚼ Request

PUT:  /products/{productId}/policies/{policyId}
{
productId:
{
Description: Product identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
parameters:
{
Description: The policy contents to apply. ,
Required: True ,
}
{
id:
{
Description: Policy identifier. ,
Required: False ,
}
string ,
policyContent:
{
Description: Json escaped Xml Encoded contents of the Policy. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Policy identifier. ,
Required: False ,
}
string ,
policyContent:
{
Description: Json escaped Xml Encoded contents of the Policy. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Policy identifier. ,
Required: False ,
}
string ,
policyContent:
{
Description: Json escaped Xml Encoded contents of the Policy. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
ProductPolicy_Delete (new)
Description :  Deletes the policy configuration at the Product.
Reference :  Link ¶

⚼ Request

DELETE:  /products/{productId}/policies/{policyId}
{
productId:
{
Description: Product identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
policyId:
{
Description: The identifier of the Policy. ,
Required: True ,
}
string ,
If-Match:
{
Description: The entity state (Etag) version of the product policy to update. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Property_List (new)
Description :  Lists a collection of properties defined within a service instance.
Reference :  Link ¶

⚼ Request

GET:  /properties
{
$filter:
{
Description: | Field | Supported operators | Supported functions | |-------|------------------------|-------------------------------------------------------| | tags | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith, any, all | | name | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | ,
Required: False ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Identifier of the Property. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total number of entities ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
Property_Get (new)
Description :  Gets the details of the property specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /properties/{propId}
{
propId:
{
Description: Identifier of the property. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Property details. ,
}
{
id:
{
Description: Identifier of the Property. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Property_CreateOrUpdate (new)
Description :  Creates or updates a property.
Reference :  Link ¶

⚼ Request

PUT:  /properties/{propId}
{
propId:
{
Description: Identifier of the property. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
id:
{
Description: Identifier of the Property. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Identifier of the Property. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Identifier of the Property. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Property_Update (new)
Description :  Updates the specific property.
Reference :  Link ¶

⚼ Request

PATCH:  /properties/{propId}
{
propId:
{
Description: Identifier of the property. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
name:
{
Description: Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters. ,
Required: False ,
}
string ,
value:
{
Description: Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace. ,
Required: False ,
}
string ,
}
,
If-Match:
{
Description: The entity state (Etag) version of the property to update. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Property_Delete (new)
Description :  Deletes specific property from the API Management service instance.
Reference :  Link ¶

⚼ Request

DELETE:  /properties/{propId}
{
propId:
{
Description: Identifier of the property. ,
Required: True ,
}
string ,
If-Match:
{
Description: The entity state (Etag) version of the property to delete. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
QuotaByCounterKeys_List (new)
Description :  Lists a collection of current quota counter periods associated with the counter-key configured in the policy on the specified service instance. The api does not support paging yet.
Reference :  Link ¶

⚼ Request

GET:  /quotas/{quotaCounterKey}
{
quotaCounterKey:
{
Description: Quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key="boo" in the policy, then it’s accessible by "boo" counter key. But if it’s defined as counter-key="@("b"+"a")" then it will be accessible by "ba" key ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Quota counter values. ,
Required: False ,
}
[
{
counterKey:
{
Description: The Key value of the Counter. Must not be empty. ,
Required: True ,
}
string ,
periodKey:
{
Description: Identifier of the Period for which the counter was collected. Must not be empty. ,
Required: True ,
}
string ,
periodStartTime:
{
Description: The date of the start of Counter Period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: True ,
}
string ,
periodEndTime:
{
Description: The date of the end of Counter Period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: True ,
}
string ,
Value:
{
Description: Quota Value Properties ,
Required: False ,
}
{
callsCount:
{
Description: Number of times Counter was called. ,
Format: int32 ,
Required: False ,
}
integer ,
kbTransferred:
{
Description: Data Transferred in KiloBytes. ,
Format: double ,
Required: False ,
}
number ,
}
,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
QuotaByCounterKeys_Update (new)
Description :  Updates all the quota counter values specified with the existing quota counter key to a value in the specified service instance. This should be used for reset of the quota counter values.
Reference :  Link ¶

⚼ Request

PATCH:  /quotas/{quotaCounterKey}
{
quotaCounterKey:
{
Description: Quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key="boo" in the policy, then it’s accessible by "boo" counter key. But if it’s defined as counter-key="@("b"+"a")" then it will be accessible by "ba" key ,
Required: True ,
}
string ,
parameters:
{
Description: The value of the quota counter to be applied to all quota counter periods. ,
Required: True ,
}
{
callsCount:
{
Description: Number of times Counter was called. ,
Format: int32 ,
Required: False ,
}
integer ,
kbTransferred:
{
Description: Data Transferred in KiloBytes. ,
Format: double ,
Required: False ,
}
number ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
QuotaByPeriodKeys_Get (new)
Description :  Gets the value of the quota counter associated with the counter-key in the policy for the specific period in service instance.
Reference :  Link ¶

⚼ Request

GET:  /quotas/{quotaCounterKey}/{quotaPeriodKey}
{
quotaCounterKey:
{
Description: Quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key="boo" in the policy, then it’s accessible by "boo" counter key. But if it’s defined as counter-key="@("b"+"a")" then it will be accessible by "ba" key ,
Required: True ,
}
string ,
quotaPeriodKey:
{
Description: Quota period key identifier. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
counterKey:
{
Description: The Key value of the Counter. Must not be empty. ,
Required: True ,
}
string ,
periodKey:
{
Description: Identifier of the Period for which the counter was collected. Must not be empty. ,
Required: True ,
}
string ,
periodStartTime:
{
Description: The date of the start of Counter Period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: True ,
}
string ,
periodEndTime:
{
Description: The date of the end of Counter Period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: True ,
}
string ,
Value:
{
Description: Quota Value Properties ,
Required: False ,
}
{
callsCount:
{
Description: Number of times Counter was called. ,
Format: int32 ,
Required: False ,
}
integer ,
kbTransferred:
{
Description: Data Transferred in KiloBytes. ,
Format: double ,
Required: False ,
}
number ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
QuotaByPeriodKeys_Update (new)
Description :  Updates an existing quota counter value in the specified service instance.
Reference :  Link ¶

⚼ Request

PATCH:  /quotas/{quotaCounterKey}/{quotaPeriodKey}
{
quotaCounterKey:
{
Description: Quota counter key identifier.This is the result of expression defined in counter-key attribute of the quota-by-key policy.For Example, if you specify counter-key="boo" in the policy, then it’s accessible by "boo" counter key. But if it’s defined as counter-key="@("b"+"a")" then it will be accessible by "ba" key ,
Required: True ,
}
string ,
quotaPeriodKey:
{
Description: Quota period key identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: The value of the Quota counter to be applied on the specified period. ,
Required: True ,
}
{
callsCount:
{
Description: Number of times Counter was called. ,
Format: int32 ,
Required: False ,
}
integer ,
kbTransferred:
{
Description: Data Transferred in KiloBytes. ,
Format: double ,
Required: False ,
}
number ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Reports_ListByApi (new)
Description :  Lists report records by API.
Reference :  Link ¶

⚼ Request

GET:  /reports/byApi
{
$filter:
{
Description: The filter to apply on the operation. ,
Required: True ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
name:
{
Description: Name depending on report endpoint specifies product, API, operation or developer name. ,
Required: False ,
}
string ,
timestamp:
{
Description: Start of aggregation period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
interval:
{
Description: Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations). ,
Required: False ,
}
string ,
country:
{
Description: Country to which this record data is related. ,
Required: False ,
}
string ,
region:
{
Description: Country region to which this record data is related. ,
Required: False ,
}
string ,
zip:
{
Description: Zip code to which this record data is related. ,
Required: False ,
}
string ,
userId:
{
Description: User identifier path. /users/{userId} ,
Required: False ,
}
string ,
productId:
{
Description: Product identifier path. /products/{productId} ,
Required: False ,
}
string ,
apiId:
{
Description: API identifier path. /apis/{apiId} ,
Required: False ,
}
string ,
operationId:
{
Description: Operation identifier path. /apis/{apiId}/operations/{operationId} ,
Required: False ,
}
string ,
apiRegion:
{
Description: API region identifier. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription identifier path. /subscriptions/{subscriptionId} ,
Required: False ,
}
string ,
callCountSuccess:
{
Description: Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect ,
Format: int32 ,
Required: False ,
}
integer ,
callCountBlocked:
{
Description: Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests ,
Format: int32 ,
Required: False ,
}
integer ,
callCountFailed:
{
Description: Number of calls failed due to proxy or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600 ,
Format: int32 ,
Required: False ,
}
integer ,
callCountOther:
{
Description: Number of other calls. ,
Format: int32 ,
Required: False ,
}
integer ,
callCountTotal:
{
Description: Total number of calls. ,
Format: int32 ,
Required: False ,
}
integer ,
bandwidth:
{
Description: Bandwidth consumed. ,
Format: int64 ,
Required: False ,
}
integer ,
cacheHitCount:
{
Description: Number of times when content was served from cache policy. ,
Format: int32 ,
Required: False ,
}
integer ,
cacheMissCount:
{
Description: Number of times content was fetched from backend. ,
Format: int32 ,
Required: False ,
}
integer ,
apiTimeAvg:
{
Description: Average time it took to process request. ,
Format: double ,
Required: False ,
}
number ,
apiTimeMin:
{
Description: Minimum time it took to process request. ,
Format: double ,
Required: False ,
}
number ,
apiTimeMax:
{
Description: Maximum time it took to process request. ,
Format: double ,
Required: False ,
}
number ,
serviceTimeAvg:
{
Description: Average time it took to process request on backend. ,
Format: double ,
Required: False ,
}
number ,
serviceTimeMin:
{
Description: Minimum time it took to process request on backend. ,
Format: double ,
Required: False ,
}
number ,
serviceTimeMax:
{
Description: Maximum time it took to process request on backend. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
Reports_ListByUser (new)
Description :  Lists report records by User.
Reference :  Link ¶

⚼ Request

GET:  /reports/byUser
{
$filter:
{
Description: The filter to apply on the operation. ,
Required: True ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
name:
{
Description: Name depending on report endpoint specifies product, API, operation or developer name. ,
Required: False ,
}
string ,
timestamp:
{
Description: Start of aggregation period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
interval:
{
Description: Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations). ,
Required: False ,
}
string ,
country:
{
Description: Country to which this record data is related. ,
Required: False ,
}
string ,
region:
{
Description: Country region to which this record data is related. ,
Required: False ,
}
string ,
zip:
{
Description: Zip code to which this record data is related. ,
Required: False ,
}
string ,
userId:
{
Description: User identifier path. /users/{userId} ,
Required: False ,
}
string ,
productId:
{
Description: Product identifier path. /products/{productId} ,
Required: False ,
}
string ,
apiId:
{
Description: API identifier path. /apis/{apiId} ,
Required: False ,
}
string ,
operationId:
{
Description: Operation identifier path. /apis/{apiId}/operations/{operationId} ,
Required: False ,
}
string ,
apiRegion:
{
Description: API region identifier. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription identifier path. /subscriptions/{subscriptionId} ,
Required: False ,
}
string ,
callCountSuccess:
{
Description: Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect ,
Format: int32 ,
Required: False ,
}
integer ,
callCountBlocked:
{
Description: Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests ,
Format: int32 ,
Required: False ,
}
integer ,
callCountFailed:
{
Description: Number of calls failed due to proxy or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600 ,
Format: int32 ,
Required: False ,
}
integer ,
callCountOther:
{
Description: Number of other calls. ,
Format: int32 ,
Required: False ,
}
integer ,
callCountTotal:
{
Description: Total number of calls. ,
Format: int32 ,
Required: False ,
}
integer ,
bandwidth:
{
Description: Bandwidth consumed. ,
Format: int64 ,
Required: False ,
}
integer ,
cacheHitCount:
{
Description: Number of times when content was served from cache policy. ,
Format: int32 ,
Required: False ,
}
integer ,
cacheMissCount:
{
Description: Number of times content was fetched from backend. ,
Format: int32 ,
Required: False ,
}
integer ,
apiTimeAvg:
{
Description: Average time it took to process request. ,
Format: double ,
Required: False ,
}
number ,
apiTimeMin:
{
Description: Minimum time it took to process request. ,
Format: double ,
Required: False ,
}
number ,
apiTimeMax:
{
Description: Maximum time it took to process request. ,
Format: double ,
Required: False ,
}
number ,
serviceTimeAvg:
{
Description: Average time it took to process request on backend. ,
Format: double ,
Required: False ,
}
number ,
serviceTimeMin:
{
Description: Minimum time it took to process request on backend. ,
Format: double ,
Required: False ,
}
number ,
serviceTimeMax:
{
Description: Maximum time it took to process request on backend. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
Reports_ListByOperation (new)
Description :  Lists report records by API Operations.
Reference :  Link ¶

⚼ Request

GET:  /reports/byOperation
{
$filter:
{
Description: The filter to apply on the operation. ,
Required: True ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
name:
{
Description: Name depending on report endpoint specifies product, API, operation or developer name. ,
Required: False ,
}
string ,
timestamp:
{
Description: Start of aggregation period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
interval:
{
Description: Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations). ,
Required: False ,
}
string ,
country:
{
Description: Country to which this record data is related. ,
Required: False ,
}
string ,
region:
{
Description: Country region to which this record data is related. ,
Required: False ,
}
string ,
zip:
{
Description: Zip code to which this record data is related. ,
Required: False ,
}
string ,
userId:
{
Description: User identifier path. /users/{userId} ,
Required: False ,
}
string ,
productId:
{
Description: Product identifier path. /products/{productId} ,
Required: False ,
}
string ,
apiId:
{
Description: API identifier path. /apis/{apiId} ,
Required: False ,
}
string ,
operationId:
{
Description: Operation identifier path. /apis/{apiId}/operations/{operationId} ,
Required: False ,
}
string ,
apiRegion:
{
Description: API region identifier. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription identifier path. /subscriptions/{subscriptionId} ,
Required: False ,
}
string ,
callCountSuccess:
{
Description: Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect ,
Format: int32 ,
Required: False ,
}
integer ,
callCountBlocked:
{
Description: Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests ,
Format: int32 ,
Required: False ,
}
integer ,
callCountFailed:
{
Description: Number of calls failed due to proxy or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600 ,
Format: int32 ,
Required: False ,
}
integer ,
callCountOther:
{
Description: Number of other calls. ,
Format: int32 ,
Required: False ,
}
integer ,
callCountTotal:
{
Description: Total number of calls. ,
Format: int32 ,
Required: False ,
}
integer ,
bandwidth:
{
Description: Bandwidth consumed. ,
Format: int64 ,
Required: False ,
}
integer ,
cacheHitCount:
{
Description: Number of times when content was served from cache policy. ,
Format: int32 ,
Required: False ,
}
integer ,
cacheMissCount:
{
Description: Number of times content was fetched from backend. ,
Format: int32 ,
Required: False ,
}
integer ,
apiTimeAvg:
{
Description: Average time it took to process request. ,
Format: double ,
Required: False ,
}
number ,
apiTimeMin:
{
Description: Minimum time it took to process request. ,
Format: double ,
Required: False ,
}
number ,
apiTimeMax:
{
Description: Maximum time it took to process request. ,
Format: double ,
Required: False ,
}
number ,
serviceTimeAvg:
{
Description: Average time it took to process request on backend. ,
Format: double ,
Required: False ,
}
number ,
serviceTimeMin:
{
Description: Minimum time it took to process request on backend. ,
Format: double ,
Required: False ,
}
number ,
serviceTimeMax:
{
Description: Maximum time it took to process request on backend. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
Reports_ListByProduct (new)
Description :  Lists report records by Product.
Reference :  Link ¶

⚼ Request

GET:  /reports/byProduct
{
$filter:
{
Description: The filter to apply on the operation. ,
Required: True ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
name:
{
Description: Name depending on report endpoint specifies product, API, operation or developer name. ,
Required: False ,
}
string ,
timestamp:
{
Description: Start of aggregation period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
interval:
{
Description: Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations). ,
Required: False ,
}
string ,
country:
{
Description: Country to which this record data is related. ,
Required: False ,
}
string ,
region:
{
Description: Country region to which this record data is related. ,
Required: False ,
}
string ,
zip:
{
Description: Zip code to which this record data is related. ,
Required: False ,
}
string ,
userId:
{
Description: User identifier path. /users/{userId} ,
Required: False ,
}
string ,
productId:
{
Description: Product identifier path. /products/{productId} ,
Required: False ,
}
string ,
apiId:
{
Description: API identifier path. /apis/{apiId} ,
Required: False ,
}
string ,
operationId:
{
Description: Operation identifier path. /apis/{apiId}/operations/{operationId} ,
Required: False ,
}
string ,
apiRegion:
{
Description: API region identifier. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription identifier path. /subscriptions/{subscriptionId} ,
Required: False ,
}
string ,
callCountSuccess:
{
Description: Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect ,
Format: int32 ,
Required: False ,
}
integer ,
callCountBlocked:
{
Description: Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests ,
Format: int32 ,
Required: False ,
}
integer ,
callCountFailed:
{
Description: Number of calls failed due to proxy or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600 ,
Format: int32 ,
Required: False ,
}
integer ,
callCountOther:
{
Description: Number of other calls. ,
Format: int32 ,
Required: False ,
}
integer ,
callCountTotal:
{
Description: Total number of calls. ,
Format: int32 ,
Required: False ,
}
integer ,
bandwidth:
{
Description: Bandwidth consumed. ,
Format: int64 ,
Required: False ,
}
integer ,
cacheHitCount:
{
Description: Number of times when content was served from cache policy. ,
Format: int32 ,
Required: False ,
}
integer ,
cacheMissCount:
{
Description: Number of times content was fetched from backend. ,
Format: int32 ,
Required: False ,
}
integer ,
apiTimeAvg:
{
Description: Average time it took to process request. ,
Format: double ,
Required: False ,
}
number ,
apiTimeMin:
{
Description: Minimum time it took to process request. ,
Format: double ,
Required: False ,
}
number ,
apiTimeMax:
{
Description: Maximum time it took to process request. ,
Format: double ,
Required: False ,
}
number ,
serviceTimeAvg:
{
Description: Average time it took to process request on backend. ,
Format: double ,
Required: False ,
}
number ,
serviceTimeMin:
{
Description: Minimum time it took to process request on backend. ,
Format: double ,
Required: False ,
}
number ,
serviceTimeMax:
{
Description: Maximum time it took to process request on backend. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
Reports_ListByGeo (new)
Description :  Lists report records by geography.
Reference :  Link ¶

⚼ Request

GET:  /reports/byGeo
{
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
name:
{
Description: Name depending on report endpoint specifies product, API, operation or developer name. ,
Required: False ,
}
string ,
timestamp:
{
Description: Start of aggregation period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
interval:
{
Description: Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations). ,
Required: False ,
}
string ,
country:
{
Description: Country to which this record data is related. ,
Required: False ,
}
string ,
region:
{
Description: Country region to which this record data is related. ,
Required: False ,
}
string ,
zip:
{
Description: Zip code to which this record data is related. ,
Required: False ,
}
string ,
userId:
{
Description: User identifier path. /users/{userId} ,
Required: False ,
}
string ,
productId:
{
Description: Product identifier path. /products/{productId} ,
Required: False ,
}
string ,
apiId:
{
Description: API identifier path. /apis/{apiId} ,
Required: False ,
}
string ,
operationId:
{
Description: Operation identifier path. /apis/{apiId}/operations/{operationId} ,
Required: False ,
}
string ,
apiRegion:
{
Description: API region identifier. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription identifier path. /subscriptions/{subscriptionId} ,
Required: False ,
}
string ,
callCountSuccess:
{
Description: Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect ,
Format: int32 ,
Required: False ,
}
integer ,
callCountBlocked:
{
Description: Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests ,
Format: int32 ,
Required: False ,
}
integer ,
callCountFailed:
{
Description: Number of calls failed due to proxy or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600 ,
Format: int32 ,
Required: False ,
}
integer ,
callCountOther:
{
Description: Number of other calls. ,
Format: int32 ,
Required: False ,
}
integer ,
callCountTotal:
{
Description: Total number of calls. ,
Format: int32 ,
Required: False ,
}
integer ,
bandwidth:
{
Description: Bandwidth consumed. ,
Format: int64 ,
Required: False ,
}
integer ,
cacheHitCount:
{
Description: Number of times when content was served from cache policy. ,
Format: int32 ,
Required: False ,
}
integer ,
cacheMissCount:
{
Description: Number of times content was fetched from backend. ,
Format: int32 ,
Required: False ,
}
integer ,
apiTimeAvg:
{
Description: Average time it took to process request. ,
Format: double ,
Required: False ,
}
number ,
apiTimeMin:
{
Description: Minimum time it took to process request. ,
Format: double ,
Required: False ,
}
number ,
apiTimeMax:
{
Description: Maximum time it took to process request. ,
Format: double ,
Required: False ,
}
number ,
serviceTimeAvg:
{
Description: Average time it took to process request on backend. ,
Format: double ,
Required: False ,
}
number ,
serviceTimeMin:
{
Description: Minimum time it took to process request on backend. ,
Format: double ,
Required: False ,
}
number ,
serviceTimeMax:
{
Description: Maximum time it took to process request on backend. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
Reports_ListBySubscription (new)
Description :  Lists report records by subscription.
Reference :  Link ¶

⚼ Request

GET:  /reports/bySubscription
{
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
name:
{
Description: Name depending on report endpoint specifies product, API, operation or developer name. ,
Required: False ,
}
string ,
timestamp:
{
Description: Start of aggregation period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
interval:
{
Description: Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations). ,
Required: False ,
}
string ,
country:
{
Description: Country to which this record data is related. ,
Required: False ,
}
string ,
region:
{
Description: Country region to which this record data is related. ,
Required: False ,
}
string ,
zip:
{
Description: Zip code to which this record data is related. ,
Required: False ,
}
string ,
userId:
{
Description: User identifier path. /users/{userId} ,
Required: False ,
}
string ,
productId:
{
Description: Product identifier path. /products/{productId} ,
Required: False ,
}
string ,
apiId:
{
Description: API identifier path. /apis/{apiId} ,
Required: False ,
}
string ,
operationId:
{
Description: Operation identifier path. /apis/{apiId}/operations/{operationId} ,
Required: False ,
}
string ,
apiRegion:
{
Description: API region identifier. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription identifier path. /subscriptions/{subscriptionId} ,
Required: False ,
}
string ,
callCountSuccess:
{
Description: Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect ,
Format: int32 ,
Required: False ,
}
integer ,
callCountBlocked:
{
Description: Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests ,
Format: int32 ,
Required: False ,
}
integer ,
callCountFailed:
{
Description: Number of calls failed due to proxy or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600 ,
Format: int32 ,
Required: False ,
}
integer ,
callCountOther:
{
Description: Number of other calls. ,
Format: int32 ,
Required: False ,
}
integer ,
callCountTotal:
{
Description: Total number of calls. ,
Format: int32 ,
Required: False ,
}
integer ,
bandwidth:
{
Description: Bandwidth consumed. ,
Format: int64 ,
Required: False ,
}
integer ,
cacheHitCount:
{
Description: Number of times when content was served from cache policy. ,
Format: int32 ,
Required: False ,
}
integer ,
cacheMissCount:
{
Description: Number of times content was fetched from backend. ,
Format: int32 ,
Required: False ,
}
integer ,
apiTimeAvg:
{
Description: Average time it took to process request. ,
Format: double ,
Required: False ,
}
number ,
apiTimeMin:
{
Description: Minimum time it took to process request. ,
Format: double ,
Required: False ,
}
number ,
apiTimeMax:
{
Description: Maximum time it took to process request. ,
Format: double ,
Required: False ,
}
number ,
serviceTimeAvg:
{
Description: Average time it took to process request on backend. ,
Format: double ,
Required: False ,
}
number ,
serviceTimeMin:
{
Description: Minimum time it took to process request on backend. ,
Format: double ,
Required: False ,
}
number ,
serviceTimeMax:
{
Description: Maximum time it took to process request on backend. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
Reports_ListByTime (new)
Description :  Lists report records by Time.
Reference :  Link ¶

⚼ Request

GET:  /reports/byTime
{
$filter:
{
Description: The filter to apply on the operation. ,
Required: False ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
interval:
{
Description: By time interval. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations).This code can be used to convert TimeSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)) ,
Format: duration ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
name:
{
Description: Name depending on report endpoint specifies product, API, operation or developer name. ,
Required: False ,
}
string ,
timestamp:
{
Description: Start of aggregation period. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
interval:
{
Description: Length of aggregation period. Interval must be multiple of 15 minutes and may not be zero. The value should be in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations). ,
Required: False ,
}
string ,
country:
{
Description: Country to which this record data is related. ,
Required: False ,
}
string ,
region:
{
Description: Country region to which this record data is related. ,
Required: False ,
}
string ,
zip:
{
Description: Zip code to which this record data is related. ,
Required: False ,
}
string ,
userId:
{
Description: User identifier path. /users/{userId} ,
Required: False ,
}
string ,
productId:
{
Description: Product identifier path. /products/{productId} ,
Required: False ,
}
string ,
apiId:
{
Description: API identifier path. /apis/{apiId} ,
Required: False ,
}
string ,
operationId:
{
Description: Operation identifier path. /apis/{apiId}/operations/{operationId} ,
Required: False ,
}
string ,
apiRegion:
{
Description: API region identifier. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription identifier path. /subscriptions/{subscriptionId} ,
Required: False ,
}
string ,
callCountSuccess:
{
Description: Number of successful calls. This includes calls returning HttpStatusCode <= 301 and HttpStatusCode.NotModified and HttpStatusCode.TemporaryRedirect ,
Format: int32 ,
Required: False ,
}
integer ,
callCountBlocked:
{
Description: Number of calls blocked due to invalid credentials. This includes calls returning HttpStatusCode.Unauthorized and HttpStatusCode.Forbidden and HttpStatusCode.TooManyRequests ,
Format: int32 ,
Required: False ,
}
integer ,
callCountFailed:
{
Description: Number of calls failed due to proxy or backend errors. This includes calls returning HttpStatusCode.BadRequest(400) and any Code between HttpStatusCode.InternalServerError (500) and 600 ,
Format: int32 ,
Required: False ,
}
integer ,
callCountOther:
{
Description: Number of other calls. ,
Format: int32 ,
Required: False ,
}
integer ,
callCountTotal:
{
Description: Total number of calls. ,
Format: int32 ,
Required: False ,
}
integer ,
bandwidth:
{
Description: Bandwidth consumed. ,
Format: int64 ,
Required: False ,
}
integer ,
cacheHitCount:
{
Description: Number of times when content was served from cache policy. ,
Format: int32 ,
Required: False ,
}
integer ,
cacheMissCount:
{
Description: Number of times content was fetched from backend. ,
Format: int32 ,
Required: False ,
}
integer ,
apiTimeAvg:
{
Description: Average time it took to process request. ,
Format: double ,
Required: False ,
}
number ,
apiTimeMin:
{
Description: Minimum time it took to process request. ,
Format: double ,
Required: False ,
}
number ,
apiTimeMax:
{
Description: Maximum time it took to process request. ,
Format: double ,
Required: False ,
}
number ,
serviceTimeAvg:
{
Description: Average time it took to process request on backend. ,
Format: double ,
Required: False ,
}
number ,
serviceTimeMin:
{
Description: Minimum time it took to process request on backend. ,
Format: double ,
Required: False ,
}
number ,
serviceTimeMax:
{
Description: Maximum time it took to process request on backend. ,
Format: double ,
Required: False ,
}
number ,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
Reports_ListByRequest (new)
Description :  Lists report records by Request.
Reference :  Link ¶

⚼ Request

GET:  /reports/byRequest
{
$filter:
{
Description: The filter to apply on the operation. ,
Required: True ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
apiId:
{
Description: API identifier path. /apis/{apiId} ,
Required: False ,
}
string ,
operationId:
{
Description: Operation identifier path. /apis/{apiId}/operations/{operationId} ,
Required: False ,
}
string ,
productId:
{
Description: Product identifier path. /products/{productId} ,
Required: False ,
}
string ,
userId:
{
Description: User identifier path. /users/{userId} ,
Required: False ,
}
string ,
method:
{
Description: The HTTP method associated with this request.. ,
Required: False ,
}
string ,
url:
{
Description: The full URL associated with this request. ,
Required: False ,
}
string ,
ipAddress:
{
Description: The client IP address associated with this request. ,
Required: False ,
}
string ,
backendResponseCode:
{
Description: The HTTP status code received by the gateway as a result of forwarding this request to the backend. ,
Required: False ,
}
string ,
responseCode:
{
Description: The HTTP status code returned by the gateway. ,
Format: int32 ,
Required: False ,
}
integer ,
responseSize:
{
Description: The size of the response returned by the gateway. ,
Format: int32 ,
Required: False ,
}
integer ,
timestamp:
{
Description: The date and time when this request was received by the gateway in ISO 8601 format. ,
Format: date-time ,
Required: False ,
}
string ,
cache:
{
Description: Specifies if response cache was involved in generating the response. If the value is none, the cache was not used. If the value is hit, cached response was returned. If the value is miss, the cache was used but lookup resulted in a miss and request was fulfilled by the backend. ,
Required: False ,
}
string ,
apiTime:
{
Description: The total time it took to process this request. ,
Format: double ,
Required: False ,
}
number ,
serviceTime:
{
Description: he time it took to forward this request to the backend and get the response back. ,
Format: double ,
Required: False ,
}
number ,
apiRegion:
{
Description: Azure region where the gateway that processed this request is located. ,
Required: False ,
}
string ,
subscriptionId:
{
Description: Subscription identifier path. /subscriptions/{subscriptionId} ,
Required: False ,
}
string ,
requestId:
{
Description: Request Identifier. ,
Required: False ,
}
string ,
requestSize:
{
Description: The size of this request.. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
}
Subscription_List (new)
Description :  Lists all subscriptions of the API Management service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions
{
$filter:
{
Description: | 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 | | stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | eq | | ,
Required: False ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Identifier of the Subscription. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total number of entities ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Subscription_Get (new)
Description :  Gets the specified Subscription entity.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{sid}
{
sid:
{
Description: Subscription entity Identifier. The entity represents the association between a user and a product in API Management. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Subscription details. ,
}
{
id:
{
Description: Identifier of the Subscription. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Subscription_CreateOrUpdate (new)
Description :  Creates or updates the subscription of specified user to the specified product.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{sid}
{
sid:
{
Description: Subscription entity Identifier. The entity represents the association between a user and a product in API Management. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
userId:
{
Description: User (user id path) for whom subscription is being created in form /users/{uid} ,
Required: True ,
}
string ,
productId:
{
Description: Product (product id path) for which subscription is being created in form /products/{productId} ,
Required: True ,
}
string ,
name:
{
Description: Subscription name. ,
Required: False ,
}
string ,
primaryKey:
{
Description: Primary subscription key. If not specified during request key will be generated automatically. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary subscription key. If not specified during request key will be generated automatically. ,
Required: False ,
}
string ,
state:
{
Description: Initial subscription state. If no value is specified, subscription is created with Submitted state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. ,
Enum:
{
suspended: No description available. ,
active: No description available. ,
expired: No description available. ,
submitted: No description available. ,
rejected: No description available. ,
cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
notify:
{
Description: Notify the subscriber of the subscription state change to Submitted or Active state. ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Identifier of the Subscription. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Identifier of the Subscription. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Subscription_Update (new)
Description :  Updates the details of a subscription specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{sid}
{
sid:
{
Description: Subscription entity Identifier. The entity represents the association between a user and a product in API Management. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
userId:
{
Description: User identifier path: /users/{uid} ,
Required: False ,
}
string ,
productId:
{
Description: Product identifier path: /products/{productId} ,
Required: False ,
}
string ,
expirationDate:
{
Description: Subscription expiration date. The setting is for audit purposes only and the subscription is not automatically expired. The subscription lifecycle can be managed by using the `state` property. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
name:
{
Description: Subscription name. ,
Required: False ,
}
string ,
primaryKey:
{
Description: Primary subscription key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary subscription key. ,
Required: False ,
}
string ,
state:
{
Description: Subscription state. Possible states are * active – the subscription is active, * suspended – the subscription is blocked, and the subscriber cannot call any APIs of the product, * submitted – the subscription request has been made by the developer, but has not yet been approved or rejected, * rejected – the subscription request has been denied by an administrator, * cancelled – the subscription has been cancelled by the developer or administrator, * expired – the subscription reached its expiration date and was deactivated. ,
Enum:
{
suspended: No description available. ,
active: No description available. ,
expired: No description available. ,
submitted: No description available. ,
rejected: No description available. ,
cancelled: No description available. ,
}
,
Required: False ,
}
enum ,
stateComment:
{
Description: Comments describing subscription state change by the administrator. ,
Required: False ,
}
string ,
}
,
If-Match:
{
Description: ETag of the Subscription Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
notify:
{
Description: Notify the subscriber of the subscription state change to Submitted or Active state. ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Subscription_Delete (new)
Description :  Deletes the specified subscription.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{sid}
{
sid:
{
Description: Subscription entity Identifier. The entity represents the association between a user and a product in API Management. ,
Required: True ,
}
string ,
If-Match:
{
Description: ETag of the Subscription Entity. ETag should match the current entity state from the header response of the GET request or it should be * for unconditional update. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Subscription_RegeneratePrimaryKey (new)
Description :  Regenerates primary key of existing subscription of the API Management service instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{sid}/regeneratePrimaryKey
{
sid:
{
Description: Subscription entity Identifier. The entity represents the association between a user and a product in API Management. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
Subscription_RegenerateSecondaryKey (new)
Description :  Regenerates secondary key of existing subscription of the API Management service instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{sid}/regenerateSecondaryKey
{
sid:
{
Description: Subscription entity Identifier. The entity represents the association between a user and a product in API Management. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
TenantAccess_Get (new)
Description :  Get tenant access information details.
Reference :  Link ¶

⚼ Request

GET:  /tenant/{accessName}
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
accessName:
{
Description: The identifier of the Access configuration. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Tenant access information contract of the API Management service. ,
}
{
id:
{
Description: Identifier. ,
Required: False ,
}
string ,
primaryKey:
{
Description: Primary access key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary access key. ,
Required: False ,
}
string ,
enabled:
{
Description: Tenant access information of the API Management service. ,
Required: False ,
}
boolean ,
}
,
}
TenantAccess_Update (new)
Description :  Update tenant access information details.
Reference :  Link ¶

⚼ Request

PATCH:  /tenant/{accessName}
{
parameters:
{
Description: Parameters supplied to retrieve the Tenant Access Information. ,
Required: True ,
}
{
enabled:
{
Description: Tenant access information of the API Management service. ,
Required: False ,
}
boolean ,
}
,
accessName:
{
Description: The identifier of the Access configuration. ,
Required: True ,
}
string ,
If-Match:
{
Description: The entity state (Etag) version of the property to update. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
TenantAccess_RegeneratePrimaryKey (new)
Description :  Regenerate primary access key.
Reference :  Link ¶

⚼ Request

POST:  /tenant/{accessName}/regeneratePrimaryKey
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
accessName:
{
Description: The identifier of the Access configuration. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
TenantAccess_RegenerateSecondaryKey (new)
Description :  Regenerate secondary access key.
Reference :  Link ¶

⚼ Request

POST:  /tenant/{accessName}/regenerateSecondaryKey
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
accessName:
{
Description: The identifier of the Access configuration. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
TenantAccessGit_Get (new)
Description :  Gets the Git access configuration for the tenant.
Reference :  Link ¶

⚼ Request

GET:  /tenant/{accessName}/git
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
accessName:
{
Description: The identifier of the Access configuration. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: Tenant access information contract of the API Management service. ,
}
{
id:
{
Description: Identifier. ,
Required: False ,
}
string ,
primaryKey:
{
Description: Primary access key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Secondary access key. ,
Required: False ,
}
string ,
enabled:
{
Description: Tenant access information of the API Management service. ,
Required: False ,
}
boolean ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
TenantAccessGit_RegeneratePrimaryKey (new)
Description :  Regenerate primary access key for GIT.
Reference :  Link ¶

⚼ Request

POST:  /tenant/{accessName}/git/regeneratePrimaryKey
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
accessName:
{
Description: The identifier of the Access configuration. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
TenantAccessGit_RegenerateSecondaryKey (new)
Description :  Regenerate secondary access key for GIT.
Reference :  Link ¶

⚼ Request

POST:  /tenant/{accessName}/git/regenerateSecondaryKey
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
accessName:
{
Description: The identifier of the Access configuration. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
TenantConfiguration_Deploy (new)
Description :  This operation applies changes from the specified Git branch to the configuration database. This is a long running operation and could take several minutes to complete.
Reference :  Link ¶

⚼ Request

POST:  /tenant/{configurationName}/deploy
{
parameters:
{
Description: Deploy Configuration parameters. ,
Required: True ,
}
{
branch:
{
Description: The name of the Git branch from which the configuration is to be deployed to the configuration database. ,
Required: True ,
}
string ,
force:
{
Description: The value enforcing deleting subscriptions to products that are deleted in this update. ,
Required: False ,
}
boolean ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
configurationName:
{
Description: The identifier of the Git Configuration Operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
id:
{
Description: Operation result identifier. ,
Required: False ,
}
string ,
status:
{
Description: Status of an async operation. ,
Enum:
{
Started: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
started:
{
Description: Start time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
updated:
{
Description: Last update time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
resultInfo:
{
Description: Optional result info. ,
Required: False ,
}
string ,
error:
{
Description: Error Body Contract ,
Required: False ,
}
{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
actionLog:
{
Description: This property if only provided as part of the TenantConfiguration_Validate operation. It contains the log the entities which will be updated/created/deleted as part of the TenantConfiguration_Deploy operation. ,
Required: False ,
}
[
{
objectType:
{
Description: The type of entity contract. ,
Required: False ,
}
string ,
action:
{
Description: Action like create/update/delete. ,
Required: False ,
}
string ,
objectKey:
{
Description: Identifier of the entity being created/updated/deleted. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
TenantConfiguration_Save (new)
Description :  This operation creates a commit with the current configuration snapshot to the specified branch in the repository. This is a long running operation and could take several minutes to complete.
Reference :  Link ¶

⚼ Request

POST:  /tenant/{configurationName}/save
{
parameters:
{
Description: Save Configuration parameters. ,
Required: True ,
}
{
branch:
{
Description: The name of the Git branch in which to commit the current configuration snapshot. ,
Required: True ,
}
string ,
force:
{
Description: The value if true, the current configuration database is committed to the Git repository, even if the Git repository has newer changes that would be overwritten. ,
Required: False ,
}
boolean ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
configurationName:
{
Description: The identifier of the Git Configuration Operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
id:
{
Description: Operation result identifier. ,
Required: False ,
}
string ,
status:
{
Description: Status of an async operation. ,
Enum:
{
Started: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
started:
{
Description: Start time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
updated:
{
Description: Last update time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
resultInfo:
{
Description: Optional result info. ,
Required: False ,
}
string ,
error:
{
Description: Error Body Contract ,
Required: False ,
}
{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
actionLog:
{
Description: This property if only provided as part of the TenantConfiguration_Validate operation. It contains the log the entities which will be updated/created/deleted as part of the TenantConfiguration_Deploy operation. ,
Required: False ,
}
[
{
objectType:
{
Description: The type of entity contract. ,
Required: False ,
}
string ,
action:
{
Description: Action like create/update/delete. ,
Required: False ,
}
string ,
objectKey:
{
Description: Identifier of the entity being created/updated/deleted. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
TenantConfiguration_Validate (new)
Description :  This operation validates the changes in the specified Git branch. This is a long running operation and could take several minutes to complete.
Reference :  Link ¶

⚼ Request

POST:  /tenant/{configurationName}/validate
{
parameters:
{
Description: Validate Configuration parameters. ,
Required: True ,
}
{
branch:
{
Description: The name of the Git branch from which the configuration is to be deployed to the configuration database. ,
Required: True ,
}
string ,
force:
{
Description: The value enforcing deleting subscriptions to products that are deleted in this update. ,
Required: False ,
}
boolean ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
configurationName:
{
Description: The identifier of the Git Configuration Operation. ,
Required: True ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (200)

{
id:
{
Description: Operation result identifier. ,
Required: False ,
}
string ,
status:
{
Description: Status of an async operation. ,
Enum:
{
Started: No description available. ,
InProgress: No description available. ,
Succeeded: No description available. ,
Failed: No description available. ,
}
,
Required: False ,
}
enum ,
started:
{
Description: Start time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
updated:
{
Description: Last update time of an async operation. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
resultInfo:
{
Description: Optional result info. ,
Required: False ,
}
string ,
error:
{
Description: Error Body Contract ,
Required: False ,
}
{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
,
actionLog:
{
Description: This property if only provided as part of the TenantConfiguration_Validate operation. It contains the log the entities which will be updated/created/deleted as part of the TenantConfiguration_Deploy operation. ,
Required: False ,
}
[
{
objectType:
{
Description: The type of entity contract. ,
Required: False ,
}
string ,
action:
{
Description: Action like create/update/delete. ,
Required: False ,
}
string ,
objectKey:
{
Description: Identifier of the entity being created/updated/deleted. ,
Required: False ,
}
string ,
}
,
]
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
TenantConfiguration_GetSyncState (new)
Description :  Gets the status of the most recent synchronization between the configuration database and the Git repository.
Reference :  Link ¶

⚼ Request

GET:  /tenant/{configurationName}/syncState
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
configurationName:
{
Description: The identifier of the Git Configuration Operation. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
branch:
{
Description: The name of Git branch. ,
Required: False ,
}
string ,
commitId:
{
Description: The latest commit Id. ,
Required: False ,
}
string ,
isExport:
{
Description: value indicating if last sync was save (true) or deploy (false) operation. ,
Required: False ,
}
boolean ,
isSynced:
{
Description: value indicating if last synchronization was later than the configuration change. ,
Required: False ,
}
boolean ,
isGitEnabled:
{
Description: value indicating whether Git configuration access is enabled. ,
Required: False ,
}
boolean ,
syncDate:
{
Description: The date of the latest synchronization. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
configurationChangeDate:
{
Description: The date of the latest configuration change. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: False ,
}
string ,
}
User_List (new)
Description :  Lists a collection of registered users in the specified service instance.
Reference :  Link ¶

⚼ Request

GET:  /users
{
$filter:
{
Description: | Field | Supported operators | Supported functions | |------------------|------------------------|-----------------------------------| | id | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | firstName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | lastName | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | email | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | eq | N/A | | registrationDate | ge, le, eq, ne, gt, lt | N/A | | note | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | ,
Required: False ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Identifier of the entity. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total number of entities ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
User_Get (new)
Description :  Gets the details of the user specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /users/{uid}
{
uid:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
$headers:
{
etag:
{
Description: Current entity state version. Should be treated as opaque and used to make conditional HTTP requests. ,
}
string ,
}
,
$schema:
{
Description: User details. ,
}
{
id:
{
Description: Identifier of the entity. ,
Required: False ,
}
string ,
}
,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
User_CreateOrUpdate (new)
Description :  Creates or Updates a user.
Reference :  Link ¶

⚼ Request

PUT:  /users/{uid}
{
uid:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create or update parameters. ,
Required: True ,
}
{
email:
{
Description: Email address. Must not be empty and must be unique within the service instance. ,
Required: True ,
}
string ,
firstName:
{
Description: First name. ,
Required: True ,
}
string ,
lastName:
{
Description: Last name. ,
Required: True ,
}
string ,
password:
{
Description: User Password. If no value is provided, a default password is generated. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: Identifier of the entity. ,
Required: False ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: Identifier of the entity. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
User_Update (new)
Description :  Updates the details of the user specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /users/{uid}
{
uid:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
email:
{
Description: Email address. Must not be empty and must be unique within the service instance. ,
Required: False ,
}
string ,
password:
{
Description: User Password. ,
Required: False ,
}
string ,
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
}
,
If-Match:
{
Description: The entity state (Etag) version of the user to update. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
User_Delete (new)
Description :  Deletes specific user.
Reference :  Link ¶

⚼ Request

DELETE:  /users/{uid}
{
uid:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
deleteSubscriptions:
{
Description: Whether to delete user's subscription or not. ,
Required: False ,
}
string ,
notify:
{
Description: Send an Account Closed Email notification to the User. ,
Required: False ,
}
string ,
If-Match:
{
Description: The entity state (Etag) version of the user to delete. A value of "*" can be used for If-Match to unconditionally apply the operation. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
User_GenerateSsoUrl (new)
Description :  Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.
Reference :  Link ¶

⚼ Request

POST:  /users/{uid}/generateSsoUrl
{
uid:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Redirect Url containing the SSO URL value. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
UserGroup_List (new)
Description :  Lists all user groups.
Reference :  Link ¶

⚼ Request

GET:  /users/{uid}/groups
{
uid:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$filter:
{
Description: | 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 | | description | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | ,
Required: False ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Identifier of the Group entity. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total number of entities ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
UserSubscription_List (new)
Description :  Lists the collection of subscriptions of the specified user.
Reference :  Link ¶

⚼ Request

GET:  /users/{uid}/subscriptions
{
uid:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
$filter:
{
Description: | 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 | | stateComment | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | userId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | productId | ge, le, eq, ne, gt, lt | substringof, contains, startswith, endswith | | state | eq | | ,
Required: False ,
}
string ,
$top:
{
Description: Number of records to return. ,
Format: int32 ,
Required: False ,
}
integer ,
$skip:
{
Description: Number of records to skip. ,
Format: int32 ,
Required: False ,
}
integer ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Identifier of the Subscription. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total number of entities ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
UserIdentities_List (new)
Description :  Lists all user identities.
Reference :  Link ¶

⚼ Request

GET:  /users/{uid}/identities
{
uid:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: User Identity values. ,
Required: False ,
}
[
{
provider:
{
Description: Identity provider name. ,
Required: False ,
}
string ,
id:
{
Description: Identifier value within provider. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total record count number across all pages. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}
User_GetSharedAccessToken (new)
Description :  Gets the Shared Access Authorization Token for the User.
Reference :  Link ¶

⚼ Request

POST:  /users/{uid}/token
{
uid:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create Authorization Token parameters. ,
Required: True ,
}
{
keyType:
{
Description: The Key to be used to generate token for user. ,
Enum:
{
primary: No description available. ,
secondary: No description available. ,
}
,
Required: True ,
}
enum ,
expiry:
{
Description: The Expiry time of the Token. Maximum token expiry time is set to 30 days. The date conforms to the following format: `yyyy-MM-ddTHH:mm:ssZ` as specified by the ISO 8601 standard. ,
Format: date-time ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Shared Access Authorization token for the User. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Service-defined error code. This code serves as a sub-status for the HTTP error code specified in the response. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of the error. ,
Required: False ,
}
string ,
details:
{
Description: The list of invalid fields send in request, in case of validation error. ,
Required: False ,
}
[
{
code:
{
Description: Property level error code. ,
Required: False ,
}
string ,
message:
{
Description: Human-readable representation of property-level error. ,
Required: False ,
}
string ,
target:
{
Description: Property name. ,
Required: False ,
}
string ,
}
,
]
,
}