Microsoft.ApiManagement (stable:2016-07-07)

2025/10/30 • 112 new, 112 deleted methods

Apis_ListByService (new)
Description :  Lists all APIs of the API Management service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: API identifier path: /apis/{apiId} ,
Required: False ,
}
string ,
name:
{
Description: API name. ,
Required: True ,
}
string ,
description:
{
Description: Description of the API. May include HTML formatting tags. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. ,
Required: True ,
}
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: True ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: True ,
}
[
string ,
]
,
authenticationSettings:
{
Description: Collection of authentication settings included into this API. ,
Required: False ,
}
{
oAuth2:
{
Description: API OAuth2 Authentication settings details. ,
Required: False ,
}
{
authorizationServerId:
{
Description: OAuth authorization server identifier. ,
Required: False ,
}
string ,
scope:
{
Description: operations scope. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionKeyParameterNames:
{
Description: Protocols over which API is made available. ,
Required: False ,
}
{
header:
{
Description: Subscription key header name. ,
Required: False ,
}
string ,
query:
{
Description: Subscription key query string parameter name. ,
Required: False ,
}
string ,
}
,
type:
{
Description: Type of API. ,
Enum:
{
Http: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
Apis_Get (new)
Description :  Gets the details of the API specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 details. ,
}
{
id:
{
Description: API identifier path: /apis/{apiId} ,
Required: False ,
}
string ,
name:
{
Description: API name. ,
Required: True ,
}
string ,
description:
{
Description: Description of the API. May include HTML formatting tags. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. ,
Required: True ,
}
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: True ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: True ,
}
[
string ,
]
,
authenticationSettings:
{
Description: Collection of authentication settings included into this API. ,
Required: False ,
}
{
oAuth2:
{
Description: API OAuth2 Authentication settings details. ,
Required: False ,
}
{
authorizationServerId:
{
Description: OAuth authorization server identifier. ,
Required: False ,
}
string ,
scope:
{
Description: operations scope. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionKeyParameterNames:
{
Description: Protocols over which API is made available. ,
Required: False ,
}
{
header:
{
Description: Subscription key header name. ,
Required: False ,
}
string ,
query:
{
Description: Subscription key query string parameter name. ,
Required: False ,
}
string ,
}
,
type:
{
Description: Type of API. ,
Enum:
{
Http: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
Apis_CreateOrUpdate (new)
Description :  Creates new or updates existing specified API of the API Management service instance.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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: API identifier path: /apis/{apiId} ,
Required: False ,
}
string ,
name:
{
Description: API name. ,
Required: True ,
}
string ,
description:
{
Description: Description of the API. May include HTML formatting tags. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. ,
Required: True ,
}
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: True ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: True ,
}
[
string ,
]
,
authenticationSettings:
{
Description: Collection of authentication settings included into this API. ,
Required: False ,
}
{
oAuth2:
{
Description: API OAuth2 Authentication settings details. ,
Required: False ,
}
{
authorizationServerId:
{
Description: OAuth authorization server identifier. ,
Required: False ,
}
string ,
scope:
{
Description: operations scope. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionKeyParameterNames:
{
Description: Protocols over which API is made available. ,
Required: False ,
}
{
header:
{
Description: Subscription key header name. ,
Required: False ,
}
string ,
query:
{
Description: Subscription key query string parameter name. ,
Required: False ,
}
string ,
}
,
type:
{
Description: Type of API. ,
Enum:
{
Http: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
Apis_Update (new)
Description :  Updates the specified API of the API Management service instance.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Patch parameters. ,
Required: True ,
}
{
RawJson:
{
Description: json value. ,
Required: True ,
}
object ,
}
,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
Apis_Delete (new)
Description :  Deletes the specified API of the API Management service instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
ApiOperations_ListByApi (new)
Description :  Lists a collection of the operations for the specified API.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the operation within the current API Management service instance. The value is a valid relative URL in the format of /apis/{aid}/operations/{id} where {aid} is an API identifier and {id} is an operation identifier. ,
Required: False ,
}
string ,
name:
{
Description: Operation Name. ,
Required: True ,
}
string ,
method:
{
Description: A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. ,
Required: True ,
}
string ,
urlTemplate:
{
Description: Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} ,
Required: True ,
}
string ,
templateParameters:
{
Description: Collection of URL template parameters. ,
Required: False ,
}
[
{
name:
{
Description: Parameter name. ,
Required: True ,
}
string ,
description:
{
Description: Parameter description. ,
Required: False ,
}
string ,
type:
{
Description: Parameter type. ,
Required: True ,
}
string ,
defaultValue:
{
Description: Default parameter value. ,
Required: False ,
}
string ,
required:
{
Description: whether parameter is required or not. ,
Required: False ,
}
boolean ,
values:
{
Description: Parameter values. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
description:
{
Description: Description of the operation. May include HTML formatting tags. ,
Required: False ,
}
string ,
request:
{
Description: An entity containing request details. ,
Required: False ,
}
{
description:
{
Description: Operation request description. ,
Required: False ,
}
string ,
queryParameters:
{
Description: Collection of operation request query parameters. ,
Required: False ,
}
[
{
name:
{
Description: Parameter name. ,
Required: True ,
}
string ,
description:
{
Description: Parameter description. ,
Required: False ,
}
string ,
type:
{
Description: Parameter type. ,
Required: True ,
}
string ,
defaultValue:
{
Description: Default parameter value. ,
Required: False ,
}
string ,
required:
{
Description: whether parameter is required or not. ,
Required: False ,
}
boolean ,
values:
{
Description: Parameter values. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
headers:
{
Description: Collection of operation request headers. ,
Required: False ,
}
[
{
name:
{
Description: Parameter name. ,
Required: True ,
}
string ,
description:
{
Description: Parameter description. ,
Required: False ,
}
string ,
type:
{
Description: Parameter type. ,
Required: True ,
}
string ,
defaultValue:
{
Description: Default parameter value. ,
Required: False ,
}
string ,
required:
{
Description: whether parameter is required or not. ,
Required: False ,
}
boolean ,
values:
{
Description: Parameter values. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
representations:
{
Description: Collection of operation request representations. ,
Required: False ,
}
[
{
contentType:
{
Description: Specifies a registered or custom content type for this representation, e.g. application/xml. ,
Required: True ,
}
string ,
sample:
{
Description: An example of the representation. ,
Required: False ,
}
string ,
}
,
]
,
}
,
responses:
{
Description: Array of Operation responses. ,
Required: False ,
}
[
{
statusCode:
{
Description: Operation response HTTP status code. ,
Format: int32 ,
Required: True ,
}
integer ,
description:
{
Description: Operation response description. ,
Required: False ,
}
string ,
representations:
{
Description: Collection of operation response representations. ,
Required: False ,
}
[
{
contentType:
{
Description: Specifies a registered or custom content type for this representation, e.g. application/xml. ,
Required: True ,
}
string ,
sample:
{
Description: An example of the representation. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
ApiOperations_Get (new)
Description :  Gets the details of the API Operation specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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: Uniquely identifies the operation within the current API Management service instance. The value is a valid relative URL in the format of /apis/{aid}/operations/{id} where {aid} is an API identifier and {id} is an operation identifier. ,
Required: False ,
}
string ,
name:
{
Description: Operation Name. ,
Required: True ,
}
string ,
method:
{
Description: A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. ,
Required: True ,
}
string ,
urlTemplate:
{
Description: Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} ,
Required: True ,
}
string ,
templateParameters:
{
Description: Collection of URL template parameters. ,
Required: False ,
}
[
{
name:
{
Description: Parameter name. ,
Required: True ,
}
string ,
description:
{
Description: Parameter description. ,
Required: False ,
}
string ,
type:
{
Description: Parameter type. ,
Required: True ,
}
string ,
defaultValue:
{
Description: Default parameter value. ,
Required: False ,
}
string ,
required:
{
Description: whether parameter is required or not. ,
Required: False ,
}
boolean ,
values:
{
Description: Parameter values. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
description:
{
Description: Description of the operation. May include HTML formatting tags. ,
Required: False ,
}
string ,
request:
{
Description: An entity containing request details. ,
Required: False ,
}
{
description:
{
Description: Operation request description. ,
Required: False ,
}
string ,
queryParameters:
{
Description: Collection of operation request query parameters. ,
Required: False ,
}
[
{
name:
{
Description: Parameter name. ,
Required: True ,
}
string ,
description:
{
Description: Parameter description. ,
Required: False ,
}
string ,
type:
{
Description: Parameter type. ,
Required: True ,
}
string ,
defaultValue:
{
Description: Default parameter value. ,
Required: False ,
}
string ,
required:
{
Description: whether parameter is required or not. ,
Required: False ,
}
boolean ,
values:
{
Description: Parameter values. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
headers:
{
Description: Collection of operation request headers. ,
Required: False ,
}
[
{
name:
{
Description: Parameter name. ,
Required: True ,
}
string ,
description:
{
Description: Parameter description. ,
Required: False ,
}
string ,
type:
{
Description: Parameter type. ,
Required: True ,
}
string ,
defaultValue:
{
Description: Default parameter value. ,
Required: False ,
}
string ,
required:
{
Description: whether parameter is required or not. ,
Required: False ,
}
boolean ,
values:
{
Description: Parameter values. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
representations:
{
Description: Collection of operation request representations. ,
Required: False ,
}
[
{
contentType:
{
Description: Specifies a registered or custom content type for this representation, e.g. application/xml. ,
Required: True ,
}
string ,
sample:
{
Description: An example of the representation. ,
Required: False ,
}
string ,
}
,
]
,
}
,
responses:
{
Description: Array of Operation responses. ,
Required: False ,
}
[
{
statusCode:
{
Description: Operation response HTTP status code. ,
Format: int32 ,
Required: True ,
}
integer ,
description:
{
Description: Operation response description. ,
Required: False ,
}
string ,
representations:
{
Description: Collection of operation response representations. ,
Required: False ,
}
[
{
contentType:
{
Description: Specifies a registered or custom content type for this representation, e.g. application/xml. ,
Required: True ,
}
string ,
sample:
{
Description: An example of the representation. ,
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 ,
}
,
]
,
}
ApiOperations_CreateOrUpdate (new)
Description :  Creates a new API operation or updates an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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: Uniquely identifies the operation within the current API Management service instance. The value is a valid relative URL in the format of /apis/{aid}/operations/{id} where {aid} is an API identifier and {id} is an operation identifier. ,
Required: False ,
}
string ,
name:
{
Description: Operation Name. ,
Required: True ,
}
string ,
method:
{
Description: A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. ,
Required: True ,
}
string ,
urlTemplate:
{
Description: Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} ,
Required: True ,
}
string ,
templateParameters:
{
Description: Collection of URL template parameters. ,
Required: False ,
}
[
{
name:
{
Description: Parameter name. ,
Required: True ,
}
string ,
description:
{
Description: Parameter description. ,
Required: False ,
}
string ,
type:
{
Description: Parameter type. ,
Required: True ,
}
string ,
defaultValue:
{
Description: Default parameter value. ,
Required: False ,
}
string ,
required:
{
Description: whether parameter is required or not. ,
Required: False ,
}
boolean ,
values:
{
Description: Parameter values. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
description:
{
Description: Description of the operation. May include HTML formatting tags. ,
Required: False ,
}
string ,
request:
{
Description: An entity containing request details. ,
Required: False ,
}
{
description:
{
Description: Operation request description. ,
Required: False ,
}
string ,
queryParameters:
{
Description: Collection of operation request query parameters. ,
Required: False ,
}
[
{
name:
{
Description: Parameter name. ,
Required: True ,
}
string ,
description:
{
Description: Parameter description. ,
Required: False ,
}
string ,
type:
{
Description: Parameter type. ,
Required: True ,
}
string ,
defaultValue:
{
Description: Default parameter value. ,
Required: False ,
}
string ,
required:
{
Description: whether parameter is required or not. ,
Required: False ,
}
boolean ,
values:
{
Description: Parameter values. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
headers:
{
Description: Collection of operation request headers. ,
Required: False ,
}
[
{
name:
{
Description: Parameter name. ,
Required: True ,
}
string ,
description:
{
Description: Parameter description. ,
Required: False ,
}
string ,
type:
{
Description: Parameter type. ,
Required: True ,
}
string ,
defaultValue:
{
Description: Default parameter value. ,
Required: False ,
}
string ,
required:
{
Description: whether parameter is required or not. ,
Required: False ,
}
boolean ,
values:
{
Description: Parameter values. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
representations:
{
Description: Collection of operation request representations. ,
Required: False ,
}
[
{
contentType:
{
Description: Specifies a registered or custom content type for this representation, e.g. application/xml. ,
Required: True ,
}
string ,
sample:
{
Description: An example of the representation. ,
Required: False ,
}
string ,
}
,
]
,
}
,
responses:
{
Description: Array of Operation responses. ,
Required: False ,
}
[
{
statusCode:
{
Description: Operation response HTTP status code. ,
Format: int32 ,
Required: True ,
}
integer ,
description:
{
Description: Operation response description. ,
Required: False ,
}
string ,
representations:
{
Description: Collection of operation response representations. ,
Required: False ,
}
[
{
contentType:
{
Description: Specifies a registered or custom content type for this representation, e.g. application/xml. ,
Required: True ,
}
string ,
sample:
{
Description: An example of the representation. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
ApiOperations_Update (new)
Description :  Updates the details of the operation specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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: Update parameters. ,
Required: True ,
}
{
RawJson:
{
Description: json value. ,
Required: True ,
}
object ,
}
,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
ApiOperations_Delete (new)
Description :  Deletes the specified operation.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
ApiProducts_ListByApi (new)
Description :  Lists all API associated products.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/products
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the product within the current API Management service instance. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier. ,
Required: False ,
}
string ,
name:
{
Description: Product name. ,
Required: True ,
}
string ,
description:
{
Description: Product description. May include HTML formatting tags. ,
Required: False ,
}
string ,
terms:
{
Description: Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process. ,
Required: False ,
}
string ,
subscriptionRequired:
{
Description: Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true. ,
Required: False ,
}
boolean ,
approvalRequired:
{
Description: whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true. ,
Required: False ,
}
boolean ,
subscriptionsLimit:
{
Description: Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is NotPublished. ,
Enum:
{
NotPublished: No description available. ,
Published: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
Subscriptions_ListByService (new)
Description :  Lists all subscriptions of the API Management service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the subscription within the current API Management service instance. The value is a valid relative URL in the format of /subscriptions/{sid} where {sid} is a subscription identifier. ,
Required: False ,
}
string ,
userId:
{
Description: The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{uid} where {uid} is a user identifier. ,
Required: False ,
}
string ,
productId:
{
Description: The product resource identifier of the subscribed product. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the subscription, or null if the subscription has no name. ,
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 ,
createdDate:
{
Description: Subscription creation date. 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 ,
startDate:
{
Description: Subscription activation date. 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 ,
expirationDate:
{
Description: Subscription expiration date. 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 ,
endDate:
{
Description: Date when subscription was cancelled or expired. 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 ,
notificationDate:
{
Description: Upcoming subscription expiration notification date. 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 ,
primaryKey:
{
Description: Subscription primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Subscription secondary key. ,
Required: False ,
}
string ,
stateComment:
{
Description: Optional subscription comment added by an administrator. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
Subscriptions_Get (new)
Description :  Gets the specified Subscription entity.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
sid:
{
Description: Identifier of the subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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: Uniquely identifies the subscription within the current API Management service instance. The value is a valid relative URL in the format of /subscriptions/{sid} where {sid} is a subscription identifier. ,
Required: False ,
}
string ,
userId:
{
Description: The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{uid} where {uid} is a user identifier. ,
Required: False ,
}
string ,
productId:
{
Description: The product resource identifier of the subscribed product. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the subscription, or null if the subscription has no name. ,
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 ,
createdDate:
{
Description: Subscription creation date. 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 ,
startDate:
{
Description: Subscription activation date. 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 ,
expirationDate:
{
Description: Subscription expiration date. 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 ,
endDate:
{
Description: Date when subscription was cancelled or expired. 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 ,
notificationDate:
{
Description: Upcoming subscription expiration notification date. 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 ,
primaryKey:
{
Description: Subscription primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Subscription secondary key. ,
Required: False ,
}
string ,
stateComment:
{
Description: Optional subscription comment added by an administrator. ,
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 ,
}
,
]
,
}
Subscriptions_CreateOrUpdate (new)
Description :  Creates or updates the subscription of specified user to the specified product.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
sid:
{
Description: Identifier of the subscription. ,
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: True ,
}
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 ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
Subscriptions_Update (new)
Description :  Updates the details of a subscription specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
sid:
{
Description: Identifier of the subscription. ,
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: New subscription expiration date. ,
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 ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
Subscriptions_Delete (new)
Description :  Deletes the specified subscription.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
sid:
{
Description: Identifier of the subscription. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
Subscriptions_RegeneratePrimaryKey (new)
Description :  Regenerates primary key of existing subscription of the API Management service instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}/regeneratePrimaryKey
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
sid:
{
Description: Identifier of the subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
Subscriptions_RegenerateSecondaryKey (new)
Description :  Regenerates secondary key of existing subscription of the API Management service instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}/regenerateSecondaryKey
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
sid:
{
Description: Identifier of the subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
Products_ListByService (new)
Description :  Lists a collection of products in the specified service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
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 | | 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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the product within the current API Management service instance. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier. ,
Required: False ,
}
string ,
name:
{
Description: Product name. ,
Required: True ,
}
string ,
description:
{
Description: Product description. May include HTML formatting tags. ,
Required: False ,
}
string ,
terms:
{
Description: Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process. ,
Required: False ,
}
string ,
subscriptionRequired:
{
Description: Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true. ,
Required: False ,
}
boolean ,
approvalRequired:
{
Description: whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true. ,
Required: False ,
}
boolean ,
subscriptionsLimit:
{
Description: Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is NotPublished. ,
Enum:
{
NotPublished: No description available. ,
Published: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
Products_Get (new)
Description :  Gets the details of the product specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 profile. ,
}
{
id:
{
Description: Uniquely identifies the product within the current API Management service instance. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier. ,
Required: False ,
}
string ,
name:
{
Description: Product name. ,
Required: True ,
}
string ,
description:
{
Description: Product description. May include HTML formatting tags. ,
Required: False ,
}
string ,
terms:
{
Description: Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process. ,
Required: False ,
}
string ,
subscriptionRequired:
{
Description: Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true. ,
Required: False ,
}
boolean ,
approvalRequired:
{
Description: whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true. ,
Required: False ,
}
boolean ,
subscriptionsLimit:
{
Description: Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is NotPublished. ,
Enum:
{
NotPublished: No description available. ,
Published: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
Products_CreateOrUpdate (new)
Description :  Creates or Updates a product.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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: Uniquely identifies the product within the current API Management service instance. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier. ,
Required: False ,
}
string ,
name:
{
Description: Product name. ,
Required: True ,
}
string ,
description:
{
Description: Product description. May include HTML formatting tags. ,
Required: False ,
}
string ,
terms:
{
Description: Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process. ,
Required: False ,
}
string ,
subscriptionRequired:
{
Description: Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true. ,
Required: False ,
}
boolean ,
approvalRequired:
{
Description: whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true. ,
Required: False ,
}
boolean ,
subscriptionsLimit:
{
Description: Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is NotPublished. ,
Enum:
{
NotPublished: No description available. ,
Published: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
Products_Update (new)
Description :  Update product.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
description:
{
Description: Product description. ,
Required: False ,
}
string ,
terms:
{
Description: Product terms and conditions. Developer will have to accept these terms before he's allowed to call product API. ,
Required: False ,
}
string ,
subscriptionRequired:
{
Description: whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true. ,
Required: False ,
}
boolean ,
approvalRequired:
{
Description: whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true. ,
Required: False ,
}
boolean ,
subscriptionsLimit:
{
Description: whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. ,
Enum:
{
NotPublished: No description available. ,
Published: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
Products_Delete (new)
Description :  Delete product.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
ProductApis_ListByProduct (new)
Description :  Lists a collection of the APIs associated with a product.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: API identifier path: /apis/{apiId} ,
Required: False ,
}
string ,
name:
{
Description: API name. ,
Required: True ,
}
string ,
description:
{
Description: Description of the API. May include HTML formatting tags. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. ,
Required: True ,
}
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: True ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: True ,
}
[
string ,
]
,
authenticationSettings:
{
Description: Collection of authentication settings included into this API. ,
Required: False ,
}
{
oAuth2:
{
Description: API OAuth2 Authentication settings details. ,
Required: False ,
}
{
authorizationServerId:
{
Description: OAuth authorization server identifier. ,
Required: False ,
}
string ,
scope:
{
Description: operations scope. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionKeyParameterNames:
{
Description: Protocols over which API is made available. ,
Required: False ,
}
{
header:
{
Description: Subscription key header name. ,
Required: False ,
}
string ,
query:
{
Description: Subscription key query string parameter name. ,
Required: False ,
}
string ,
}
,
type:
{
Description: Type of API. ,
Enum:
{
Http: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
ProductApis_Add (new)
Description :  Adds an API to the specified product.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
ProductApis_Remove (new)
Description :  Deletes the specified API from the specified product.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
ProductGroups_ListByProduct (new)
Description :  Lists the collection of developer groups associated with the specified product.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the group within the current API Management service instance. The value is a valid relative URL in the format of /groups/{groupId} where {groupId} is a group identifier. ,
Required: False ,
}
string ,
name:
{
Description: Group name. ,
Required: True ,
}
string ,
description:
{
Description: Group description. Can contain HTML formatting tags. ,
Required: False ,
}
string ,
builtIn:
{
Description: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. ,
Required: False ,
}
boolean ,
type:
{
Description: Group type. ,
Enum:
{
Custom: No description available. ,
System: No description available. ,
External: No description available. ,
}
,
Required: False ,
}
enum ,
externalId:
{
Description: For external groups, this property contains the id of the group from the external identity provider, e.g. Azure Active Directory; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
ProductGroups_Add (new)
Description :  Adds the association between the specified developer group with the specified product.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
ProductGroups_Remove (new)
Description :  Deletes the association between the specified group and product.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (400)

{
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 ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
Groups_ListByService (new)
Description :  Lists a collection of groups defined within a service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the group within the current API Management service instance. The value is a valid relative URL in the format of /groups/{groupId} where {groupId} is a group identifier. ,
Required: False ,
}
string ,
name:
{
Description: Group name. ,
Required: True ,
}
string ,
description:
{
Description: Group description. Can contain HTML formatting tags. ,
Required: False ,
}
string ,
builtIn:
{
Description: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. ,
Required: False ,
}
boolean ,
type:
{
Description: Group type. ,
Enum:
{
Custom: No description available. ,
System: No description available. ,
External: No description available. ,
}
,
Required: False ,
}
enum ,
externalId:
{
Description: For external groups, this property contains the id of the group from the external identity provider, e.g. Azure Active Directory; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total records count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
Groups_Get (new)
Description :  Gets the details of the group specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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: Developer group. ,
}
{
id:
{
Description: Uniquely identifies the group within the current API Management service instance. The value is a valid relative URL in the format of /groups/{groupId} where {groupId} is a group identifier. ,
Required: False ,
}
string ,
name:
{
Description: Group name. ,
Required: True ,
}
string ,
description:
{
Description: Group description. Can contain HTML formatting tags. ,
Required: False ,
}
string ,
builtIn:
{
Description: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. ,
Required: False ,
}
boolean ,
type:
{
Description: Group type. ,
Enum:
{
Custom: No description available. ,
System: No description available. ,
External: No description available. ,
}
,
Required: False ,
}
enum ,
externalId:
{
Description: For external groups, this property contains the id of the group from the external identity provider, e.g. Azure Active Directory; otherwise the value is null. ,
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 ,
}
,
]
,
}
Groups_CreateOrUpdate (new)
Description :  Creates or Updates a group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 for an external group. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
Groups_Update (new)
Description :  Updates the details of the group specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 for an external group. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (405)

{
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 ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
Groups_Delete (new)
Description :  Deletes specific group of the API Management service instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (405)

{
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 ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
GroupUsers_ListByGroup (new)
Description :  Lists a collection of the members of the group, specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: User identifier path. ,
Required: False ,
}
string ,
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
state:
{
Description: User state. ,
Enum:
{
Active: No description available. ,
Blocked: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDate:
{
Description: Date of user registration. 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 ,
note:
{
Description: Administrator's note about given user. ,
Required: False ,
}
string ,
identities:
{
Description: Collection of user identities. ,
Required: False ,
}
[
{
provider:
{
Description: Identity provider name. ,
Required: False ,
}
string ,
id:
{
Description: Identifier value within provider. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
GroupUsers_Add (new)
Description :  Adds a user to the specified group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{uid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ Response (204)

{}

⚐ Response (405)

{
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 ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
GroupUsers_Remove (new)
Description :  Remove existing user from existing group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{uid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (405)

{
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 ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
Certificates_ListByService (new)
Description :  Lists a collection of all certificates in the specified service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Certificate identifier path: /certificates/{certificateId} ,
Required: False ,
}
string ,
subject:
{
Description: Subject attribute of the certificate. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Thumbprint of the certificate. ,
Required: True ,
}
string ,
expirationDate:
{
Description: Expiration date of the certificate. 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 ,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
Certificates_Get (new)
Description :  Gets the details of the certificate specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
certificateId:
{
Description: Identifier of the certificate. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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: Certificate identifier path: /certificates/{certificateId} ,
Required: False ,
}
string ,
subject:
{
Description: Subject attribute of the certificate. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Thumbprint of the certificate. ,
Required: True ,
}
string ,
expirationDate:
{
Description: Expiration date of the certificate. 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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
Certificates_CreateOrUpdate (new)
Description :  Creates or updates the certificate being used for authentication with the backend.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
certificateId:
{
Description: Identifier of the certificate entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create 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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
Certificates_Delete (new)
Description :  Deletes specific certificate.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
certificateId:
{
Description: Identifier of the certificate. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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_ListByService (new)
Description :  Lists all policy snippets.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policySnippets
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
scope:
{
Description: Policy scope. ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Snippet name. ,
Required: False ,
}
string ,
content:
{
Description: Snippet content. ,
Required: False ,
}
string ,
toolTip:
{
Description: Snippet toolTip. ,
Required: False ,
}
string ,
scope:
{
Description: Snippet scope. ,
Enum:
{
Tenant: No description available. ,
Product: No description available. ,
Api: No description available. ,
Operation: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
}
ProductSubscriptions_ListByProduct (new)
Description :  Lists the collection of subscriptions to the specified product.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/subscriptions
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the subscription within the current API Management service instance. The value is a valid relative URL in the format of /subscriptions/{sid} where {sid} is a subscription identifier. ,
Required: False ,
}
string ,
userId:
{
Description: The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{uid} where {uid} is a user identifier. ,
Required: False ,
}
string ,
productId:
{
Description: The product resource identifier of the subscribed product. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the subscription, or null if the subscription has no name. ,
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 ,
createdDate:
{
Description: Subscription creation date. 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 ,
startDate:
{
Description: Subscription activation date. 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 ,
expirationDate:
{
Description: Subscription expiration date. 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 ,
endDate:
{
Description: Date when subscription was cancelled or expired. 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 ,
notificationDate:
{
Description: Upcoming subscription expiration notification date. 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 ,
primaryKey:
{
Description: Subscription primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Subscription secondary key. ,
Required: False ,
}
string ,
stateComment:
{
Description: Optional subscription comment added by an administrator. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
Users_ListByService (new)
Description :  Lists a collection of registered users in the specified service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: User identifier path. ,
Required: False ,
}
string ,
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
state:
{
Description: User state. ,
Enum:
{
Active: No description available. ,
Blocked: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDate:
{
Description: Date of user registration. 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 ,
note:
{
Description: Administrator's note about given user. ,
Required: False ,
}
string ,
identities:
{
Description: Collection of user identities. ,
Required: False ,
}
[
{
provider:
{
Description: Identity provider name. ,
Required: False ,
}
string ,
id:
{
Description: Identifier value within provider. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
Users_Get (new)
Description :  Gets the details of the user specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 profile. ,
}
{
id:
{
Description: User identifier path. ,
Required: False ,
}
string ,
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
state:
{
Description: User state. ,
Enum:
{
Active: No description available. ,
Blocked: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDate:
{
Description: Date of user registration. 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 ,
note:
{
Description: Administrator's note about given user. ,
Required: False ,
}
string ,
identities:
{
Description: Collection of user identities. ,
Required: False ,
}
[
{
provider:
{
Description: Identity provider name. ,
Required: False ,
}
string ,
id:
{
Description: Identifier value within 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 ,
}
,
]
,
}
Users_CreateOrUpdate (new)
Description :  Creates or Updates a user.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
password:
{
Description: User Password. ,
Required: True ,
}
string ,
firstName:
{
Description: First name. ,
Required: True ,
}
string ,
lastName:
{
Description: Last name. ,
Required: True ,
}
string ,
state:
{
Description: Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. ,
Enum:
{
Active: No description available. ,
Blocked: No description available. ,
}
,
Required: False ,
}
enum ,
note:
{
Description: Optional note about a user set by the administrator. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
Users_Update (new)
Description :  Updates the details of the user specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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. ,
Required: False ,
}
string ,
password:
{
Description: Password. ,
Required: False ,
}
string ,
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
state:
{
Description: Account state. ,
Enum:
{
Active: No description available. ,
Blocked: No description available. ,
}
,
Required: False ,
}
enum ,
note:
{
Description: Note about user. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (405)

{
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 ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
Users_Delete (new)
Description :  Deletes specific user.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
}
boolean ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (405)

{
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 ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
Users_GenerateSsoUrl (new)
Description :  Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}/generateSsoUrl
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
UserGroups_ListByUser (new)
Description :  Lists all user groups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}/groups
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the group within the current API Management service instance. The value is a valid relative URL in the format of /groups/{groupId} where {groupId} is a group identifier. ,
Required: False ,
}
string ,
name:
{
Description: Group name. ,
Required: True ,
}
string ,
description:
{
Description: Group description. Can contain HTML formatting tags. ,
Required: False ,
}
string ,
builtIn:
{
Description: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. ,
Required: False ,
}
boolean ,
type:
{
Description: Group type. ,
Enum:
{
Custom: No description available. ,
System: No description available. ,
External: No description available. ,
}
,
Required: False ,
}
enum ,
externalId:
{
Description: For external groups, this property contains the id of the group from the external identity provider, e.g. Azure Active Directory; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
UserSubscriptions_ListByUser (new)
Description :  Lists the collection of subscriptions of the specified user.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}/subscriptions
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the subscription within the current API Management service instance. The value is a valid relative URL in the format of /subscriptions/{sid} where {sid} is a subscription identifier. ,
Required: False ,
}
string ,
userId:
{
Description: The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{uid} where {uid} is a user identifier. ,
Required: False ,
}
string ,
productId:
{
Description: The product resource identifier of the subscribed product. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the subscription, or null if the subscription has no name. ,
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 ,
createdDate:
{
Description: Subscription creation date. 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 ,
startDate:
{
Description: Subscription activation date. 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 ,
expirationDate:
{
Description: Subscription expiration date. 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 ,
endDate:
{
Description: Date when subscription was cancelled or expired. 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 ,
notificationDate:
{
Description: Upcoming subscription expiration notification date. 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 ,
primaryKey:
{
Description: Subscription primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Subscription secondary key. ,
Required: False ,
}
string ,
stateComment:
{
Description: Optional subscription comment added by an administrator. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
AuthorizationServers_ListByService (new)
Description :  Lists a collection of authorization servers defined within a service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
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 | ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the authorization server within the current API Management service instance. The value is a valid relative URL in the format of /authorizationServers/{authsid} where {authsid} is an authorization server identifier. ,
Required: False ,
}
string ,
name:
{
Description: User-friendly authorization server name. ,
Required: True ,
}
string ,
description:
{
Description: Description of the authorization server. Can contain HTML formatting tags. ,
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: True ,
}
string ,
authorizationEndpoint:
{
Description: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. ,
Required: True ,
}
string ,
authorizationMethods:
{
Description: HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional. ,
Required: False ,
}
[
string ,
]
,
clientAuthenticationMethod:
{
Description: Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format. ,
Required: False ,
}
[
string ,
]
,
tokenBodyParameters:
{
Description: Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}. ,
Required: False ,
}
[
{
name:
{
Description: body parameter name. ,
Required: True ,
}
string ,
value:
{
Description: body parameter value. ,
Required: True ,
}
string ,
}
,
]
,
tokenEndpoint:
{
Description: OAuth token endpoint. Contains absolute URI to entity being referenced. ,
Required: False ,
}
string ,
supportState:
{
Description: If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security. ,
Required: False ,
}
boolean ,
defaultScope:
{
Description: Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values. ,
Required: False ,
}
string ,
grantTypes:
{
Description: Form of an authorization grant, which the client uses to request the access token. ,
Required: True ,
}
[
string ,
]
,
bearerTokenSendingMethods:
{
Description: Specifies the mechanism by which access token is passed to the API. ,
Required: False ,
}
[
string ,
]
,
clientId:
{
Description: Client or app id registered with this authorization server. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Client or app secret registered with this authorization server. ,
Required: False ,
}
string ,
resourceOwnerUsername:
{
Description: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. ,
Required: False ,
}
string ,
resourceOwnerPassword:
{
Description: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total records count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
AuthorizationServers_Get (new)
Description :  Gets the details of the authorization server specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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: Uniquely identifies the authorization server within the current API Management service instance. The value is a valid relative URL in the format of /authorizationServers/{authsid} where {authsid} is an authorization server identifier. ,
Required: False ,
}
string ,
name:
{
Description: User-friendly authorization server name. ,
Required: True ,
}
string ,
description:
{
Description: Description of the authorization server. Can contain HTML formatting tags. ,
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: True ,
}
string ,
authorizationEndpoint:
{
Description: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. ,
Required: True ,
}
string ,
authorizationMethods:
{
Description: HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional. ,
Required: False ,
}
[
string ,
]
,
clientAuthenticationMethod:
{
Description: Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format. ,
Required: False ,
}
[
string ,
]
,
tokenBodyParameters:
{
Description: Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}. ,
Required: False ,
}
[
{
name:
{
Description: body parameter name. ,
Required: True ,
}
string ,
value:
{
Description: body parameter value. ,
Required: True ,
}
string ,
}
,
]
,
tokenEndpoint:
{
Description: OAuth token endpoint. Contains absolute URI to entity being referenced. ,
Required: False ,
}
string ,
supportState:
{
Description: If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security. ,
Required: False ,
}
boolean ,
defaultScope:
{
Description: Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values. ,
Required: False ,
}
string ,
grantTypes:
{
Description: Form of an authorization grant, which the client uses to request the access token. ,
Required: True ,
}
[
string ,
]
,
bearerTokenSendingMethods:
{
Description: Specifies the mechanism by which access token is passed to the API. ,
Required: False ,
}
[
string ,
]
,
clientId:
{
Description: Client or app id registered with this authorization server. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Client or app secret registered with this authorization server. ,
Required: False ,
}
string ,
resourceOwnerUsername:
{
Description: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. ,
Required: False ,
}
string ,
resourceOwnerPassword:
{
Description: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. ,
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 ,
}
,
]
,
}
AuthorizationServers_CreateOrUpdate (new)
Description :  Creates new authorization server or updates an existing authorization server.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
authsid:
{
Description: Identifier of the authorization server. ,
Required: True ,
}
string ,
parameters:
{
Description: Create or update parameters. ,
Required: True ,
}
{
id:
{
Description: Uniquely identifies the authorization server within the current API Management service instance. The value is a valid relative URL in the format of /authorizationServers/{authsid} where {authsid} is an authorization server identifier. ,
Required: False ,
}
string ,
name:
{
Description: User-friendly authorization server name. ,
Required: True ,
}
string ,
description:
{
Description: Description of the authorization server. Can contain HTML formatting tags. ,
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: True ,
}
string ,
authorizationEndpoint:
{
Description: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. ,
Required: True ,
}
string ,
authorizationMethods:
{
Description: HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional. ,
Required: False ,
}
[
string ,
]
,
clientAuthenticationMethod:
{
Description: Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format. ,
Required: False ,
}
[
string ,
]
,
tokenBodyParameters:
{
Description: Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}. ,
Required: False ,
}
[
{
name:
{
Description: body parameter name. ,
Required: True ,
}
string ,
value:
{
Description: body parameter value. ,
Required: True ,
}
string ,
}
,
]
,
tokenEndpoint:
{
Description: OAuth token endpoint. Contains absolute URI to entity being referenced. ,
Required: False ,
}
string ,
supportState:
{
Description: If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security. ,
Required: False ,
}
boolean ,
defaultScope:
{
Description: Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values. ,
Required: False ,
}
string ,
grantTypes:
{
Description: Form of an authorization grant, which the client uses to request the access token. ,
Required: True ,
}
[
string ,
]
,
bearerTokenSendingMethods:
{
Description: Specifies the mechanism by which access token is passed to the API. ,
Required: False ,
}
[
string ,
]
,
clientId:
{
Description: Client or app id registered with this authorization server. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Client or app secret registered with this authorization server. ,
Required: False ,
}
string ,
resourceOwnerUsername:
{
Description: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. ,
Required: False ,
}
string ,
resourceOwnerPassword:
{
Description: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
AuthorizationServers_Update (new)
Description :  Updates the details of the authorization server specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
description:
{
Description: Description of the authorization server. Can contain HTML formatting tags. ,
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 ,
authorizationMethods:
{
Description: HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional. ,
Required: False ,
}
[
string ,
]
,
clientAuthenticationMethod:
{
Description: Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format. ,
Required: False ,
}
[
string ,
]
,
tokenBodyParameters:
{
Description: Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}. ,
Required: False ,
}
[
{
name:
{
Description: body parameter name. ,
Required: True ,
}
string ,
value:
{
Description: body parameter value. ,
Required: True ,
}
string ,
}
,
]
,
tokenEndpoint:
{
Description: OAuth token endpoint. Contains absolute URI to entity being referenced. ,
Required: False ,
}
string ,
supportState:
{
Description: If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security. ,
Required: False ,
}
boolean ,
defaultScope:
{
Description: Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values. ,
Required: False ,
}
string ,
grantTypes:
{
Description: Form of an authorization grant, which the client uses to request the access token. ,
Required: False ,
}
[
string ,
]
,
bearerTokenSendingMethods:
{
Description: Specifies the mechanism by which access token is passed to the API. ,
Required: False ,
}
[
string ,
]
,
clientId:
{
Description: Client or app id registered with this authorization server. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client or app secret registered with this authorization server. ,
Required: False ,
}
string ,
resourceOwnerUsername:
{
Description: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. ,
Required: False ,
}
string ,
resourceOwnerPassword:
{
Description: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
AuthorizationServers_Delete (new)
Description :  Deletes specific authorization server instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
Regions_ListByService (new)
Description :  Lists all azure regions in which the service exists.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/regions
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Lists of Regions. ,
Required: False ,
}
[
{
name:
{
Description: Region name. ,
Required: True ,
}
string ,
isMasterRegion:
{
Description: whether Region is the master region. ,
Required: True ,
}
boolean ,
}
,
]
,
}
UserIdentities_ListByUser (new)
Description :  Lists all user identities.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}/identities
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
provider:
{
Description: Identity provider name. ,
Required: False ,
}
string ,
id:
{
Description: Identifier value within 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 ,
}
,
]
,
}
Reports_ListByService (new)
Description :  Lists report records.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/{aggregation}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
aggregation:
{
Description: Report aggregation. ,
Required: True ,
}
string ,
$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. This value is only applicable to ByTime aggregation. 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 TimSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)) ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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. ,
Format: int64 ,
Required: False ,
}
integer ,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
callCountBlocked:
{
Description: Number of calls blocked due to invalid credentials. ,
Format: int32 ,
Required: False ,
}
integer ,
callCountFailed:
{
Description: Number of calls failed due to proxy or backend errors. ,
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 records count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
TenantAccess_Get (new)
Description :  Get tenant access information details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/access
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/access
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters. ,
Required: True ,
}
{
enabled:
{
Description: Tenant access information of the API Management service. ,
Required: True ,
}
boolean ,
}
,
If-Match:
{
Description: The entity state (Etag) version of the tenant access settings 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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/access/regeneratePrimaryKey
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/access/regenerateSecondaryKey
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
Loggers_ListByService (new)
Description :  Lists a collection of loggers in the specified service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Logger values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the logger within the current API Management service instance. The value is a valid relative URL in the format of /loggers/{loggerId} where {loggerId} is a logger identifier. ,
Required: False ,
}
string ,
type:
{
Description: Logger type. ,
Enum:
{
AzureEventHub: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Logger description. ,
Required: False ,
}
string ,
credentials:
{
Description: The name and SendRule connection string of the event hub. ,
Required: True ,
}
object ,
isBuffered:
{
Description: Whether records are buffered in the logger before publishing. Default is assumed to be true. ,
Required: False ,
}
boolean ,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
Loggers_Get (new)
Description :  Gets the details of the logger specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
loggerid:
{
Description: Identifier of the logger. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs. ,
}
{
id:
{
Description: Uniquely identifies the logger within the current API Management service instance. The value is a valid relative URL in the format of /loggers/{loggerId} where {loggerId} is a logger identifier. ,
Required: False ,
}
string ,
type:
{
Description: Logger type. ,
Enum:
{
AzureEventHub: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Logger description. ,
Required: False ,
}
string ,
credentials:
{
Description: The name and SendRule connection string of the event hub. ,
Required: True ,
}
object ,
isBuffered:
{
Description: Whether records are buffered in the logger before publishing. Default is assumed to be true. ,
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 ,
}
,
]
,
}
Loggers_CreateOrUpdate (new)
Description :  Creates or Updates a logger.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
loggerid:
{
Description: Identifier of the logger. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
type:
{
Description: Logger type. ,
Enum:
{
AzureEventHub: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Logger description. ,
Required: False ,
}
string ,
credentials:
{
Description: The name and SendRule connection string of the event hub. ,
Required: True ,
}
object ,
isBuffered:
{
Description: Whether records are buffered in the logger before publishing. Default is assumed to be true. ,
Required: False ,
}
boolean ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
Loggers_Update (new)
Description :  Updates an existing logger.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
loggerid:
{
Description: Identifier of the logger. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
type:
{
Description: Logger type. ,
Enum:
{
AzureEventHub: No description available. ,
}
,
Required: True ,
}
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
Loggers_Delete (new)
Description :  Deletes the specified logger.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
loggerid:
{
Description: Identifier of the logger. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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_ListByService (new)
Description :  Lists a collection of properties defined within a service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/properties
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the property within the current API Management service instance. The value is a valid relative URL in the format of /properties/{propId} where {propId} is a property identifier. ,
Required: False ,
}
string ,
name:
{
Description: Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters. ,
Required: True ,
}
string ,
value:
{
Description: Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace. ,
Required: True ,
}
string ,
tags:
{
Description: Optional tags that when provided can be used to filter the property list. ,
Required: False ,
}
[
string ,
]
,
secret:
{
Description: Determines whether the value is a secret and should be encrypted or not. Default value is false. ,
Required: False ,
}
boolean ,
}
,
]
,
count:
{
Description: Total records count number. ,
Format: int64 ,
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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/properties/{propId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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: Uniquely identifies the property within the current API Management service instance. The value is a valid relative URL in the format of /properties/{propId} where {propId} is a property identifier. ,
Required: False ,
}
string ,
name:
{
Description: Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters. ,
Required: True ,
}
string ,
value:
{
Description: Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace. ,
Required: True ,
}
string ,
tags:
{
Description: Optional tags that when provided can be used to filter the property list. ,
Required: False ,
}
[
string ,
]
,
secret:
{
Description: Determines whether the value is a secret and should be encrypted or not. Default value is false. ,
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 ,
}
,
]
,
}
Property_CreateOrUpdate (new)
Description :  Creates or updates a property.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/properties/{propId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
propId:
{
Description: Identifier of the property. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
name:
{
Description: Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters. ,
Required: True ,
}
string ,
value:
{
Description: Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace. ,
Required: True ,
}
string ,
tags:
{
Description: Optional tags that when provided can be used to filter the property list. ,
Required: False ,
}
[
string ,
]
,
secret:
{
Description: Determines whether the value is a secret and should be encrypted or not. Default value is false. ,
Required: False ,
}
boolean ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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_Update (new)
Description :  Updates the specific property.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/properties/{propId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
tags:
{
Description: Optional tags that when provided can be used to filter the property list. ,
Required: False ,
}
[
string ,
]
,
secret:
{
Description: Determines whether the value is a secret and should be encrypted or not. Default value is false. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/properties/{propId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (405)

{
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 ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
OpenIdConnectProviders_ListByService (new)
Description :  Lists all OpenID Connect Providers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
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 | ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: OpenID Connect Provider identifier. ,
Required: False ,
}
string ,
name:
{
Description: User-friendly OpenID Connect Provider name. ,
Required: True ,
}
string ,
description:
{
Description: User-friendly description of OpenID Connect Provider. ,
Required: False ,
}
string ,
metadataEndpoint:
{
Description: Metadata endpoint URI. ,
Required: True ,
}
string ,
clientId:
{
Description: Client ID of developer console which is the client application. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Client Secret of developer console which is the client application. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total records count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
OpenIdConnectProviders_Get (new)
Description :  Gets specific OpenID Connect Provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 Providers Contract. ,
}
{
id:
{
Description: OpenID Connect Provider identifier. ,
Required: False ,
}
string ,
name:
{
Description: User-friendly OpenID Connect Provider name. ,
Required: True ,
}
string ,
description:
{
Description: User-friendly description of OpenID Connect Provider. ,
Required: False ,
}
string ,
metadataEndpoint:
{
Description: Metadata endpoint URI. ,
Required: True ,
}
string ,
clientId:
{
Description: Client ID of developer console which is the client application. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Client Secret of developer console which is the client application. ,
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 ,
}
,
]
,
}
OpenIdConnectProviders_CreateOrUpdate (new)
Description :  Creates or updates the OpenID Connect Provider.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
opid:
{
Description: Identifier of the OpenID Connect Provider. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
name:
{
Description: User-friendly OpenID Connect Provider name. ,
Required: True ,
}
string ,
description:
{
Description: User-friendly description of OpenID Connect Provider. ,
Required: False ,
}
string ,
metadataEndpoint:
{
Description: Metadata endpoint URI. ,
Required: True ,
}
string ,
clientId:
{
Description: Client ID of developer console which is the client application. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Client Secret of developer console which is the client application. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
OpenIdConnectProviders_Update (new)
Description :  Updates the specific OpenID Connect Provider.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
OpenIdConnectProviders_Delete (new)
Description :  Deletes specific OpenID Connect Provider of the API Management service instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (405)

{
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 ,
}
,
]
,
}

⚐ 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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/access/git
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/access/git/regeneratePrimaryKey
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/access/git/regenerateSecondaryKey
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/deploy
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}

⚐ 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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/save
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}

⚐ 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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/validate
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
]
,
}
TenantConfigurationSyncState_Get (new)
Description :  Gets the status of the most recent synchronization between the configuration database and the Git repository.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/syncState
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
Backends_ListByService (new)
Description :  Lists a collection of backends in the specified service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Backend values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the backend within the current API Management service instance. The value is a valid relative URL in the format of /backends/{backendId} where {backendId} is a backend identifier. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
Backends_Get (new)
Description :  Gets the details of the backend specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
backendid:
{
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 Backend entity in API Management represents a backend service that is configured to skip certification chain validation when using a self-signed certificate to test mutual certificate authentication. ,
}
{
id:
{
Description: Uniquely identifies the backend within the current API Management service instance. The value is a valid relative URL in the format of /backends/{backendId} where {backendId} is a backend identifier. ,
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 ,
}
,
]
,
}
Backends_CreateOrUpdate (new)
Description :  Creates or Updates a backend.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
backendid:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
host:
{
Description: Host attribute of the backend. Host is a pure hostname without a port or suffix, for example backend.contoso.com. Must not be empty. ,
Required: True ,
}
string ,
skipCertificateChainValidation:
{
Description: Flag indicating whether SSL certificate chain validation should be skipped when using self-signed certificates for this backend host. ,
Required: False ,
}
boolean ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
Backends_Update (new)
Description :  Updates an existing backend.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
backendid:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
host:
{
Description: Host attribute of the backend. Host is a pure hostname without a port or suffix, for example backend.contoso.com. Must not be empty. ,
Required: False ,
}
string ,
skipCertificateChainValidation:
{
Description: Flag indicating whether SSL certificate chain validation should be skipped when using self-signed certificates for this backend host. ,
Required: False ,
}
boolean ,
}
,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
Backends_Delete (new)
Description :  Deletes the specified backend.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
backendid:
{
Description: User identifier. 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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
IdentityProviders_ListByService (new)
Description :  Lists a collection of Identity Provider configured in the specified service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
}
[
{
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: True ,
}
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: True ,
}
string ,
type:
{
Description: Identity Provider Type identifier. ,
Enum:
{
facebook: No description available. ,
google: No description available. ,
microsoft: No description available. ,
twitter: No description available. ,
aad: No description available. ,
}
,
Required: False ,
}
enum ,
allowedTenants:
{
Description: List of Allowed Tenants when configuring Azure Active Directory login. ,
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 ,
}
,
]
,
}
IdentityProviders_Get (new)
Description :  Gets the configuration details of the identity Provider configured in specified service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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: The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users. ,
}
{
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: True ,
}
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: True ,
}
string ,
type:
{
Description: Identity Provider Type identifier. ,
Enum:
{
facebook: No description available. ,
google: No description available. ,
microsoft: No description available. ,
twitter: No description available. ,
aad: No description available. ,
}
,
Required: False ,
}
enum ,
allowedTenants:
{
Description: List of Allowed Tenants when configuring Azure Active Directory login. ,
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 ,
}
,
]
,
}
IdentityProviders_CreateOrUpdate (new)
Description :  Creates or Updates the IdentityProvider configuration.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
identityProviderName:
{
Description: Identity Provider Type identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: Create 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: True ,
}
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: True ,
}
string ,
type:
{
Description: Identity Provider Type identifier. ,
Enum:
{
facebook: No description available. ,
google: No description available. ,
microsoft: No description available. ,
twitter: No description available. ,
aad: No description available. ,
}
,
Required: False ,
}
enum ,
allowedTenants:
{
Description: List of Allowed Tenants when configuring Azure Active Directory login. ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
IdentityProviders_Update (new)
Description :  Updates an existing IdentityProvider configuration.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
allowedTenants:
{
Description: List of Allowed Tenants when configuring Azure Active Directory login. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
IdentityProviders_Delete (new)
Description :  Deletes the specified identity provider configuration.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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_ListByService (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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
quotaCounterKey:
{
Description: Quota counter key identifier. ,
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 ,
}
,
]
,
count:
{
Description: Total records count number. ,
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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
quotaCounterKey:
{
Description: Quota counter key identifier. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}/{quotaPeriodKey}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
quotaCounterKey:
{
Description: Quota counter key identifier. ,
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 ,
}

⚐ 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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}/{quotaPeriodKey}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
quotaCounterKey:
{
Description: Quota counter key identifier. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
ApiManagementServices_ManageDeployments (new)
Description :  Manages deployments of an API Management service. This operation can be used to do the following: Change SKU, Change SKU Units, Change Service Tier (Developer/Standard/Premium) and Manage VPN Configuration. This is a long running operation and can take several minutes to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/managedeployments
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the ManageDeployments operation. ,
Required: True ,
}
{
location:
{
Description: Location of the API Management service Azure data center. ,
Required: True ,
}
string ,
skuType:
{
Description: SKU type of the API Management service. ,
Enum:
{
Developer: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
skuUnitCount:
{
Description: SKU Unit count of the API Management service. Default value is 1. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalLocations:
{
Description: Additional data center locations for the API Management service. ,
Required: False ,
}
[
{
location:
{
Description: The location name of the additional region among Azure Data center regions. ,
Required: True ,
}
string ,
skuType:
{
Description: The SKU type in the location. ,
Enum:
{
Developer: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
skuUnitCount:
{
Description: The SKU Unit count at the location. The maximum SKU Unit count depends on the SkuType. Maximum allowed for Developer SKU is 1, for Standard SKU is 4, and for Premium SKU is 10, at a location. ,
Format: int32 ,
Required: False ,
}
integer ,
staticIPs:
{
Description: Static IP addresses of the location's virtual machines. ,
Required: False ,
}
[
string ,
]
,
vpnconfiguration:
{
Description: Virtual network configuration for the location. ,
Required: False ,
}
{
vnetid:
{
Description: The virtual network ID. This is typically a GUID. Expect a null GUID by default. ,
Required: False ,
}
string ,
subnetname:
{
Description: The name of the subnet. ,
Required: False ,
}
string ,
subnetResourceId:
{
Description: The name of the subnet Resource ID. This has format /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/{virtual network name}/subnets/{subnet name}. ,
Required: False ,
}
string ,
location:
{
Description: The location of the virtual network. ,
Required: False ,
}
string ,
}
,
}
,
]
,
vpnConfiguration:
{
Description: Virtual network configuration. ,
Required: False ,
}
{
vnetid:
{
Description: The virtual network ID. This is typically a GUID. Expect a null GUID by default. ,
Required: False ,
}
string ,
subnetname:
{
Description: The name of the subnet. ,
Required: False ,
}
string ,
subnetResourceId:
{
Description: The name of the subnet Resource ID. This has format /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/{virtual network name}/subnets/{subnet name}. ,
Required: False ,
}
string ,
location:
{
Description: The location of the virtual network. ,
Required: False ,
}
string ,
}
,
vpnType:
{
Description: The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that the API Management service deployment is set up inside a Virtual Network having an Intranet Facing Endpoint only. When vpnConfiguration is specified, vpnType must be specified. ,
Enum:
{
None: No description available. ,
External: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the created API Management service. ,
Required: False ,
}
string ,
location:
{
Description: Datacenter location of the API Management service. ,
Required: True ,
}
string ,
name:
{
Description: Name of the API Management service. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the API Management service. ,
Required: False ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApiManagementServices_Restore (new)
Description :  Restores a backup of an API Management service created using the ApiManagementServices_Backup operation on the current service. This is a long running operation and could take several minutes to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/restore
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Restore API Management service from backup operation. ,
Required: True ,
}
{
storageAccount:
{
Description: Azure Cloud Storage account (used to place/retrieve the backup) name. ,
Required: True ,
}
string ,
accessKey:
{
Description: Azure Cloud Storage account (used to place/retrieve the backup) access key. ,
Required: True ,
}
string ,
containerName:
{
Description: Azure Cloud Storage blob container name used to place/retrieve the backup. ,
Required: True ,
}
string ,
backupName:
{
Description: The name of the backup file to create. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the created API Management service. ,
Required: False ,
}
string ,
location:
{
Description: Datacenter location of the API Management service. ,
Required: True ,
}
string ,
name:
{
Description: Name of the API Management service. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the API Management service. ,
Required: False ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApiManagementServices_Backup (new)
Description :  Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backup
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the ApiManagementServices_Backup operation. ,
Required: True ,
}
{
storageAccount:
{
Description: Azure Cloud Storage account (used to place/retrieve the backup) name. ,
Required: True ,
}
string ,
accessKey:
{
Description: Azure Cloud Storage account (used to place/retrieve the backup) access key. ,
Required: True ,
}
string ,
containerName:
{
Description: Azure Cloud Storage blob container name used to place/retrieve the backup. ,
Required: True ,
}
string ,
backupName:
{
Description: The name of the backup file to create. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the created API Management service. ,
Required: False ,
}
string ,
location:
{
Description: Datacenter location of the API Management service. ,
Required: True ,
}
string ,
name:
{
Description: Name of the API Management service. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the API Management service. ,
Required: False ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApiManagementServices_CreateOrUpdate (new)
Description :  Creates or updates an API Management service. This is long running operation and could take several minutes to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate API Management service operation. ,
Required: True ,
}
{
id:
{
Description: The ID of the created API Management service. ,
Required: False ,
}
string ,
location:
{
Description: Datacenter location of the API Management service. ,
Required: True ,
}
string ,
name:
{
Description: Name of the API Management service. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the API Management service. ,
Required: False ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the created API Management service. ,
Required: False ,
}
string ,
location:
{
Description: Datacenter location of the API Management service. ,
Required: True ,
}
string ,
name:
{
Description: Name of the API Management service. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the API Management service. ,
Required: False ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: The ID of the created API Management service. ,
Required: False ,
}
string ,
location:
{
Description: Datacenter location of the API Management service. ,
Required: True ,
}
string ,
name:
{
Description: Name of the API Management service. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the API Management service. ,
Required: False ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApiManagementServices_Update (new)
Description :  Updates an existing API Management service.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate API Management service operation. ,
Required: True ,
}
{
tags:
{
Description: API Management service tags. A maximum of 10 tags can be provided for a resource, and each tag must have a key no greater than 128 characters (and a value no greater than 256 characters). ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the API Management service. ,
Required: False ,
}
{
publisherEmail:
{
Description: Publisher email. ,
Required: True ,
}
string ,
publisherName:
{
Description: Publisher name. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. ,
Required: False ,
}
string ,
targetProvisioningState:
{
Description: The provisioning state of the API Management service, which is targeted by the long running operation started on the service. ,
Required: False ,
}
string ,
createdAtUtc:
{
Description: Creation UTC date of the API Management service.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 ,
runtimeUrl:
{
Description: Proxy endpoint URL of the API Management service. ,
Required: False ,
}
string ,
portalUrl:
{
Description: Publisher portal endpoint Url of the API Management service. ,
Required: False ,
}
string ,
managementApiUrl:
{
Description: Management API endpoint URL of the API Management service. ,
Required: False ,
}
string ,
scmUrl:
{
Description: SCM endpoint URL of the API Management service. ,
Required: False ,
}
string ,
addresserEmail:
{
Description: Addresser email. ,
Required: False ,
}
string ,
hostnameConfigurations:
{
Description: Custom hostname configuration of the API Management service. ,
Required: False ,
}
[
{
type:
{
Description: Hostname type. ,
Enum:
{
Proxy: No description available. ,
Portal: No description available. ,
Management: No description available. ,
Scm: No description available. ,
}
,
Required: True ,
}
enum ,
hostname:
{
Description: Hostname. ,
Required: True ,
}
string ,
certificate:
{
Description: Certificate information. ,
Required: True ,
}
{
expiry:
{
Description: Expiration date of the certificate. 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 ,
thumbprint:
{
Description: Thumbprint of the certificate. ,
Required: True ,
}
string ,
subject:
{
Description: Subject of the certificate. ,
Required: True ,
}
string ,
}
,
}
,
]
,
staticIPs:
{
Description: Static IP addresses of the API Management service virtual machines. Available only for Standard and Premium SKU. ,
Required: False ,
}
[
string ,
]
,
vpnconfiguration:
{
Description: Virtual network configuration of the API Management service. ,
Required: False ,
}
{
vnetid:
{
Description: The virtual network ID. This is typically a GUID. Expect a null GUID by default. ,
Required: False ,
}
string ,
subnetname:
{
Description: The name of the subnet. ,
Required: False ,
}
string ,
subnetResourceId:
{
Description: The name of the subnet Resource ID. This has format /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/{virtual network name}/subnets/{subnet name}. ,
Required: False ,
}
string ,
location:
{
Description: The location of the virtual network. ,
Required: False ,
}
string ,
}
,
additionalLocations:
{
Description: Additional datacenter locations of the API Management service. ,
Required: False ,
}
[
{
location:
{
Description: The location name of the additional region among Azure Data center regions. ,
Required: True ,
}
string ,
skuType:
{
Description: The SKU type in the location. ,
Enum:
{
Developer: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
skuUnitCount:
{
Description: The SKU Unit count at the location. The maximum SKU Unit count depends on the SkuType. Maximum allowed for Developer SKU is 1, for Standard SKU is 4, and for Premium SKU is 10, at a location. ,
Format: int32 ,
Required: False ,
}
integer ,
staticIPs:
{
Description: Static IP addresses of the location's virtual machines. ,
Required: False ,
}
[
string ,
]
,
vpnconfiguration:
{
Description: Virtual network configuration for the location. ,
Required: False ,
}
{
vnetid:
{
Description: The virtual network ID. This is typically a GUID. Expect a null GUID by default. ,
Required: False ,
}
string ,
subnetname:
{
Description: The name of the subnet. ,
Required: False ,
}
string ,
subnetResourceId:
{
Description: The name of the subnet Resource ID. This has format /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/{virtual network name}/subnets/{subnet name}. ,
Required: False ,
}
string ,
location:
{
Description: The location of the virtual network. ,
Required: False ,
}
string ,
}
,
}
,
]
,
customProperties:
{
Description: Custom properties of the API Management service, like disabling TLS 1.0. ,
Required: False ,
}
object ,
vpnType:
{
Description: The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only. ,
Enum:
{
None: No description available. ,
External: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: SKU properties of the API Management service. ,
Required: False ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Developer: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: Capacity of the SKU (number of deployed units of the SKU). The default value is 1. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the created API Management service. ,
Required: False ,
}
string ,
location:
{
Description: Datacenter location of the API Management service. ,
Required: True ,
}
string ,
name:
{
Description: Name of the API Management service. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the API Management service. ,
Required: False ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApiManagementServices_Get (new)
Description :  Gets an API Management service resource description.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the created API Management service. ,
Required: False ,
}
string ,
location:
{
Description: Datacenter location of the API Management service. ,
Required: True ,
}
string ,
name:
{
Description: Name of the API Management service. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the API Management service. ,
Required: False ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (404)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApiManagementServices_Delete (new)
Description :  Deletes an existing API Management service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (404)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApiManagementServices_ListByResourceGroup (new)
Description :  List all API Management services within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List API Management services operation. ,
Required: True ,
}
[
{
id:
{
Description: The ID of the created API Management service. ,
Required: False ,
}
string ,
location:
{
Description: Datacenter location of the API Management service. ,
Required: True ,
}
string ,
name:
{
Description: Name of the API Management service. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the API Management service. ,
Required: False ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of API Management services. ,
Required: False ,
}
string ,
}
ApiManagementServices_List (new)
Description :  Lists all API Management services within an Azure subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/service/
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List API Management services operation. ,
Required: True ,
}
[
{
id:
{
Description: The ID of the created API Management service. ,
Required: False ,
}
string ,
location:
{
Description: Datacenter location of the API Management service. ,
Required: True ,
}
string ,
name:
{
Description: Name of the API Management service. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the API Management service. ,
Required: False ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of API Management services. ,
Required: False ,
}
string ,
}
ApiManagementServices_GetSsoToken (new)
Description :  Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/getssotoken
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
redirect_uri:
{
Description: Redirect URL containing the SSO token. ,
Required: False ,
}
string ,
}
ApiManagementServices_CheckNameAvailability (new)
Description :  Checks availability and correctness of a name for an API Management service.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/checkNameAvailability
{
parameters:
{
Description: Parameters supplied to the CheckNameAvailability operation. ,
Required: True ,
}
{
name:
{
Description: The name to check for availability. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nameAvailable:
{
Description: True if the name is available and can be used to create a new API Management service; otherwise false. ,
Required: True ,
}
boolean ,
message:
{
Description: If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that is already in use, and direct them to select a different name. ,
Required: False ,
}
string ,
reason:
{
Description: Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
}
ApiManagementServices_UploadCertificate (new)
Description :  Upload Custom Domain SSL certificate for an API Management service.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/updatecertificate
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Upload SSL certificate for an API Management service operation. ,
Required: True ,
}
{
type:
{
Description: Hostname type. ,
Enum:
{
Proxy: No description available. ,
Portal: No description available. ,
Management: No description available. ,
Scm: No description available. ,
}
,
Required: True ,
}
enum ,
certificate:
{
Description: Base64 Encoded certificate. ,
Required: True ,
}
string ,
certificate_password:
{
Description: Certificate password. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
expiry:
{
Description: Expiration date of the certificate. 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 ,
thumbprint:
{
Description: Thumbprint of the certificate. ,
Required: True ,
}
string ,
subject:
{
Description: Subject of the certificate. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApiManagementServices_UpdateHostname (new)
Description :  Creates, updates, or deletes the custom hostnames for an API Management service. The custom hostname can be applied to the Proxy and Portal endpoint. This is a long running operation and could take several minutes to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/updatehostname
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the UpdateHostname operation. ,
Required: True ,
}
{
update:
{
Description: Hostnames to create or update. ,
Required: False ,
}
[
{
type:
{
Description: Hostname type. ,
Enum:
{
Proxy: No description available. ,
Portal: No description available. ,
Management: No description available. ,
Scm: No description available. ,
}
,
Required: True ,
}
enum ,
hostname:
{
Description: Hostname. ,
Required: True ,
}
string ,
certificate:
{
Description: Certificate information. ,
Required: True ,
}
{
expiry:
{
Description: Expiration date of the certificate. 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 ,
thumbprint:
{
Description: Thumbprint of the certificate. ,
Required: True ,
}
string ,
subject:
{
Description: Subject of the certificate. ,
Required: True ,
}
string ,
}
,
}
,
]
,
delete:
{
Description: Hostnames types to delete. ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the created API Management service. ,
Required: False ,
}
string ,
location:
{
Description: Datacenter location of the API Management service. ,
Required: True ,
}
string ,
name:
{
Description: Name of the API Management service. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the API Management service. ,
Required: False ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
Apis_ListByService (removed)
Description :  Lists all APIs of the API Management service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: API identifier path: /apis/{apiId} ,
Required: False ,
}
string ,
name:
{
Description: API name. ,
Required: True ,
}
string ,
description:
{
Description: Description of the API. May include HTML formatting tags. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. ,
Required: True ,
}
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: True ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: True ,
}
[
string ,
]
,
authenticationSettings:
{
Description: Collection of authentication settings included into this API. ,
Required: False ,
}
{
oAuth2:
{
Description: API OAuth2 Authentication settings details. ,
Required: False ,
}
{
authorizationServerId:
{
Description: OAuth authorization server identifier. ,
Required: False ,
}
string ,
scope:
{
Description: operations scope. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionKeyParameterNames:
{
Description: Protocols over which API is made available. ,
Required: False ,
}
{
header:
{
Description: Subscription key header name. ,
Required: False ,
}
string ,
query:
{
Description: Subscription key query string parameter name. ,
Required: False ,
}
string ,
}
,
type:
{
Description: Type of API. ,
Enum:
{
Http: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
Apis_Get (removed)
Description :  Gets the details of the API specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 details. ,
}
{
id:
{
Description: API identifier path: /apis/{apiId} ,
Required: False ,
}
string ,
name:
{
Description: API name. ,
Required: True ,
}
string ,
description:
{
Description: Description of the API. May include HTML formatting tags. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. ,
Required: True ,
}
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: True ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: True ,
}
[
string ,
]
,
authenticationSettings:
{
Description: Collection of authentication settings included into this API. ,
Required: False ,
}
{
oAuth2:
{
Description: API OAuth2 Authentication settings details. ,
Required: False ,
}
{
authorizationServerId:
{
Description: OAuth authorization server identifier. ,
Required: False ,
}
string ,
scope:
{
Description: operations scope. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionKeyParameterNames:
{
Description: Protocols over which API is made available. ,
Required: False ,
}
{
header:
{
Description: Subscription key header name. ,
Required: False ,
}
string ,
query:
{
Description: Subscription key query string parameter name. ,
Required: False ,
}
string ,
}
,
type:
{
Description: Type of API. ,
Enum:
{
Http: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
Apis_CreateOrUpdate (removed)
Description :  Creates new or updates existing specified API of the API Management service instance.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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: API identifier path: /apis/{apiId} ,
Required: False ,
}
string ,
name:
{
Description: API name. ,
Required: True ,
}
string ,
description:
{
Description: Description of the API. May include HTML formatting tags. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. ,
Required: True ,
}
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: True ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: True ,
}
[
string ,
]
,
authenticationSettings:
{
Description: Collection of authentication settings included into this API. ,
Required: False ,
}
{
oAuth2:
{
Description: API OAuth2 Authentication settings details. ,
Required: False ,
}
{
authorizationServerId:
{
Description: OAuth authorization server identifier. ,
Required: False ,
}
string ,
scope:
{
Description: operations scope. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionKeyParameterNames:
{
Description: Protocols over which API is made available. ,
Required: False ,
}
{
header:
{
Description: Subscription key header name. ,
Required: False ,
}
string ,
query:
{
Description: Subscription key query string parameter name. ,
Required: False ,
}
string ,
}
,
type:
{
Description: Type of API. ,
Enum:
{
Http: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
Apis_Update (removed)
Description :  Updates the specified API of the API Management service instance.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
apiId:
{
Description: API identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Patch parameters. ,
Required: True ,
}
{
RawJson:
{
Description: json value. ,
Required: True ,
}
object ,
}
,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
Apis_Delete (removed)
Description :  Deletes the specified API of the API Management service instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
ApiOperations_ListByApi (removed)
Description :  Lists a collection of the operations for the specified API.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the operation within the current API Management service instance. The value is a valid relative URL in the format of /apis/{aid}/operations/{id} where {aid} is an API identifier and {id} is an operation identifier. ,
Required: False ,
}
string ,
name:
{
Description: Operation Name. ,
Required: True ,
}
string ,
method:
{
Description: A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. ,
Required: True ,
}
string ,
urlTemplate:
{
Description: Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} ,
Required: True ,
}
string ,
templateParameters:
{
Description: Collection of URL template parameters. ,
Required: False ,
}
[
{
name:
{
Description: Parameter name. ,
Required: True ,
}
string ,
description:
{
Description: Parameter description. ,
Required: False ,
}
string ,
type:
{
Description: Parameter type. ,
Required: True ,
}
string ,
defaultValue:
{
Description: Default parameter value. ,
Required: False ,
}
string ,
required:
{
Description: whether parameter is required or not. ,
Required: False ,
}
boolean ,
values:
{
Description: Parameter values. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
description:
{
Description: Description of the operation. May include HTML formatting tags. ,
Required: False ,
}
string ,
request:
{
Description: An entity containing request details. ,
Required: False ,
}
{
description:
{
Description: Operation request description. ,
Required: False ,
}
string ,
queryParameters:
{
Description: Collection of operation request query parameters. ,
Required: False ,
}
[
{
name:
{
Description: Parameter name. ,
Required: True ,
}
string ,
description:
{
Description: Parameter description. ,
Required: False ,
}
string ,
type:
{
Description: Parameter type. ,
Required: True ,
}
string ,
defaultValue:
{
Description: Default parameter value. ,
Required: False ,
}
string ,
required:
{
Description: whether parameter is required or not. ,
Required: False ,
}
boolean ,
values:
{
Description: Parameter values. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
headers:
{
Description: Collection of operation request headers. ,
Required: False ,
}
[
{
name:
{
Description: Parameter name. ,
Required: True ,
}
string ,
description:
{
Description: Parameter description. ,
Required: False ,
}
string ,
type:
{
Description: Parameter type. ,
Required: True ,
}
string ,
defaultValue:
{
Description: Default parameter value. ,
Required: False ,
}
string ,
required:
{
Description: whether parameter is required or not. ,
Required: False ,
}
boolean ,
values:
{
Description: Parameter values. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
representations:
{
Description: Collection of operation request representations. ,
Required: False ,
}
[
{
contentType:
{
Description: Specifies a registered or custom content type for this representation, e.g. application/xml. ,
Required: True ,
}
string ,
sample:
{
Description: An example of the representation. ,
Required: False ,
}
string ,
}
,
]
,
}
,
responses:
{
Description: Array of Operation responses. ,
Required: False ,
}
[
{
statusCode:
{
Description: Operation response HTTP status code. ,
Format: int32 ,
Required: True ,
}
integer ,
description:
{
Description: Operation response description. ,
Required: False ,
}
string ,
representations:
{
Description: Collection of operation response representations. ,
Required: False ,
}
[
{
contentType:
{
Description: Specifies a registered or custom content type for this representation, e.g. application/xml. ,
Required: True ,
}
string ,
sample:
{
Description: An example of the representation. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
ApiOperations_Get (removed)
Description :  Gets the details of the API Operation specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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: Uniquely identifies the operation within the current API Management service instance. The value is a valid relative URL in the format of /apis/{aid}/operations/{id} where {aid} is an API identifier and {id} is an operation identifier. ,
Required: False ,
}
string ,
name:
{
Description: Operation Name. ,
Required: True ,
}
string ,
method:
{
Description: A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. ,
Required: True ,
}
string ,
urlTemplate:
{
Description: Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} ,
Required: True ,
}
string ,
templateParameters:
{
Description: Collection of URL template parameters. ,
Required: False ,
}
[
{
name:
{
Description: Parameter name. ,
Required: True ,
}
string ,
description:
{
Description: Parameter description. ,
Required: False ,
}
string ,
type:
{
Description: Parameter type. ,
Required: True ,
}
string ,
defaultValue:
{
Description: Default parameter value. ,
Required: False ,
}
string ,
required:
{
Description: whether parameter is required or not. ,
Required: False ,
}
boolean ,
values:
{
Description: Parameter values. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
description:
{
Description: Description of the operation. May include HTML formatting tags. ,
Required: False ,
}
string ,
request:
{
Description: An entity containing request details. ,
Required: False ,
}
{
description:
{
Description: Operation request description. ,
Required: False ,
}
string ,
queryParameters:
{
Description: Collection of operation request query parameters. ,
Required: False ,
}
[
{
name:
{
Description: Parameter name. ,
Required: True ,
}
string ,
description:
{
Description: Parameter description. ,
Required: False ,
}
string ,
type:
{
Description: Parameter type. ,
Required: True ,
}
string ,
defaultValue:
{
Description: Default parameter value. ,
Required: False ,
}
string ,
required:
{
Description: whether parameter is required or not. ,
Required: False ,
}
boolean ,
values:
{
Description: Parameter values. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
headers:
{
Description: Collection of operation request headers. ,
Required: False ,
}
[
{
name:
{
Description: Parameter name. ,
Required: True ,
}
string ,
description:
{
Description: Parameter description. ,
Required: False ,
}
string ,
type:
{
Description: Parameter type. ,
Required: True ,
}
string ,
defaultValue:
{
Description: Default parameter value. ,
Required: False ,
}
string ,
required:
{
Description: whether parameter is required or not. ,
Required: False ,
}
boolean ,
values:
{
Description: Parameter values. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
representations:
{
Description: Collection of operation request representations. ,
Required: False ,
}
[
{
contentType:
{
Description: Specifies a registered or custom content type for this representation, e.g. application/xml. ,
Required: True ,
}
string ,
sample:
{
Description: An example of the representation. ,
Required: False ,
}
string ,
}
,
]
,
}
,
responses:
{
Description: Array of Operation responses. ,
Required: False ,
}
[
{
statusCode:
{
Description: Operation response HTTP status code. ,
Format: int32 ,
Required: True ,
}
integer ,
description:
{
Description: Operation response description. ,
Required: False ,
}
string ,
representations:
{
Description: Collection of operation response representations. ,
Required: False ,
}
[
{
contentType:
{
Description: Specifies a registered or custom content type for this representation, e.g. application/xml. ,
Required: True ,
}
string ,
sample:
{
Description: An example of the representation. ,
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 ,
}
,
]
,
}
ApiOperations_CreateOrUpdate (removed)
Description :  Creates a new API operation or updates an existing one.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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: Uniquely identifies the operation within the current API Management service instance. The value is a valid relative URL in the format of /apis/{aid}/operations/{id} where {aid} is an API identifier and {id} is an operation identifier. ,
Required: False ,
}
string ,
name:
{
Description: Operation Name. ,
Required: True ,
}
string ,
method:
{
Description: A Valid HTTP Operation Method. Typical Http Methods like GET, PUT, POST but not limited by only them. ,
Required: True ,
}
string ,
urlTemplate:
{
Description: Relative URL template identifying the target resource for this operation. May include parameters. Example: /customers/{cid}/orders/{oid}/?date={date} ,
Required: True ,
}
string ,
templateParameters:
{
Description: Collection of URL template parameters. ,
Required: False ,
}
[
{
name:
{
Description: Parameter name. ,
Required: True ,
}
string ,
description:
{
Description: Parameter description. ,
Required: False ,
}
string ,
type:
{
Description: Parameter type. ,
Required: True ,
}
string ,
defaultValue:
{
Description: Default parameter value. ,
Required: False ,
}
string ,
required:
{
Description: whether parameter is required or not. ,
Required: False ,
}
boolean ,
values:
{
Description: Parameter values. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
description:
{
Description: Description of the operation. May include HTML formatting tags. ,
Required: False ,
}
string ,
request:
{
Description: An entity containing request details. ,
Required: False ,
}
{
description:
{
Description: Operation request description. ,
Required: False ,
}
string ,
queryParameters:
{
Description: Collection of operation request query parameters. ,
Required: False ,
}
[
{
name:
{
Description: Parameter name. ,
Required: True ,
}
string ,
description:
{
Description: Parameter description. ,
Required: False ,
}
string ,
type:
{
Description: Parameter type. ,
Required: True ,
}
string ,
defaultValue:
{
Description: Default parameter value. ,
Required: False ,
}
string ,
required:
{
Description: whether parameter is required or not. ,
Required: False ,
}
boolean ,
values:
{
Description: Parameter values. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
headers:
{
Description: Collection of operation request headers. ,
Required: False ,
}
[
{
name:
{
Description: Parameter name. ,
Required: True ,
}
string ,
description:
{
Description: Parameter description. ,
Required: False ,
}
string ,
type:
{
Description: Parameter type. ,
Required: True ,
}
string ,
defaultValue:
{
Description: Default parameter value. ,
Required: False ,
}
string ,
required:
{
Description: whether parameter is required or not. ,
Required: False ,
}
boolean ,
values:
{
Description: Parameter values. ,
Required: False ,
}
[
string ,
]
,
}
,
]
,
representations:
{
Description: Collection of operation request representations. ,
Required: False ,
}
[
{
contentType:
{
Description: Specifies a registered or custom content type for this representation, e.g. application/xml. ,
Required: True ,
}
string ,
sample:
{
Description: An example of the representation. ,
Required: False ,
}
string ,
}
,
]
,
}
,
responses:
{
Description: Array of Operation responses. ,
Required: False ,
}
[
{
statusCode:
{
Description: Operation response HTTP status code. ,
Format: int32 ,
Required: True ,
}
integer ,
description:
{
Description: Operation response description. ,
Required: False ,
}
string ,
representations:
{
Description: Collection of operation response representations. ,
Required: False ,
}
[
{
contentType:
{
Description: Specifies a registered or custom content type for this representation, e.g. application/xml. ,
Required: True ,
}
string ,
sample:
{
Description: An example of the representation. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
ApiOperations_Update (removed)
Description :  Updates the details of the operation specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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: Update parameters. ,
Required: True ,
}
{
RawJson:
{
Description: json value. ,
Required: True ,
}
object ,
}
,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
ApiOperations_Delete (removed)
Description :  Deletes the specified operation.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/operations/{operationId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
ApiProducts_ListByApi (removed)
Description :  Lists all API associated products.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/apis/{apiId}/products
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the product within the current API Management service instance. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier. ,
Required: False ,
}
string ,
name:
{
Description: Product name. ,
Required: True ,
}
string ,
description:
{
Description: Product description. May include HTML formatting tags. ,
Required: False ,
}
string ,
terms:
{
Description: Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process. ,
Required: False ,
}
string ,
subscriptionRequired:
{
Description: Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true. ,
Required: False ,
}
boolean ,
approvalRequired:
{
Description: whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true. ,
Required: False ,
}
boolean ,
subscriptionsLimit:
{
Description: Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is NotPublished. ,
Enum:
{
NotPublished: No description available. ,
Published: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
Subscriptions_ListByService (removed)
Description :  Lists all subscriptions of the API Management service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the subscription within the current API Management service instance. The value is a valid relative URL in the format of /subscriptions/{sid} where {sid} is a subscription identifier. ,
Required: False ,
}
string ,
userId:
{
Description: The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{uid} where {uid} is a user identifier. ,
Required: False ,
}
string ,
productId:
{
Description: The product resource identifier of the subscribed product. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the subscription, or null if the subscription has no name. ,
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 ,
createdDate:
{
Description: Subscription creation date. 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 ,
startDate:
{
Description: Subscription activation date. 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 ,
expirationDate:
{
Description: Subscription expiration date. 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 ,
endDate:
{
Description: Date when subscription was cancelled or expired. 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 ,
notificationDate:
{
Description: Upcoming subscription expiration notification date. 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 ,
primaryKey:
{
Description: Subscription primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Subscription secondary key. ,
Required: False ,
}
string ,
stateComment:
{
Description: Optional subscription comment added by an administrator. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
Subscriptions_Get (removed)
Description :  Gets the specified Subscription entity.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
sid:
{
Description: Identifier of the subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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: Uniquely identifies the subscription within the current API Management service instance. The value is a valid relative URL in the format of /subscriptions/{sid} where {sid} is a subscription identifier. ,
Required: False ,
}
string ,
userId:
{
Description: The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{uid} where {uid} is a user identifier. ,
Required: False ,
}
string ,
productId:
{
Description: The product resource identifier of the subscribed product. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the subscription, or null if the subscription has no name. ,
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 ,
createdDate:
{
Description: Subscription creation date. 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 ,
startDate:
{
Description: Subscription activation date. 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 ,
expirationDate:
{
Description: Subscription expiration date. 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 ,
endDate:
{
Description: Date when subscription was cancelled or expired. 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 ,
notificationDate:
{
Description: Upcoming subscription expiration notification date. 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 ,
primaryKey:
{
Description: Subscription primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Subscription secondary key. ,
Required: False ,
}
string ,
stateComment:
{
Description: Optional subscription comment added by an administrator. ,
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 ,
}
,
]
,
}
Subscriptions_CreateOrUpdate (removed)
Description :  Creates or updates the subscription of specified user to the specified product.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
sid:
{
Description: Identifier of the subscription. ,
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: True ,
}
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 ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
Subscriptions_Update (removed)
Description :  Updates the details of a subscription specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
sid:
{
Description: Identifier of the subscription. ,
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: New subscription expiration date. ,
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 ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
Subscriptions_Delete (removed)
Description :  Deletes the specified subscription.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
sid:
{
Description: Identifier of the subscription. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
Subscriptions_RegeneratePrimaryKey (removed)
Description :  Regenerates primary key of existing subscription of the API Management service instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}/regeneratePrimaryKey
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
sid:
{
Description: Identifier of the subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
Subscriptions_RegenerateSecondaryKey (removed)
Description :  Regenerates secondary key of existing subscription of the API Management service instance.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/subscriptions/{sid}/regenerateSecondaryKey
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
sid:
{
Description: Identifier of the subscription. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
Products_ListByService (removed)
Description :  Lists a collection of products in the specified service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
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 | | 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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the product within the current API Management service instance. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier. ,
Required: False ,
}
string ,
name:
{
Description: Product name. ,
Required: True ,
}
string ,
description:
{
Description: Product description. May include HTML formatting tags. ,
Required: False ,
}
string ,
terms:
{
Description: Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process. ,
Required: False ,
}
string ,
subscriptionRequired:
{
Description: Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true. ,
Required: False ,
}
boolean ,
approvalRequired:
{
Description: whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true. ,
Required: False ,
}
boolean ,
subscriptionsLimit:
{
Description: Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is NotPublished. ,
Enum:
{
NotPublished: No description available. ,
Published: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
Products_Get (removed)
Description :  Gets the details of the product specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 profile. ,
}
{
id:
{
Description: Uniquely identifies the product within the current API Management service instance. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier. ,
Required: False ,
}
string ,
name:
{
Description: Product name. ,
Required: True ,
}
string ,
description:
{
Description: Product description. May include HTML formatting tags. ,
Required: False ,
}
string ,
terms:
{
Description: Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process. ,
Required: False ,
}
string ,
subscriptionRequired:
{
Description: Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true. ,
Required: False ,
}
boolean ,
approvalRequired:
{
Description: whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true. ,
Required: False ,
}
boolean ,
subscriptionsLimit:
{
Description: Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is NotPublished. ,
Enum:
{
NotPublished: No description available. ,
Published: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
}

⚐ 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 ,
}
,
]
,
}
Products_CreateOrUpdate (removed)
Description :  Creates or Updates a product.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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: Uniquely identifies the product within the current API Management service instance. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier. ,
Required: False ,
}
string ,
name:
{
Description: Product name. ,
Required: True ,
}
string ,
description:
{
Description: Product description. May include HTML formatting tags. ,
Required: False ,
}
string ,
terms:
{
Description: Product terms of use. Developers trying to subscribe to the product will be presented and required to accept these terms before they can complete the subscription process. ,
Required: False ,
}
string ,
subscriptionRequired:
{
Description: Whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true. ,
Required: False ,
}
boolean ,
approvalRequired:
{
Description: whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true. ,
Required: False ,
}
boolean ,
subscriptionsLimit:
{
Description: Whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. Default state of Product is NotPublished. ,
Enum:
{
NotPublished: No description available. ,
Published: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
Products_Update (removed)
Description :  Update product.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
description:
{
Description: Product description. ,
Required: False ,
}
string ,
terms:
{
Description: Product terms and conditions. Developer will have to accept these terms before he's allowed to call product API. ,
Required: False ,
}
string ,
subscriptionRequired:
{
Description: whether a product subscription is required for accessing APIs included in this product. If true, the product is referred to as "protected" and a valid subscription key is required for a request to an API included in the product to succeed. If false, the product is referred to as "open" and requests to an API included in the product can be made without a subscription key. If property is omitted when creating a new product it's value is assumed to be true. ,
Required: False ,
}
boolean ,
approvalRequired:
{
Description: whether subscription approval is required. If false, new subscriptions will be approved automatically enabling developers to call the product’s APIs immediately after subscribing. If true, administrators must manually approve the subscription before the developer can any of the product’s APIs. Can be present only if subscriptionRequired property is present and has a value of true. ,
Required: False ,
}
boolean ,
subscriptionsLimit:
{
Description: whether the number of subscriptions a user can have to this product at the same time. Set to null or omit to allow unlimited per user subscriptions. Can be present only if subscriptionRequired property is present and has a value of true. ,
Format: int32 ,
Required: False ,
}
integer ,
state:
{
Description: whether product is published or not. Published products are discoverable by users of developer portal. Non published products are visible only to administrators. ,
Enum:
{
NotPublished: No description available. ,
Published: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
Products_Delete (removed)
Description :  Delete product.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
ProductApis_ListByProduct (removed)
Description :  Lists a collection of the APIs associated with a product.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: API identifier path: /apis/{apiId} ,
Required: False ,
}
string ,
name:
{
Description: API name. ,
Required: True ,
}
string ,
description:
{
Description: Description of the API. May include HTML formatting tags. ,
Required: False ,
}
string ,
serviceUrl:
{
Description: Absolute URL of the backend service implementing this API. ,
Required: True ,
}
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: True ,
}
string ,
protocols:
{
Description: Describes on which protocols the operations in this API can be invoked. ,
Required: True ,
}
[
string ,
]
,
authenticationSettings:
{
Description: Collection of authentication settings included into this API. ,
Required: False ,
}
{
oAuth2:
{
Description: API OAuth2 Authentication settings details. ,
Required: False ,
}
{
authorizationServerId:
{
Description: OAuth authorization server identifier. ,
Required: False ,
}
string ,
scope:
{
Description: operations scope. ,
Required: False ,
}
string ,
}
,
}
,
subscriptionKeyParameterNames:
{
Description: Protocols over which API is made available. ,
Required: False ,
}
{
header:
{
Description: Subscription key header name. ,
Required: False ,
}
string ,
query:
{
Description: Subscription key query string parameter name. ,
Required: False ,
}
string ,
}
,
type:
{
Description: Type of API. ,
Enum:
{
Http: No description available. ,
Soap: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
ProductApis_Add (removed)
Description :  Adds an API to the specified product.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
ProductApis_Remove (removed)
Description :  Deletes the specified API from the specified product.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/apis/{apiId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
ProductGroups_ListByProduct (removed)
Description :  Lists the collection of developer groups associated with the specified product.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the group within the current API Management service instance. The value is a valid relative URL in the format of /groups/{groupId} where {groupId} is a group identifier. ,
Required: False ,
}
string ,
name:
{
Description: Group name. ,
Required: True ,
}
string ,
description:
{
Description: Group description. Can contain HTML formatting tags. ,
Required: False ,
}
string ,
builtIn:
{
Description: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. ,
Required: False ,
}
boolean ,
type:
{
Description: Group type. ,
Enum:
{
Custom: No description available. ,
System: No description available. ,
External: No description available. ,
}
,
Required: False ,
}
enum ,
externalId:
{
Description: For external groups, this property contains the id of the group from the external identity provider, e.g. Azure Active Directory; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
ProductGroups_Add (removed)
Description :  Adds the association between the specified developer group with the specified product.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
ProductGroups_Remove (removed)
Description :  Deletes the association between the specified group and product.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/groups/{groupId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (400)

{
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 ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
Groups_ListByService (removed)
Description :  Lists a collection of groups defined within a service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the group within the current API Management service instance. The value is a valid relative URL in the format of /groups/{groupId} where {groupId} is a group identifier. ,
Required: False ,
}
string ,
name:
{
Description: Group name. ,
Required: True ,
}
string ,
description:
{
Description: Group description. Can contain HTML formatting tags. ,
Required: False ,
}
string ,
builtIn:
{
Description: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. ,
Required: False ,
}
boolean ,
type:
{
Description: Group type. ,
Enum:
{
Custom: No description available. ,
System: No description available. ,
External: No description available. ,
}
,
Required: False ,
}
enum ,
externalId:
{
Description: For external groups, this property contains the id of the group from the external identity provider, e.g. Azure Active Directory; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total records count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
Groups_Get (removed)
Description :  Gets the details of the group specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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: Developer group. ,
}
{
id:
{
Description: Uniquely identifies the group within the current API Management service instance. The value is a valid relative URL in the format of /groups/{groupId} where {groupId} is a group identifier. ,
Required: False ,
}
string ,
name:
{
Description: Group name. ,
Required: True ,
}
string ,
description:
{
Description: Group description. Can contain HTML formatting tags. ,
Required: False ,
}
string ,
builtIn:
{
Description: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. ,
Required: False ,
}
boolean ,
type:
{
Description: Group type. ,
Enum:
{
Custom: No description available. ,
System: No description available. ,
External: No description available. ,
}
,
Required: False ,
}
enum ,
externalId:
{
Description: For external groups, this property contains the id of the group from the external identity provider, e.g. Azure Active Directory; otherwise the value is null. ,
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 ,
}
,
]
,
}
Groups_CreateOrUpdate (removed)
Description :  Creates or Updates a group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 for an external group. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
Groups_Update (removed)
Description :  Updates the details of the group specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 for an external group. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (405)

{
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 ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
Groups_Delete (removed)
Description :  Deletes specific group of the API Management service instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (405)

{
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 ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
GroupUsers_ListByGroup (removed)
Description :  Lists a collection of the members of the group, specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: User identifier path. ,
Required: False ,
}
string ,
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
state:
{
Description: User state. ,
Enum:
{
Active: No description available. ,
Blocked: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDate:
{
Description: Date of user registration. 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 ,
note:
{
Description: Administrator's note about given user. ,
Required: False ,
}
string ,
identities:
{
Description: Collection of user identities. ,
Required: False ,
}
[
{
provider:
{
Description: Identity provider name. ,
Required: False ,
}
string ,
id:
{
Description: Identifier value within provider. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
GroupUsers_Add (removed)
Description :  Adds a user to the specified group.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{uid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ Response (204)

{}

⚐ Response (405)

{
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 ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
GroupUsers_Remove (removed)
Description :  Remove existing user from existing group.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/groups/{groupId}/users/{uid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (405)

{
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 ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
Certificates_ListByService (removed)
Description :  Lists a collection of all certificates in the specified service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Certificate identifier path: /certificates/{certificateId} ,
Required: False ,
}
string ,
subject:
{
Description: Subject attribute of the certificate. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Thumbprint of the certificate. ,
Required: True ,
}
string ,
expirationDate:
{
Description: Expiration date of the certificate. 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 ,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
Certificates_Get (removed)
Description :  Gets the details of the certificate specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
certificateId:
{
Description: Identifier of the certificate. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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: Certificate identifier path: /certificates/{certificateId} ,
Required: False ,
}
string ,
subject:
{
Description: Subject attribute of the certificate. ,
Required: True ,
}
string ,
thumbprint:
{
Description: Thumbprint of the certificate. ,
Required: True ,
}
string ,
expirationDate:
{
Description: Expiration date of the certificate. 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 ,
}
,
}

⚐ 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 ,
}
,
]
,
}
Certificates_CreateOrUpdate (removed)
Description :  Creates or updates the certificate being used for authentication with the backend.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
certificateId:
{
Description: Identifier of the certificate entity. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create 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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
Certificates_Delete (removed)
Description :  Deletes specific certificate.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/certificates/{certificateId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
certificateId:
{
Description: Identifier of the certificate. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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_ListByService (removed)
Description :  Lists all policy snippets.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/policySnippets
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
scope:
{
Description: Policy scope. ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
name:
{
Description: Snippet name. ,
Required: False ,
}
string ,
content:
{
Description: Snippet content. ,
Required: False ,
}
string ,
toolTip:
{
Description: Snippet toolTip. ,
Required: False ,
}
string ,
scope:
{
Description: Snippet scope. ,
Enum:
{
Tenant: No description available. ,
Product: No description available. ,
Api: No description available. ,
Operation: No description available. ,
All: No description available. ,
}
,
Required: False ,
}
enum ,
}
ProductSubscriptions_ListByProduct (removed)
Description :  Lists the collection of subscriptions to the specified product.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/products/{productId}/subscriptions
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the subscription within the current API Management service instance. The value is a valid relative URL in the format of /subscriptions/{sid} where {sid} is a subscription identifier. ,
Required: False ,
}
string ,
userId:
{
Description: The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{uid} where {uid} is a user identifier. ,
Required: False ,
}
string ,
productId:
{
Description: The product resource identifier of the subscribed product. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the subscription, or null if the subscription has no name. ,
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 ,
createdDate:
{
Description: Subscription creation date. 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 ,
startDate:
{
Description: Subscription activation date. 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 ,
expirationDate:
{
Description: Subscription expiration date. 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 ,
endDate:
{
Description: Date when subscription was cancelled or expired. 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 ,
notificationDate:
{
Description: Upcoming subscription expiration notification date. 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 ,
primaryKey:
{
Description: Subscription primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Subscription secondary key. ,
Required: False ,
}
string ,
stateComment:
{
Description: Optional subscription comment added by an administrator. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
Users_ListByService (removed)
Description :  Lists a collection of registered users in the specified service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: User identifier path. ,
Required: False ,
}
string ,
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
state:
{
Description: User state. ,
Enum:
{
Active: No description available. ,
Blocked: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDate:
{
Description: Date of user registration. 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 ,
note:
{
Description: Administrator's note about given user. ,
Required: False ,
}
string ,
identities:
{
Description: Collection of user identities. ,
Required: False ,
}
[
{
provider:
{
Description: Identity provider name. ,
Required: False ,
}
string ,
id:
{
Description: Identifier value within provider. ,
Required: False ,
}
string ,
}
,
]
,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
Users_Get (removed)
Description :  Gets the details of the user specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 profile. ,
}
{
id:
{
Description: User identifier path. ,
Required: False ,
}
string ,
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
email:
{
Description: Email address. ,
Required: False ,
}
string ,
state:
{
Description: User state. ,
Enum:
{
Active: No description available. ,
Blocked: No description available. ,
}
,
Required: False ,
}
enum ,
registrationDate:
{
Description: Date of user registration. 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 ,
note:
{
Description: Administrator's note about given user. ,
Required: False ,
}
string ,
identities:
{
Description: Collection of user identities. ,
Required: False ,
}
[
{
provider:
{
Description: Identity provider name. ,
Required: False ,
}
string ,
id:
{
Description: Identifier value within 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 ,
}
,
]
,
}
Users_CreateOrUpdate (removed)
Description :  Creates or Updates a user.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
password:
{
Description: User Password. ,
Required: True ,
}
string ,
firstName:
{
Description: First name. ,
Required: True ,
}
string ,
lastName:
{
Description: Last name. ,
Required: True ,
}
string ,
state:
{
Description: Account state. Specifies whether the user is active or not. Blocked users are unable to sign into the developer portal or call any APIs of subscribed products. Default state is Active. ,
Enum:
{
Active: No description available. ,
Blocked: No description available. ,
}
,
Required: False ,
}
enum ,
note:
{
Description: Optional note about a user set by the administrator. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
Users_Update (removed)
Description :  Updates the details of the user specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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. ,
Required: False ,
}
string ,
password:
{
Description: Password. ,
Required: False ,
}
string ,
firstName:
{
Description: First name. ,
Required: False ,
}
string ,
lastName:
{
Description: Last name. ,
Required: False ,
}
string ,
state:
{
Description: Account state. ,
Enum:
{
Active: No description available. ,
Blocked: No description available. ,
}
,
Required: False ,
}
enum ,
note:
{
Description: Note about user. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (405)

{
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 ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
Users_Delete (removed)
Description :  Deletes specific user.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
}
boolean ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (405)

{
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 ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
Users_GenerateSsoUrl (removed)
Description :  Retrieves a redirection URL containing an authentication token for signing a given user into the developer portal.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}/generateSsoUrl
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
UserGroups_ListByUser (removed)
Description :  Lists all user groups.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}/groups
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the group within the current API Management service instance. The value is a valid relative URL in the format of /groups/{groupId} where {groupId} is a group identifier. ,
Required: False ,
}
string ,
name:
{
Description: Group name. ,
Required: True ,
}
string ,
description:
{
Description: Group description. Can contain HTML formatting tags. ,
Required: False ,
}
string ,
builtIn:
{
Description: true if the group is one of the three system groups (Administrators, Developers, or Guests); otherwise false. ,
Required: False ,
}
boolean ,
type:
{
Description: Group type. ,
Enum:
{
Custom: No description available. ,
System: No description available. ,
External: No description available. ,
}
,
Required: False ,
}
enum ,
externalId:
{
Description: For external groups, this property contains the id of the group from the external identity provider, e.g. Azure Active Directory; otherwise the value is null. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
UserSubscriptions_ListByUser (removed)
Description :  Lists the collection of subscriptions of the specified user.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}/subscriptions
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the subscription within the current API Management service instance. The value is a valid relative URL in the format of /subscriptions/{sid} where {sid} is a subscription identifier. ,
Required: False ,
}
string ,
userId:
{
Description: The user resource identifier of the subscription owner. The value is a valid relative URL in the format of /users/{uid} where {uid} is a user identifier. ,
Required: False ,
}
string ,
productId:
{
Description: The product resource identifier of the subscribed product. The value is a valid relative URL in the format of /products/{productId} where {productId} is a product identifier. ,
Required: False ,
}
string ,
name:
{
Description: The name of the subscription, or null if the subscription has no name. ,
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 ,
createdDate:
{
Description: Subscription creation date. 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 ,
startDate:
{
Description: Subscription activation date. 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 ,
expirationDate:
{
Description: Subscription expiration date. 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 ,
endDate:
{
Description: Date when subscription was cancelled or expired. 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 ,
notificationDate:
{
Description: Upcoming subscription expiration notification date. 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 ,
primaryKey:
{
Description: Subscription primary key. ,
Required: False ,
}
string ,
secondaryKey:
{
Description: Subscription secondary key. ,
Required: False ,
}
string ,
stateComment:
{
Description: Optional subscription comment added by an administrator. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
AuthorizationServers_ListByService (removed)
Description :  Lists a collection of authorization servers defined within a service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
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 | ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the authorization server within the current API Management service instance. The value is a valid relative URL in the format of /authorizationServers/{authsid} where {authsid} is an authorization server identifier. ,
Required: False ,
}
string ,
name:
{
Description: User-friendly authorization server name. ,
Required: True ,
}
string ,
description:
{
Description: Description of the authorization server. Can contain HTML formatting tags. ,
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: True ,
}
string ,
authorizationEndpoint:
{
Description: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. ,
Required: True ,
}
string ,
authorizationMethods:
{
Description: HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional. ,
Required: False ,
}
[
string ,
]
,
clientAuthenticationMethod:
{
Description: Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format. ,
Required: False ,
}
[
string ,
]
,
tokenBodyParameters:
{
Description: Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}. ,
Required: False ,
}
[
{
name:
{
Description: body parameter name. ,
Required: True ,
}
string ,
value:
{
Description: body parameter value. ,
Required: True ,
}
string ,
}
,
]
,
tokenEndpoint:
{
Description: OAuth token endpoint. Contains absolute URI to entity being referenced. ,
Required: False ,
}
string ,
supportState:
{
Description: If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security. ,
Required: False ,
}
boolean ,
defaultScope:
{
Description: Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values. ,
Required: False ,
}
string ,
grantTypes:
{
Description: Form of an authorization grant, which the client uses to request the access token. ,
Required: True ,
}
[
string ,
]
,
bearerTokenSendingMethods:
{
Description: Specifies the mechanism by which access token is passed to the API. ,
Required: False ,
}
[
string ,
]
,
clientId:
{
Description: Client or app id registered with this authorization server. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Client or app secret registered with this authorization server. ,
Required: False ,
}
string ,
resourceOwnerUsername:
{
Description: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. ,
Required: False ,
}
string ,
resourceOwnerPassword:
{
Description: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total records count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
AuthorizationServers_Get (removed)
Description :  Gets the details of the authorization server specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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: Uniquely identifies the authorization server within the current API Management service instance. The value is a valid relative URL in the format of /authorizationServers/{authsid} where {authsid} is an authorization server identifier. ,
Required: False ,
}
string ,
name:
{
Description: User-friendly authorization server name. ,
Required: True ,
}
string ,
description:
{
Description: Description of the authorization server. Can contain HTML formatting tags. ,
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: True ,
}
string ,
authorizationEndpoint:
{
Description: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. ,
Required: True ,
}
string ,
authorizationMethods:
{
Description: HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional. ,
Required: False ,
}
[
string ,
]
,
clientAuthenticationMethod:
{
Description: Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format. ,
Required: False ,
}
[
string ,
]
,
tokenBodyParameters:
{
Description: Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}. ,
Required: False ,
}
[
{
name:
{
Description: body parameter name. ,
Required: True ,
}
string ,
value:
{
Description: body parameter value. ,
Required: True ,
}
string ,
}
,
]
,
tokenEndpoint:
{
Description: OAuth token endpoint. Contains absolute URI to entity being referenced. ,
Required: False ,
}
string ,
supportState:
{
Description: If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security. ,
Required: False ,
}
boolean ,
defaultScope:
{
Description: Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values. ,
Required: False ,
}
string ,
grantTypes:
{
Description: Form of an authorization grant, which the client uses to request the access token. ,
Required: True ,
}
[
string ,
]
,
bearerTokenSendingMethods:
{
Description: Specifies the mechanism by which access token is passed to the API. ,
Required: False ,
}
[
string ,
]
,
clientId:
{
Description: Client or app id registered with this authorization server. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Client or app secret registered with this authorization server. ,
Required: False ,
}
string ,
resourceOwnerUsername:
{
Description: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. ,
Required: False ,
}
string ,
resourceOwnerPassword:
{
Description: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. ,
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 ,
}
,
]
,
}
AuthorizationServers_CreateOrUpdate (removed)
Description :  Creates new authorization server or updates an existing authorization server.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
authsid:
{
Description: Identifier of the authorization server. ,
Required: True ,
}
string ,
parameters:
{
Description: Create or update parameters. ,
Required: True ,
}
{
id:
{
Description: Uniquely identifies the authorization server within the current API Management service instance. The value is a valid relative URL in the format of /authorizationServers/{authsid} where {authsid} is an authorization server identifier. ,
Required: False ,
}
string ,
name:
{
Description: User-friendly authorization server name. ,
Required: True ,
}
string ,
description:
{
Description: Description of the authorization server. Can contain HTML formatting tags. ,
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: True ,
}
string ,
authorizationEndpoint:
{
Description: OAuth authorization endpoint. See http://tools.ietf.org/html/rfc6749#section-3.2. ,
Required: True ,
}
string ,
authorizationMethods:
{
Description: HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional. ,
Required: False ,
}
[
string ,
]
,
clientAuthenticationMethod:
{
Description: Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format. ,
Required: False ,
}
[
string ,
]
,
tokenBodyParameters:
{
Description: Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}. ,
Required: False ,
}
[
{
name:
{
Description: body parameter name. ,
Required: True ,
}
string ,
value:
{
Description: body parameter value. ,
Required: True ,
}
string ,
}
,
]
,
tokenEndpoint:
{
Description: OAuth token endpoint. Contains absolute URI to entity being referenced. ,
Required: False ,
}
string ,
supportState:
{
Description: If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security. ,
Required: False ,
}
boolean ,
defaultScope:
{
Description: Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values. ,
Required: False ,
}
string ,
grantTypes:
{
Description: Form of an authorization grant, which the client uses to request the access token. ,
Required: True ,
}
[
string ,
]
,
bearerTokenSendingMethods:
{
Description: Specifies the mechanism by which access token is passed to the API. ,
Required: False ,
}
[
string ,
]
,
clientId:
{
Description: Client or app id registered with this authorization server. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Client or app secret registered with this authorization server. ,
Required: False ,
}
string ,
resourceOwnerUsername:
{
Description: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. ,
Required: False ,
}
string ,
resourceOwnerPassword:
{
Description: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
AuthorizationServers_Update (removed)
Description :  Updates the details of the authorization server specified by its identifier.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
description:
{
Description: Description of the authorization server. Can contain HTML formatting tags. ,
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 ,
authorizationMethods:
{
Description: HTTP verbs supported by the authorization endpoint. GET must be always present. POST is optional. ,
Required: False ,
}
[
string ,
]
,
clientAuthenticationMethod:
{
Description: Method of authentication supported by the token endpoint of this authorization server. Possible values are Basic and/or Body. When Body is specified, client credentials and other parameters are passed within the request body in the application/x-www-form-urlencoded format. ,
Required: False ,
}
[
string ,
]
,
tokenBodyParameters:
{
Description: Additional parameters required by the token endpoint of this authorization server represented as an array of JSON objects with name and value string properties, i.e. {"name" : "name value", "value": "a value"}. ,
Required: False ,
}
[
{
name:
{
Description: body parameter name. ,
Required: True ,
}
string ,
value:
{
Description: body parameter value. ,
Required: True ,
}
string ,
}
,
]
,
tokenEndpoint:
{
Description: OAuth token endpoint. Contains absolute URI to entity being referenced. ,
Required: False ,
}
string ,
supportState:
{
Description: If true, authorization server will include state parameter from the authorization request to its response. Client may use state parameter to raise protocol security. ,
Required: False ,
}
boolean ,
defaultScope:
{
Description: Access token scope that is going to be requested by default. Can be overridden at the API level. Should be provided in the form of a string containing space-delimited values. ,
Required: False ,
}
string ,
grantTypes:
{
Description: Form of an authorization grant, which the client uses to request the access token. ,
Required: False ,
}
[
string ,
]
,
bearerTokenSendingMethods:
{
Description: Specifies the mechanism by which access token is passed to the API. ,
Required: False ,
}
[
string ,
]
,
clientId:
{
Description: Client or app id registered with this authorization server. ,
Required: False ,
}
string ,
clientSecret:
{
Description: Client or app secret registered with this authorization server. ,
Required: False ,
}
string ,
resourceOwnerUsername:
{
Description: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner username. ,
Required: False ,
}
string ,
resourceOwnerPassword:
{
Description: Can be optionally specified when resource owner password grant type is supported by this authorization server. Default resource owner password. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
AuthorizationServers_Delete (removed)
Description :  Deletes specific authorization server instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/authorizationServers/{authsid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
Regions_ListByService (removed)
Description :  Lists all azure regions in which the service exists.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/regions
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Lists of Regions. ,
Required: False ,
}
[
{
name:
{
Description: Region name. ,
Required: True ,
}
string ,
isMasterRegion:
{
Description: whether Region is the master region. ,
Required: True ,
}
boolean ,
}
,
]
,
}
UserIdentities_ListByUser (removed)
Description :  Lists all user identities.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/users/{uid}/identities
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
provider:
{
Description: Identity provider name. ,
Required: False ,
}
string ,
id:
{
Description: Identifier value within 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 ,
}
,
]
,
}
Reports_ListByService (removed)
Description :  Lists report records.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/reports/{aggregation}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
aggregation:
{
Description: Report aggregation. ,
Required: True ,
}
string ,
$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. This value is only applicable to ByTime aggregation. 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 TimSpan to a valid interval string: XmlConvert.ToString(new TimeSpan(hours, minutes, seconds)) ,
Required: False ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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. ,
Format: int64 ,
Required: False ,
}
integer ,
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. ,
Format: int32 ,
Required: False ,
}
integer ,
callCountBlocked:
{
Description: Number of calls blocked due to invalid credentials. ,
Format: int32 ,
Required: False ,
}
integer ,
callCountFailed:
{
Description: Number of calls failed due to proxy or backend errors. ,
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 records count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
TenantAccess_Get (removed)
Description :  Get tenant access information details.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/access
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 (removed)
Description :  Update tenant access information details.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/access
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters. ,
Required: True ,
}
{
enabled:
{
Description: Tenant access information of the API Management service. ,
Required: True ,
}
boolean ,
}
,
If-Match:
{
Description: The entity state (Etag) version of the tenant access settings 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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 (removed)
Description :  Regenerate primary access key.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/access/regeneratePrimaryKey
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 (removed)
Description :  Regenerate secondary access key.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/access/regenerateSecondaryKey
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
Loggers_ListByService (removed)
Description :  Lists a collection of loggers in the specified service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Logger values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the logger within the current API Management service instance. The value is a valid relative URL in the format of /loggers/{loggerId} where {loggerId} is a logger identifier. ,
Required: False ,
}
string ,
type:
{
Description: Logger type. ,
Enum:
{
AzureEventHub: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Logger description. ,
Required: False ,
}
string ,
credentials:
{
Description: The name and SendRule connection string of the event hub. ,
Required: True ,
}
object ,
isBuffered:
{
Description: Whether records are buffered in the logger before publishing. Default is assumed to be true. ,
Required: False ,
}
boolean ,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
Loggers_Get (removed)
Description :  Gets the details of the logger specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
loggerid:
{
Description: Identifier of the logger. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 Logger entity in API Management represents an event sink that you can use to log API Management events. Currently the Logger entity supports logging API Management events to Azure Event Hubs. ,
}
{
id:
{
Description: Uniquely identifies the logger within the current API Management service instance. The value is a valid relative URL in the format of /loggers/{loggerId} where {loggerId} is a logger identifier. ,
Required: False ,
}
string ,
type:
{
Description: Logger type. ,
Enum:
{
AzureEventHub: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Logger description. ,
Required: False ,
}
string ,
credentials:
{
Description: The name and SendRule connection string of the event hub. ,
Required: True ,
}
object ,
isBuffered:
{
Description: Whether records are buffered in the logger before publishing. Default is assumed to be true. ,
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 ,
}
,
]
,
}
Loggers_CreateOrUpdate (removed)
Description :  Creates or Updates a logger.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
loggerid:
{
Description: Identifier of the logger. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
type:
{
Description: Logger type. ,
Enum:
{
AzureEventHub: No description available. ,
}
,
Required: True ,
}
enum ,
description:
{
Description: Logger description. ,
Required: False ,
}
string ,
credentials:
{
Description: The name and SendRule connection string of the event hub. ,
Required: True ,
}
object ,
isBuffered:
{
Description: Whether records are buffered in the logger before publishing. Default is assumed to be true. ,
Required: False ,
}
boolean ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
Loggers_Update (removed)
Description :  Updates an existing logger.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
loggerid:
{
Description: Identifier of the logger. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
type:
{
Description: Logger type. ,
Enum:
{
AzureEventHub: No description available. ,
}
,
Required: True ,
}
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
Loggers_Delete (removed)
Description :  Deletes the specified logger.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/loggers/{loggerid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
loggerid:
{
Description: Identifier of the logger. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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_ListByService (removed)
Description :  Lists a collection of properties defined within a service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/properties
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the property within the current API Management service instance. The value is a valid relative URL in the format of /properties/{propId} where {propId} is a property identifier. ,
Required: False ,
}
string ,
name:
{
Description: Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters. ,
Required: True ,
}
string ,
value:
{
Description: Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace. ,
Required: True ,
}
string ,
tags:
{
Description: Optional tags that when provided can be used to filter the property list. ,
Required: False ,
}
[
string ,
]
,
secret:
{
Description: Determines whether the value is a secret and should be encrypted or not. Default value is false. ,
Required: False ,
}
boolean ,
}
,
]
,
count:
{
Description: Total records count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
Property_Get (removed)
Description :  Gets the details of the property specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/properties/{propId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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: Uniquely identifies the property within the current API Management service instance. The value is a valid relative URL in the format of /properties/{propId} where {propId} is a property identifier. ,
Required: False ,
}
string ,
name:
{
Description: Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters. ,
Required: True ,
}
string ,
value:
{
Description: Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace. ,
Required: True ,
}
string ,
tags:
{
Description: Optional tags that when provided can be used to filter the property list. ,
Required: False ,
}
[
string ,
]
,
secret:
{
Description: Determines whether the value is a secret and should be encrypted or not. Default value is false. ,
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 ,
}
,
]
,
}
Property_CreateOrUpdate (removed)
Description :  Creates or updates a property.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/properties/{propId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
propId:
{
Description: Identifier of the property. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
name:
{
Description: Unique name of Property. It may contain only letters, digits, period, dash, and underscore characters. ,
Required: True ,
}
string ,
value:
{
Description: Value of the property. Can contain policy expressions. It may not be empty or consist only of whitespace. ,
Required: True ,
}
string ,
tags:
{
Description: Optional tags that when provided can be used to filter the property list. ,
Required: False ,
}
[
string ,
]
,
secret:
{
Description: Determines whether the value is a secret and should be encrypted or not. Default value is false. ,
Required: False ,
}
boolean ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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_Update (removed)
Description :  Updates the specific property.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/properties/{propId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
tags:
{
Description: Optional tags that when provided can be used to filter the property list. ,
Required: False ,
}
[
string ,
]
,
secret:
{
Description: Determines whether the value is a secret and should be encrypted or not. Default value is false. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 (removed)
Description :  Deletes specific property from the API Management service instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/properties/{propId}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (405)

{
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 ,
}
,
]
,
}

⚐ 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 ,
}
,
]
,
}
OpenIdConnectProviders_ListByService (removed)
Description :  Lists all OpenID Connect Providers.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
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 | ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Page values. ,
Required: False ,
}
[
{
id:
{
Description: OpenID Connect Provider identifier. ,
Required: False ,
}
string ,
name:
{
Description: User-friendly OpenID Connect Provider name. ,
Required: True ,
}
string ,
description:
{
Description: User-friendly description of OpenID Connect Provider. ,
Required: False ,
}
string ,
metadataEndpoint:
{
Description: Metadata endpoint URI. ,
Required: True ,
}
string ,
clientId:
{
Description: Client ID of developer console which is the client application. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Client Secret of developer console which is the client application. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total records count number. ,
Format: int64 ,
Required: False ,
}
integer ,
nextLink:
{
Description: Next page link if any. ,
Required: False ,
}
string ,
}
OpenIdConnectProviders_Get (removed)
Description :  Gets specific OpenID Connect Provider.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 Providers Contract. ,
}
{
id:
{
Description: OpenID Connect Provider identifier. ,
Required: False ,
}
string ,
name:
{
Description: User-friendly OpenID Connect Provider name. ,
Required: True ,
}
string ,
description:
{
Description: User-friendly description of OpenID Connect Provider. ,
Required: False ,
}
string ,
metadataEndpoint:
{
Description: Metadata endpoint URI. ,
Required: True ,
}
string ,
clientId:
{
Description: Client ID of developer console which is the client application. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Client Secret of developer console which is the client application. ,
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 ,
}
,
]
,
}
OpenIdConnectProviders_CreateOrUpdate (removed)
Description :  Creates or updates the OpenID Connect Provider.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
opid:
{
Description: Identifier of the OpenID Connect Provider. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
name:
{
Description: User-friendly OpenID Connect Provider name. ,
Required: True ,
}
string ,
description:
{
Description: User-friendly description of OpenID Connect Provider. ,
Required: False ,
}
string ,
metadataEndpoint:
{
Description: Metadata endpoint URI. ,
Required: True ,
}
string ,
clientId:
{
Description: Client ID of developer console which is the client application. ,
Required: True ,
}
string ,
clientSecret:
{
Description: Client Secret of developer console which is the client application. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
OpenIdConnectProviders_Update (removed)
Description :  Updates the specific OpenID Connect Provider.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
OpenIdConnectProviders_Delete (removed)
Description :  Deletes specific OpenID Connect Provider of the API Management service instance.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/openidConnectProviders/{opid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (204)

{}

⚐ Response (405)

{
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 ,
}
,
]
,
}

⚐ 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 (removed)
Description :  Gets the Git access configuration for the tenant.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/access/git
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 (removed)
Description :  Regenerate primary access key for GIT.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/access/git/regeneratePrimaryKey
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 (removed)
Description :  Regenerate secondary access key for GIT.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/access/git/regenerateSecondaryKey
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 (removed)
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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/deploy
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}

⚐ 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 (removed)
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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/save
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}

⚐ 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 (removed)
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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/validate
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ 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 ,
}
,
]
,
}
,
}

⚐ 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 ,
}
,
]
,
}
TenantConfigurationSyncState_Get (removed)
Description :  Gets the status of the most recent synchronization between the configuration database and the Git repository.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/tenant/configuration/syncState
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
Backends_ListByService (removed)
Description :  Lists a collection of backends in the specified service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
$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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Backend values. ,
Required: False ,
}
[
{
id:
{
Description: Uniquely identifies the backend within the current API Management service instance. The value is a valid relative URL in the format of /backends/{backendId} where {backendId} is a backend identifier. ,
Required: False ,
}
string ,
}
,
]
,
count:
{
Description: Total records count number. ,
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 ,
}
,
]
,
}
Backends_Get (removed)
Description :  Gets the details of the backend specified by its identifier.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
backendid:
{
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 Backend entity in API Management represents a backend service that is configured to skip certification chain validation when using a self-signed certificate to test mutual certificate authentication. ,
}
{
id:
{
Description: Uniquely identifies the backend within the current API Management service instance. The value is a valid relative URL in the format of /backends/{backendId} where {backendId} is a backend identifier. ,
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 ,
}
,
]
,
}
Backends_CreateOrUpdate (removed)
Description :  Creates or Updates a backend.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
backendid:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Create parameters. ,
Required: True ,
}
{
host:
{
Description: Host attribute of the backend. Host is a pure hostname without a port or suffix, for example backend.contoso.com. Must not be empty. ,
Required: True ,
}
string ,
skipCertificateChainValidation:
{
Description: Flag indicating whether SSL certificate chain validation should be skipped when using self-signed certificates for this backend host. ,
Required: False ,
}
boolean ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
Backends_Update (removed)
Description :  Updates an existing backend.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
backendid:
{
Description: User identifier. Must be unique in the current API Management service instance. ,
Required: True ,
}
string ,
parameters:
{
Description: Update parameters. ,
Required: True ,
}
{
host:
{
Description: Host attribute of the backend. Host is a pure hostname without a port or suffix, for example backend.contoso.com. Must not be empty. ,
Required: False ,
}
string ,
skipCertificateChainValidation:
{
Description: Flag indicating whether SSL certificate chain validation should be skipped when using self-signed certificates for this backend host. ,
Required: False ,
}
boolean ,
}
,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
Backends_Delete (removed)
Description :  Deletes the specified backend.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backends/{backendid}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
backendid:
{
Description: User identifier. 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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
IdentityProviders_ListByService (removed)
Description :  Lists a collection of Identity Provider configured in the specified service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
}
[
{
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: True ,
}
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: True ,
}
string ,
type:
{
Description: Identity Provider Type identifier. ,
Enum:
{
facebook: No description available. ,
google: No description available. ,
microsoft: No description available. ,
twitter: No description available. ,
aad: No description available. ,
}
,
Required: False ,
}
enum ,
allowedTenants:
{
Description: List of Allowed Tenants when configuring Azure Active Directory login. ,
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 ,
}
,
]
,
}
IdentityProviders_Get (removed)
Description :  Gets the configuration details of the identity Provider configured in specified service instance.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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: The external Identity Providers like Facebook, Google, Microsoft, Twitter or Azure Active Directory which can be used to enable access to the API Management service developer portal for all users. ,
}
{
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: True ,
}
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: True ,
}
string ,
type:
{
Description: Identity Provider Type identifier. ,
Enum:
{
facebook: No description available. ,
google: No description available. ,
microsoft: No description available. ,
twitter: No description available. ,
aad: No description available. ,
}
,
Required: False ,
}
enum ,
allowedTenants:
{
Description: List of Allowed Tenants when configuring Azure Active Directory login. ,
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 ,
}
,
]
,
}
IdentityProviders_CreateOrUpdate (removed)
Description :  Creates or Updates the IdentityProvider configuration.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
identityProviderName:
{
Description: Identity Provider Type identifier. ,
Required: True ,
}
string ,
parameters:
{
Description: Create 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: True ,
}
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: True ,
}
string ,
type:
{
Description: Identity Provider Type identifier. ,
Enum:
{
facebook: No description available. ,
google: No description available. ,
microsoft: No description available. ,
twitter: No description available. ,
aad: No description available. ,
}
,
Required: False ,
}
enum ,
allowedTenants:
{
Description: List of Allowed Tenants when configuring Azure Active Directory login. ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (201)

{}

⚐ 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 ,
}
,
]
,
}
IdentityProviders_Update (removed)
Description :  Updates an existing IdentityProvider configuration.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
allowedTenants:
{
Description: List of Allowed Tenants when configuring Azure Active Directory login. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
IdentityProviders_Delete (removed)
Description :  Deletes the specified identity provider configuration.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/identityProviders/{identityProviderName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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_ListByService (removed)
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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
quotaCounterKey:
{
Description: Quota counter key identifier. ,
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 ,
}
,
]
,
count:
{
Description: Total records count number. ,
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 (removed)
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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
quotaCounterKey:
{
Description: Quota counter key identifier. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 (removed)
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:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}/{quotaPeriodKey}
{
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
quotaCounterKey:
{
Description: Quota counter key identifier. ,
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 ,
}

⚐ 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 (removed)
Description :  Updates an existing quota counter value in the specified service instance.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/quotas/{quotaCounterKey}/{quotaPeriodKey}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
quotaCounterKey:
{
Description: Quota counter key identifier. ,
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 ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
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 ,
}
,
]
,
}
ApiManagementServices_ManageDeployments (removed)
Description :  Manages deployments of an API Management service. This operation can be used to do the following: Change SKU, Change SKU Units, Change Service Tier (Developer/Standard/Premium) and Manage VPN Configuration. This is a long running operation and can take several minutes to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/managedeployments
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the ManageDeployments operation. ,
Required: True ,
}
{
location:
{
Description: Location of the API Management service Azure data center. ,
Required: True ,
}
string ,
skuType:
{
Description: SKU type of the API Management service. ,
Enum:
{
Developer: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
skuUnitCount:
{
Description: SKU Unit count of the API Management service. Default value is 1. ,
Format: int32 ,
Required: False ,
}
integer ,
additionalLocations:
{
Description: Additional data center locations for the API Management service. ,
Required: False ,
}
[
{
location:
{
Description: The location name of the additional region among Azure Data center regions. ,
Required: True ,
}
string ,
skuType:
{
Description: The SKU type in the location. ,
Enum:
{
Developer: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
skuUnitCount:
{
Description: The SKU Unit count at the location. The maximum SKU Unit count depends on the SkuType. Maximum allowed for Developer SKU is 1, for Standard SKU is 4, and for Premium SKU is 10, at a location. ,
Format: int32 ,
Required: False ,
}
integer ,
staticIPs:
{
Description: Static IP addresses of the location's virtual machines. ,
Required: False ,
}
[
string ,
]
,
vpnconfiguration:
{
Description: Virtual network configuration for the location. ,
Required: False ,
}
{
vnetid:
{
Description: The virtual network ID. This is typically a GUID. Expect a null GUID by default. ,
Required: False ,
}
string ,
subnetname:
{
Description: The name of the subnet. ,
Required: False ,
}
string ,
subnetResourceId:
{
Description: The name of the subnet Resource ID. This has format /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/{virtual network name}/subnets/{subnet name}. ,
Required: False ,
}
string ,
location:
{
Description: The location of the virtual network. ,
Required: False ,
}
string ,
}
,
}
,
]
,
vpnConfiguration:
{
Description: Virtual network configuration. ,
Required: False ,
}
{
vnetid:
{
Description: The virtual network ID. This is typically a GUID. Expect a null GUID by default. ,
Required: False ,
}
string ,
subnetname:
{
Description: The name of the subnet. ,
Required: False ,
}
string ,
subnetResourceId:
{
Description: The name of the subnet Resource ID. This has format /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/{virtual network name}/subnets/{subnet name}. ,
Required: False ,
}
string ,
location:
{
Description: The location of the virtual network. ,
Required: False ,
}
string ,
}
,
vpnType:
{
Description: The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that the API Management service deployment is set up inside a Virtual Network having an Intranet Facing Endpoint only. When vpnConfiguration is specified, vpnType must be specified. ,
Enum:
{
None: No description available. ,
External: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the created API Management service. ,
Required: False ,
}
string ,
location:
{
Description: Datacenter location of the API Management service. ,
Required: True ,
}
string ,
name:
{
Description: Name of the API Management service. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the API Management service. ,
Required: False ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApiManagementServices_Restore (removed)
Description :  Restores a backup of an API Management service created using the ApiManagementServices_Backup operation on the current service. This is a long running operation and could take several minutes to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/restore
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Restore API Management service from backup operation. ,
Required: True ,
}
{
storageAccount:
{
Description: Azure Cloud Storage account (used to place/retrieve the backup) name. ,
Required: True ,
}
string ,
accessKey:
{
Description: Azure Cloud Storage account (used to place/retrieve the backup) access key. ,
Required: True ,
}
string ,
containerName:
{
Description: Azure Cloud Storage blob container name used to place/retrieve the backup. ,
Required: True ,
}
string ,
backupName:
{
Description: The name of the backup file to create. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the created API Management service. ,
Required: False ,
}
string ,
location:
{
Description: Datacenter location of the API Management service. ,
Required: True ,
}
string ,
name:
{
Description: Name of the API Management service. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the API Management service. ,
Required: False ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApiManagementServices_Backup (removed)
Description :  Creates a backup of the API Management service to the given Azure Storage Account. This is long running operation and could take several minutes to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/backup
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the ApiManagementServices_Backup operation. ,
Required: True ,
}
{
storageAccount:
{
Description: Azure Cloud Storage account (used to place/retrieve the backup) name. ,
Required: True ,
}
string ,
accessKey:
{
Description: Azure Cloud Storage account (used to place/retrieve the backup) access key. ,
Required: True ,
}
string ,
containerName:
{
Description: Azure Cloud Storage blob container name used to place/retrieve the backup. ,
Required: True ,
}
string ,
backupName:
{
Description: The name of the backup file to create. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the created API Management service. ,
Required: False ,
}
string ,
location:
{
Description: Datacenter location of the API Management service. ,
Required: True ,
}
string ,
name:
{
Description: Name of the API Management service. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the API Management service. ,
Required: False ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApiManagementServices_CreateOrUpdate (removed)
Description :  Creates or updates an API Management service. This is long running operation and could take several minutes to complete.
Reference :  Link ¶

⚼ Request

PUT:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate API Management service operation. ,
Required: True ,
}
{
id:
{
Description: The ID of the created API Management service. ,
Required: False ,
}
string ,
location:
{
Description: Datacenter location of the API Management service. ,
Required: True ,
}
string ,
name:
{
Description: Name of the API Management service. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the API Management service. ,
Required: False ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the created API Management service. ,
Required: False ,
}
string ,
location:
{
Description: Datacenter location of the API Management service. ,
Required: True ,
}
string ,
name:
{
Description: Name of the API Management service. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the API Management service. ,
Required: False ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (201)

{
id:
{
Description: The ID of the created API Management service. ,
Required: False ,
}
string ,
location:
{
Description: Datacenter location of the API Management service. ,
Required: True ,
}
string ,
name:
{
Description: Name of the API Management service. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the API Management service. ,
Required: False ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApiManagementServices_Update (removed)
Description :  Updates an existing API Management service.
Reference :  Link ¶

⚼ Request

PATCH:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the CreateOrUpdate API Management service operation. ,
Required: True ,
}
{
tags:
{
Description: API Management service tags. A maximum of 10 tags can be provided for a resource, and each tag must have a key no greater than 128 characters (and a value no greater than 256 characters). ,
Required: False ,
}
object ,
properties:
{
Description: Properties of the API Management service. ,
Required: False ,
}
{
publisherEmail:
{
Description: Publisher email. ,
Required: True ,
}
string ,
publisherName:
{
Description: Publisher name. ,
Required: True ,
}
string ,
provisioningState:
{
Description: The current provisioning state of the API Management service which can be one of the following: Created/Activating/Succeeded/Updating/Failed/Stopped/Terminating/TerminationFailed/Deleted. ,
Required: False ,
}
string ,
targetProvisioningState:
{
Description: The provisioning state of the API Management service, which is targeted by the long running operation started on the service. ,
Required: False ,
}
string ,
createdAtUtc:
{
Description: Creation UTC date of the API Management service.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 ,
runtimeUrl:
{
Description: Proxy endpoint URL of the API Management service. ,
Required: False ,
}
string ,
portalUrl:
{
Description: Publisher portal endpoint Url of the API Management service. ,
Required: False ,
}
string ,
managementApiUrl:
{
Description: Management API endpoint URL of the API Management service. ,
Required: False ,
}
string ,
scmUrl:
{
Description: SCM endpoint URL of the API Management service. ,
Required: False ,
}
string ,
addresserEmail:
{
Description: Addresser email. ,
Required: False ,
}
string ,
hostnameConfigurations:
{
Description: Custom hostname configuration of the API Management service. ,
Required: False ,
}
[
{
type:
{
Description: Hostname type. ,
Enum:
{
Proxy: No description available. ,
Portal: No description available. ,
Management: No description available. ,
Scm: No description available. ,
}
,
Required: True ,
}
enum ,
hostname:
{
Description: Hostname. ,
Required: True ,
}
string ,
certificate:
{
Description: Certificate information. ,
Required: True ,
}
{
expiry:
{
Description: Expiration date of the certificate. 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 ,
thumbprint:
{
Description: Thumbprint of the certificate. ,
Required: True ,
}
string ,
subject:
{
Description: Subject of the certificate. ,
Required: True ,
}
string ,
}
,
}
,
]
,
staticIPs:
{
Description: Static IP addresses of the API Management service virtual machines. Available only for Standard and Premium SKU. ,
Required: False ,
}
[
string ,
]
,
vpnconfiguration:
{
Description: Virtual network configuration of the API Management service. ,
Required: False ,
}
{
vnetid:
{
Description: The virtual network ID. This is typically a GUID. Expect a null GUID by default. ,
Required: False ,
}
string ,
subnetname:
{
Description: The name of the subnet. ,
Required: False ,
}
string ,
subnetResourceId:
{
Description: The name of the subnet Resource ID. This has format /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/{virtual network name}/subnets/{subnet name}. ,
Required: False ,
}
string ,
location:
{
Description: The location of the virtual network. ,
Required: False ,
}
string ,
}
,
additionalLocations:
{
Description: Additional datacenter locations of the API Management service. ,
Required: False ,
}
[
{
location:
{
Description: The location name of the additional region among Azure Data center regions. ,
Required: True ,
}
string ,
skuType:
{
Description: The SKU type in the location. ,
Enum:
{
Developer: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
skuUnitCount:
{
Description: The SKU Unit count at the location. The maximum SKU Unit count depends on the SkuType. Maximum allowed for Developer SKU is 1, for Standard SKU is 4, and for Premium SKU is 10, at a location. ,
Format: int32 ,
Required: False ,
}
integer ,
staticIPs:
{
Description: Static IP addresses of the location's virtual machines. ,
Required: False ,
}
[
string ,
]
,
vpnconfiguration:
{
Description: Virtual network configuration for the location. ,
Required: False ,
}
{
vnetid:
{
Description: The virtual network ID. This is typically a GUID. Expect a null GUID by default. ,
Required: False ,
}
string ,
subnetname:
{
Description: The name of the subnet. ,
Required: False ,
}
string ,
subnetResourceId:
{
Description: The name of the subnet Resource ID. This has format /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/Microsoft.{Network|ClassicNetwork}/VirtualNetworks/{virtual network name}/subnets/{subnet name}. ,
Required: False ,
}
string ,
location:
{
Description: The location of the virtual network. ,
Required: False ,
}
string ,
}
,
}
,
]
,
customProperties:
{
Description: Custom properties of the API Management service, like disabling TLS 1.0. ,
Required: False ,
}
object ,
vpnType:
{
Description: The type of VPN in which API Management service needs to be configured in. None (Default Value) means the API Management service is not part of any Virtual Network, External means the API Management deployment is set up inside a Virtual Network having an Internet Facing Endpoint, and Internal means that API Management deployment is setup inside a Virtual Network having an Intranet Facing Endpoint only. ,
Enum:
{
None: No description available. ,
External: No description available. ,
Internal: No description available. ,
}
,
Required: False ,
}
enum ,
}
,
sku:
{
Description: SKU properties of the API Management service. ,
Required: False ,
}
{
name:
{
Description: Name of the Sku. ,
Enum:
{
Developer: No description available. ,
Standard: No description available. ,
Premium: No description available. ,
}
,
Required: True ,
}
enum ,
capacity:
{
Description: Capacity of the SKU (number of deployed units of the SKU). The default value is 1. ,
Format: int32 ,
Required: False ,
}
integer ,
}
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the created API Management service. ,
Required: False ,
}
string ,
location:
{
Description: Datacenter location of the API Management service. ,
Required: True ,
}
string ,
name:
{
Description: Name of the API Management service. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the API Management service. ,
Required: False ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (202)

{}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApiManagementServices_Get (removed)
Description :  Gets an API Management service resource description.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the created API Management service. ,
Required: False ,
}
string ,
location:
{
Description: Datacenter location of the API Management service. ,
Required: True ,
}
string ,
name:
{
Description: Name of the API Management service. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the API Management service. ,
Required: False ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (404)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApiManagementServices_Delete (removed)
Description :  Deletes an existing API Management service.
Reference :  Link ¶

⚼ Request

DELETE:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{}

⚐ Response (204)

{}

⚐ Response (404)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApiManagementServices_ListByResourceGroup (removed)
Description :  List all API Management services within a resource group.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List API Management services operation. ,
Required: True ,
}
[
{
id:
{
Description: The ID of the created API Management service. ,
Required: False ,
}
string ,
location:
{
Description: Datacenter location of the API Management service. ,
Required: True ,
}
string ,
name:
{
Description: Name of the API Management service. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the API Management service. ,
Required: False ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of API Management services. ,
Required: False ,
}
string ,
}
ApiManagementServices_List (removed)
Description :  Lists all API Management services within an Azure subscription.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/service/
{
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
value:
{
Description: Result of the List API Management services operation. ,
Required: True ,
}
[
{
id:
{
Description: The ID of the created API Management service. ,
Required: False ,
}
string ,
location:
{
Description: Datacenter location of the API Management service. ,
Required: True ,
}
string ,
name:
{
Description: Name of the API Management service. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the API Management service. ,
Required: False ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}
,
]
,
nextLink:
{
Description: Link to the next set of results. Not empty if Value contains incomplete list of API Management services. ,
Required: False ,
}
string ,
}
ApiManagementServices_GetSsoToken (removed)
Description :  Gets the Single-Sign-On token for the API Management Service which is valid for 5 Minutes.
Reference :  Link ¶

⚼ Request

GET:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/getssotoken
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
redirect_uri:
{
Description: Redirect URL containing the SSO token. ,
Required: False ,
}
string ,
}
ApiManagementServices_CheckNameAvailability (removed)
Description :  Checks availability and correctness of a name for an API Management service.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/providers/Microsoft.ApiManagement/checkNameAvailability
{
parameters:
{
Description: Parameters supplied to the CheckNameAvailability operation. ,
Required: True ,
}
{
name:
{
Description: The name to check for availability. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
nameAvailable:
{
Description: True if the name is available and can be used to create a new API Management service; otherwise false. ,
Required: True ,
}
boolean ,
message:
{
Description: If reason == invalid, provide the user with the reason why the given name is invalid, and provide the resource naming requirements so that the user can select a valid name. If reason == AlreadyExists, explain that is already in use, and direct them to select a different name. ,
Required: False ,
}
string ,
reason:
{
Description: Invalid indicates the name provided does not match the resource provider’s naming requirements (incorrect length, unsupported characters, etc.) AlreadyExists indicates that the name is already in use and is therefore unavailable. ,
Enum:
{
Valid: No description available. ,
Invalid: No description available. ,
AlreadyExists: No description available. ,
}
,
Required: False ,
}
enum ,
}
ApiManagementServices_UploadCertificate (removed)
Description :  Upload Custom Domain SSL certificate for an API Management service.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/updatecertificate
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the Upload SSL certificate for an API Management service operation. ,
Required: True ,
}
{
type:
{
Description: Hostname type. ,
Enum:
{
Proxy: No description available. ,
Portal: No description available. ,
Management: No description available. ,
Scm: No description available. ,
}
,
Required: True ,
}
enum ,
certificate:
{
Description: Base64 Encoded certificate. ,
Required: True ,
}
string ,
certificate_password:
{
Description: Certificate password. ,
Required: True ,
}
string ,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
expiry:
{
Description: Expiration date of the certificate. 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 ,
thumbprint:
{
Description: Thumbprint of the certificate. ,
Required: True ,
}
string ,
subject:
{
Description: Subject of the certificate. ,
Required: True ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}
ApiManagementServices_UpdateHostname (removed)
Description :  Creates, updates, or deletes the custom hostnames for an API Management service. The custom hostname can be applied to the Proxy and Portal endpoint. This is a long running operation and could take several minutes to complete.
Reference :  Link ¶

⚼ Request

POST:  /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ApiManagement/service/{serviceName}/updatehostname
{
resourceGroupName:
{
Description: The name of the resource group. ,
Required: True ,
}
string ,
serviceName:
{
Description: The name of the API Management service. ,
Required: True ,
}
string ,
parameters:
{
Description: Parameters supplied to the UpdateHostname operation. ,
Required: True ,
}
{
update:
{
Description: Hostnames to create or update. ,
Required: False ,
}
[
{
type:
{
Description: Hostname type. ,
Enum:
{
Proxy: No description available. ,
Portal: No description available. ,
Management: No description available. ,
Scm: No description available. ,
}
,
Required: True ,
}
enum ,
hostname:
{
Description: Hostname. ,
Required: True ,
}
string ,
certificate:
{
Description: Certificate information. ,
Required: True ,
}
{
expiry:
{
Description: Expiration date of the certificate. 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 ,
thumbprint:
{
Description: Thumbprint of the certificate. ,
Required: True ,
}
string ,
subject:
{
Description: Subject of the certificate. ,
Required: True ,
}
string ,
}
,
}
,
]
,
delete:
{
Description: Hostnames types to delete. ,
Required: False ,
}
[
string ,
]
,
}
,
api-version:
{
Description: Version of the API to be used with the client request. ,
Required: True ,
}
string ,
subscriptionId:
{
Description: Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call. ,
Required: True ,
}
string ,
}

⚐ Response (200)

{
id:
{
Description: The ID of the created API Management service. ,
Required: False ,
}
string ,
location:
{
Description: Datacenter location of the API Management service. ,
Required: True ,
}
string ,
name:
{
Description: Name of the API Management service. ,
Required: False ,
}
string ,
type:
{
Description: Resource type of the API Management service. ,
Required: False ,
}
string ,
etag:
{
Description: ETag of the resource. ,
Required: False ,
}
string ,
}

⚐ Response (default)

{
code:
{
Description: Error code. ,
Required: False ,
}
string ,
message:
{
Description: Error message indicating why the operation failed. ,
Required: False ,
}
string ,
}